snet-daemon

README

snet-daemon

SingularityNET Daemon The daemon is the adapter with which an otherwise SingularityNET-unaware service implementation can be exposed to the SingularityNET platform. It is designed to be deployed as a sidecar proxy alongside the service on a given host. The daemon abstracts the blockchain components away from the clients. The SNET Daemon interacts with the Multi Party Escrow to facilitate authorization and payment for services and acts as a passthrough for making API calls to the service.The daemon is the endpoint a client will submit requests to, and they are then passed to the service after validation by the daemon.

Channel Claim command

Gets the latest channel state of the Channel updated in ETCD by the daemons of the same group and then increments the nonce of the channel. It then sends and ON-Chain transaction to claim funds.The daemons continue their work independently without any confirmation from the treasurer on the blockchain.

Development

These instructions are intended to facilitate the development and testing of SingularityNET Daemon. Users interested in deploying SingularityNET services using SingularityNET Daemon should install the appropriate binary as released.

Prerequisites

• Go 1.10+
• Dep 0.4.1+
• Node 8+ w/npm

Dependencies

• install Protoc 3.0+

• install [protoc-gen-go]

$ go get -u github.com/golang/protobuf/protoc-gen-go

• install [grpc]

$ go get -u google.golang.org/grpc

• install [golint]

$ sudo apt-get install golint

• If you want to cross-compile you will also need Docker

Installing

• Clone the git repository to the following path $GOPATH/src/github.com/singnet/

$ git clone git@github.com:singnet/snet-daemon.git
$ cd snet-daemon

• Install development/test dependencies

$ ./scripts/install

• Build snet-daemon (on Linux amd64 platform), see below section if you want to cross compile instead. Please note using ldflags, the latest tagged version , sha1 revision and the build time are set as part of the build. You need to pass the version as shown in the example below

$ ./scripts/build linux amd64 <version>

• Generate default config file snet-daemon (on Linux amd64 platform)

$ ./build/snetd-linux-amd64 init 

**** Please update the registry address in daemon config based on the test network used

Cross-compiling

If you want to build snetd for platforms other than the one you are on, run ./scripts/build-xgo instead of ./scripts/build.

You can edit the script to choose a specific platform, but by default it will build for Linux, OSX, and Windows (amd64 for all, except Linux which will also build for arm6)

Please note using ldflags the latest tagged version (passed as the first parameter to the script) , sha1 revision and the build time are set as part of the build.

$ ./scripts/build-xgo <version>

Run Deamon

$ ../build/snetd-linux-amd64

Main commands

• Start snet-daemon

$ ./snetd-linux-amd64

• Claim funds from the channel

  Refer to the link below on an end to end Example of MPE

  At the moment treasurer server is a part of snet-daemon command line interface.

$ ./snetd-linux-amd64 claim --channel-id 0

• Full list of commands, use --help to get more information.

$ ./build/snetd-linux-amd64 --help
Usage:
  snetd [flags]
  snetd [command]

Available Commands:
  channel     Manage operations on payment channels
  freecall    Manage operations on free call users
  help        Help about any command
  init        Write default configuration to file
  list        List channels, claims in progress, etc
  serve       Is the default option which starts the Daemon.
  version     List the current version of the Daemon.

Flags:
  -c, --config string   config file (default "snetd.config.json")
  -h, --help            help for snetd

Use "snetd [command] --help" for more information about a command.

• Unit Testing

$ ./scripts/test

Configuration

Configuration file is a main source of the configuration. Some properties can be set via environment variables or command line parameters see table below. Use --config parameter with any command to set configuration file name. By default daemon use configuration file in JSON format snetd.config.json but other formats are also supported via Viper. Use snet init command to save configuration file with default values. Following configuration properties can be set using configuration file.

Main properties

These properties you should usually change before starting daemon for the first time.

• blockchain_network_selected (required) Name of the network to be used for Daemon possible values are one of (kovan,ropsten,main,local or rinkeby). Daemon will automatically read the Registry address associated with this network For local network ( you can also specify the registry address manually),see the blockchain_network_config.json

• daemon_end_point (required;) - Defines the ip and the port on which the daemon listens to. format is :<host>:<port>.

• ethereum_json_rpc_endpoint (optional, default: "http://127.0.0.1:8545") - endpoint to which daemon sends ethereum JSON-RPC requests; Based on the network selected blockchain_network_selected the end point is auto determined Example "https://kovan.infura.io" for kovan testnet.

• ipfs_end_point (optional; default "http://localhost:5002/") - endpoint of IPFS instance to get service configuration metadata

• organization_id (required) - Id of the organization to search for service configuration metadata.

• service_id (required) - Id of the service to search for service configuration metadata.

• passthrough_enabled (optional; default: false) - when passthrough is disabled, daemon echoes requests back as responses; false reserved mostly for testing purposes.

• passthrough_endpoint (required if service_type != executable) - endpoint to which requests should be proxied for handling by service.

• executable_path (required if service_type == executable) - path to executable to expose as a service.

Other properties

This options are less frequently needed.

• allowed_users_flag (optional;default:false) - You may need to protect the service provider 's service in test environment from being called by anyone, only Authorized users can make calls , when this flag is defined in the config, you can enforce this behaviour.You cannot set this flag to true in mainnet.
  This config is applicable only when you have the value to true. In which case it becomes mandatory to define the configuration allowed_users,

• allowed_user_addresses (optional;) - List of selected user addresses who can make requests to Daemon Is Applicable only when you have allowed_users_flag set to true.

• authentication_address (required if You need to update Daemon configurations remotely) Contains the Authentication address that will be used to validate all requests to update Daemon configuration remotely through a user interface ( Operator UI)

• auto_ssl_domain (optional; default: "") -
  domain name for which the daemon should automatically acquire SSL certs from Let's Encrypt.

• auto_ssl_cache_dir (optional; only applies if auto_ssl_domain is set; default: ".certs") - directory in which to cache the SSL certs issued by Let's Encrypt

• blockchain_enabled (optional; default: true) - enables or disables blockchain features of daemon; false reserved mostly for testing purposes

• burst_size (optional; default: Infinite) - see rate limiting configuration

• daemon_group_name (optional ,default: "default_group") - This parameter defines the group the daemon belongs to . The group helps determine the recipient address for payments. service configuration metadata.

• log (optional) - see logger configuration

• max_message_size_in_mb (optional; default: 4) - The default value set is to 4 (units are in MB ), this is used to configure the max size in MB of the message received by the Daemon. In case of Large messages , it is recommended to use streaming than setting a very high value on this configuration. It is not recommended to set the value more than 4GB

• metering_enabled (optional,default: false) - This is used to define if metering needs to be enabled or not .You will need to define a valid metering_end_point when this flag is enabled

• metering_end_point (optional;only applies if metering_enabled is set to true) - Needs to be a vaild url where the request and response stats are published as part of Metering

• ssl_cert (optional; default: "") - path to certificate to use for SSL.

• ssl_key (optional; only applies if ssl_cert is set; default: "") - path to key to use for SSL.

• payment_channel_storage_type (optional; default "etcd") - see etcd storage type

• payment_channel_storage_client (optional) - see etcd client configuration

• payment_channel_storage_server (optional) - see etcd server configuration

• pvt_key_for_metering (optional;only applies if metering_enabled is set to true) This is used for authentication between daemon and the metering service in the context publishing stats , Even the latest Channel Status is published , this way the offline channel state balance can also be tracked. Daemon will send a signature signed by this private key , metering service will already have the public key corresponding to this Daemon ,metering service will ensure that the signer it receives matches the public key configured at its end. This is mandatory only when metering is enabled.

• rate_limit_per_minute (optional; default: Infinity) - see rate limiting configuration

• registry_address_key (Optional) - Ethereum address of the Registry contract instance.This is auto determined if not specified based on the blockchain_network_selected If a value is specified , it will be used and no attempt will be made to auto determine the registry address.

• alerts_email (optional; default: "") - It must be a valid email. if it is empty, then it is considered as alerts disabled. see daemon alerts/notifications configuration

• notification_svc_end_point (optional; default: "") - It must be a valid URL. if it is empty, then it is considered as alerts disabled. see daemon alerts/notifications configuration

• service_heartbeat_type (optional; default: grpc) - possible type configurations are none | grpc | http. If it is left empty, then it is considered as none type. see daemon heartbeats configuration

• heartbeat_svc_end_point (optional; default: "") - It must be a valid URL. if it is empty, then service state always assumed as SERVING, and same will be wrapped in Daemon Heartbeat. see daemon heartbeats configuration

• ipfs_timeout (optional; default: 30) - All IPFS read/writes timeout if the operations doesnt complete in 30 sec or set duration in this config entry.

• is_curation_in_progress (optional; default: false) - You may need to protect the service provider 's service in test environment from being called by anyone, only Authorized users can make calls , when this flag is set to true, you can enforce this behaviour.Also see curation_address_for_validation

Environment variables and CLI parameters

config file key	environment variable name	flag
auto_ssl_domain	SNET_AUTO_SSL_DOMAIN	--auto-ssl-domain
auto_ssl_cache_dir	SNET_AUTO_SSL_CACHE_DIR	--auto-ssl-cache
blockchain_enabled	SNET_BLOCKCHAIN_ENABLED	--blockchain, -b
config_path	SNET_CONFIG_PATH	--config, -c
ethereum_json_rpc_endpoint	SNET_ETHEREUM_JSON_RPC_ENDPOINT	--ethereum-endpoint
hdwallet_index	SNET_HDWALLET_INDEX	--wallet-index
hdwallet_mnemonic	SNET_HDWALLET_MNEMONIC	--mnemonic
passthrough_enabled	SNET_PASSTHROUGH_ENABLED	--passthrough
ssl_cert	SNET_SSL_CERT	--ssl-cert
ssl_key	SNET_SSL_KEY	--ssl-key

Release

Precompiled binaries are published with each release.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

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