Service Calling via SDK

Currently, our SDK supports Python and JS (Web). In the future we will support a wider range of languages. We use protocol buffers and grpc, so if you can find language support for both of them, it's only a matter of time before we (or the community! 😉 ) write an SDK for it.

Step 1. Prerequisites

This guide assumes you've got a wallet (check Getting Ready to Call AI CheckUp guide).

This guide calls the calculator service (organization_id = 26072b8b6a0e448180f8c0e702ab6d2f, service_id = Exampleservice) on the testnet sepolia (chain_id = 11155111).

Versions

Python

python 3.10 +

WebJS

Node.js 18 +
react-scripts 5.0.1 +

Step 2. Install the SDK

Python

pip install snet.sdk

WebJS

npm install snet-sdk-web

Step 3. Configure project (only for WebJS)

If you are using create-react-app then require Node.js polyfills for browser compatibility, To add these polyfills, you can use the config-overrides.js file with react-app-rewired. This approach allows you to customize the Webpack configuration without ejecting from create-react-app.

Install react-app-rewired into your application

npm install --save-dev react-app-rewired

Install the necessary polyfill packages

npm install --save-dev buffer process os-browserify url

Create config-overrides.js in the root of your project with the content:

const webpack = require('webpack');

module.exports = function override(config) {
    const fallback = config.resolve.fallback || {};
    Object.assign(fallback, {
        os: require.resolve('os-browserify'),
        url: require.resolve('url'),
    });
    config.resolve.fallback = fallback;
    config.plugins = (config.plugins || []).concat([
        new webpack.ProvidePlugin({
            process: 'process/browser',
            Buffer: ['buffer', 'Buffer'],
        }),
    ]);
    config.ignoreWarnings = [/Failed to parse source map/];
    config.module.rules.push({
        test: /\.(js|mjs|jsx)$/,
        enforce: 'pre',
        loader: require.resolve('source-map-loader'),
        resolve: {
            fullySpecified: false,
        },
    });
    return config;
};

Update your package.json scripts to use react-app-rewired instead of react-scripts.

{
    "scripts": {
        "start": "react-app-rewired start",
        "build": "react-app-rewired build",
        "test": "react-app-rewired test",
        "eject": "react-scripts eject"
    }
}

Step 4. Generate stubs

Python

# Python SDK generates stubs automatically when you create a service client

WebJS

protoc -I="." --js_out=import_style=commonjs,binary:. <file_name>.proto
protoc-gen-grpc -I="." --grpc_out=grpc_js:. <file_name>.proto

Step 5. Write some code!

Here's an example of calling a service using the SDK

Once you have installed snet-sdk in your current environment, you should import snet-sdk and create an instance of the base sdk class. The SDK instance is then used to create service client instances. Finally, the generated service_client instance can be used to call methods provided by the service.

Python

from snet import sdk

config = sdk.config.Config(private_key='YOUR_PRIVATE_KEY',
                eth_rpc_endpoint=f"https://eth-sepolia.g.alchemy.com/v2/<YOUR_API_KEY>", # RPC endpoint of "sepolia" network
                concurrency=False,
                force_update=False)

snet_sdk = sdk.SnetSDK(config)

org_id = "26072b8b6a0e448180f8c0e702ab6d2f" # Organization ID
service_id = "Exampleservice" # Service ID
group_name = "default_group"
service_client = snet_sdk.create_service_client(org_id=org_id, service_id=service_id, group_name=group_name)

result = service_client.call_rpc("mul", "Numbers", a=20, b=3)
print(f"Performing 20 * 3: {result}")

WebJS

import SnetSDK from 'snet-sdk-web';

const config = {
    web3Provider: window.ethereum,
    networkId: '11155111', // Chain ID of "sepolia" network
    defaultGasPrice: '4700000',
    defaultGasLimit: '210000',
};

const initSDK = async () => {
    try {
        const web3Provider = window.ethereum;
        sdk = new SnetSDK(config);
        await sdk.setupAccount();
        return sdk;
    } catch (error) {
        throw error;
    }
};

const getServiceClient = async () => {
    const sdk = await initSdk();
    const calculatorClient = await  sdk.createServiceСlient(
        '26072b8b6a0e448180f8c0e702ab6d2f', // Organization ID
        'Exampleservice' // Service ID
    );
}

const sentRequest = async () => {
    const methodDescriptor = Calculator.mul;
    const request = new methodDescriptor.requestType();

    request.setA(20);
    request.setB(3);

    const props = {
        request,
        preventCloseServiceOnEnd: false,
        onEnd: onActionEnd(),
    };

    const serviceClient = await getServiceClient();
    serviceClient.unary(methodDescriptor, props);
}

const onActionEnd = (response) => {
    const { message, status, statusMessage } = response;
    if (status !== 0) {
        throw new Error(statusMessage);
    }

    console.log("Performing 20 * 3: ", response.message.getValue())
}

Note: The SDK itself configures payment channels for you.

After executing this code, you should have the following result in console:

Performing 20 * 3: 60

Note: You can also use other values and methods to call in that service. Moreover, you can change id of the organization and service to call other services and chain id or RPC endpoint to call services on mainnet.

To learn more about every SDK, visit:

• Python SDK
• WebJS SDK