example-service

Simple arithmetic service compatible with SingularityNET

Getting Started

Prerequisites

Python 3.6.5

Installing

Clone the git repository:

git clone git@github.com:singnet/example-service.git
cd example-service

Install the dependencies and compile the protobuf file:

pip3 install -r requirements.txt
sh buildproto.sh

Running

Standalone

Run the example service directly (without SNET Daemon):

python3 run_example_service.py --no-daemon

To test it run the script:

python3 test_example_service.py

With SingularityNET Daemon

SingularityNET Daemon Configuration

To get the ORGANIZATION_ID and SERVICE_ID you must have already published a service (check this link).

Create the SNET Daemon's config JSON file (snetd.config.json).

{
   "DAEMON_END_POINT": "DAEMON_HOST:DAEMON_PORT",
   "ETHEREUM_JSON_RPC_ENDPOINT": "https://JSON_RPC_ENDPOINT",
   "IPFS_END_POINT": "http://ipfs.singularitynet.io:80",
   "REGISTRY_ADDRESS_KEY": "REGISTRY_ADDRESS",
   "PASSTHROUGH_ENABLED": true,
   "PASSTHROUGH_ENDPOINT": "http://SERVICE_GRPC_HOST:SERVICE_GRPC_PORT",
   "ORGANIZATION_ID": "ORGANIZATION_ID",
   "SERVICE_ID": "SERVICE_ID",
   "PAYMENT_CHANNEL_STORAGE_SERVER": {
       "DATA_DIR": "/opt/singnet/etcd/"
   },
   "LOG": {
       "LEVEL": "debug",
       "OUTPUT": {
            "TYPE": "stdout"
           }
   }
}

For example, using the Ropsten testnet, replace tags with:

DAEMON_HOST:DAEMON_PORT: localhost:7000
https://JSON_RPC_ENDPOINT: https://ropsten.infura.io
REGISTRY_ADDRESS: 0x5156fde2ca71da4398f8c76763c41bc9633875e4
http://SERVICE_GRPC_HOST:SERVICE_GRPC_PORT: http://localhost:7003
ORGANIZATION_ID: example-organization
SERVICE_ID: example-service

For example, using the Kovan testnet, replace tags with:

DAEMON_HOST:DAEMON_PORT: localhost:7000
https://JSON_RPC_ENDPOINT: https://kovan.infura.io
REGISTRY_ADDRESS: 0xe331bf20044a5b24c1a744abc90c1fd711d2c08d
http://SERVICE_GRPC_HOST:SERVICE_GRPC_PORT: http://localhost:7003
ORGANIZATION_ID: example-organization
SERVICE_ID: example-service

See SingularityNet daemon configuration for detailed configuration description.

Running Service + Daemon on Host

Run the script without flag to launch both SNET Daemon and the service. But first, download the latest SNET Daemon release here.

python3 run_example_service.py

Running Service + Daemon in Docker Container

Build the docker image and run a container from it:

docker build \
    -t snet_example_service \
    https://github.com/singnet/example-service.git#master

export ETCD_HOST=$HOME/.snet/etcd/example-service/
export ETCD_CONTAINER=/opt/singnet/etcd/
docker run \
    -p 7000:7000 \
    -v $ETCD_HOST:$ETCD_CONTAINER \
    -ti snet_example_service bash

Note that the $ETCD_(HOST|CONTAINER) are useful to keep your service's etcd folder outside the container.

From this point we follow the tutorial in the Docker Container's prompt.

After this, run the service (with SNET Daemon), make sure you have the snetd.config.json file in the service folder:

# cat snetd.config.json
{
   "DAEMON_END_POINT": "localhost:7000",
   "ETHEREUM_JSON_RPC_ENDPOINT": "https://ropsten.infura.io",
   "IPFS_END_POINT": "http://ipfs.singularitynet.io:80",
   "REGISTRY_ADDRESS_KEY": "0x5156fde2ca71da4398f8c76763c41bc9633875e4",
   "PASSTHROUGH_ENABLED": true,
   "PASSTHROUGH_ENDPOINT": "http://localhost:7003",
   "ORGANIZATION_ID": "my-organization",
   "SERVICE_ID": "my-service",
   "PAYMENT_CHANNEL_STORAGE_SERVER": {
       "DATA_DIR": "/opt/singnet/etcd/"
   },
   "LOG": {
       "LEVEL": "debug",
       "OUTPUT": {
            "TYPE": "stdout"
           }
   }
}
# python3 run_example_service.py --daemon-config snetd.config.json &

Testing

Invoke the test script (from the same Docker Container):

# python3 test_example_service.py

License

This project is licensed under the MIT License - see the LICENSE file for details.

w1kke / example-service