Quick Start
Installation
To install the SDK, use your preferred package manager from the command line. For example, if you use npm, execute the following command:
~ or ~
Initializing the SDK
Import the class and pass the parameters and initialize the class instance
Deploying Your First Workflow
Retrieve the Deployment Functions
To deploy your initial workflow, you will need to retrieve the deployment functions like so:
Deploying the Workflow
After setting up your deployment with the getDeploy
function, you can proceed to deploy the workflow with the specified modules through calling the run
function, passing the configuration arguments like so:
Interacting with a Deployed Workflow
Retrieving a Workflow
Parameters of required orchestratorAddress
and an optional worklfowOrientations
the orientation is suggested to be passed for e2e
typescript coverage:
Reading Data
You can read data from any of the modules like so ( in this example we are reading the version ):
Writing Data
You can write data to any of the modules like so ( in this example we are depositing to the funding manager ):
Last updated