Aventus-Network-Services / avn-api

An API for interacting with the Aventus AvN layer 2 blockchain
5 stars 1 forks source link

Missing argument in documentation #45

Closed pazuro closed 1 year ago

pazuro commented 1 year ago

Some examples are missing the avn gateway url as an argument in the avn api constructor.

Maybe the examples could read more like the following:

 import { AvnApi, SetupMode } from 'avn-api';

// The AvN gateway endpoint:
const AVN_GATEWAY_URL = 'https://...';

 const singleUserSdk = new AvnApi(AVN_GATEWAY_URL, { setupMode : SetupMode.SingleUser } ) // OR
 const multiUserSdk = new AvnApi(AVN_GATEWAY_URL, { setupMode : SetupMode.MultiUser } )

This is also echoed in the usage page of the docs: https://docs.gateway.aventus.io/docs/set_up/usage

dr-ngubo commented 1 year ago

@pazuro Thank you for your suggestion. We've added it in the docs https://docs.gateway.aventus.io/docs/set_up/usage