deployWorkflow

The deployWorkflow method is used to deploy a fresh workflow.

Import: imported as follows

import { deployWorkflow } from '@inverter-network/sdk'

Parameters: expects the following parameters

{
    // the public client / provider to make RPC calls
    publicClient: PublicClient
    // the wallet client to sign and submit transactions
    walletClient: WalletClient
    // The modules which will be deployed
    requestedModules: MixedRequestedModules
    // The parser config, in charge of decimals, ...
    tagConfig?: TagConfig
    // The Inverter instance in charge of cache
    self?: Inverter
}

Returns: an object with the following properties

{
    // returns a schema of the inputs required for deploying, e.g. can be used to render input fields
    inputs: GetDeployWorkflowInputs
    
    // a function that takes in deployment parameters, submits a deployment
    run(args: GeDeployWorkflowArgs, options?: MethodOptions): Promise<DeployWorkflowWriteReturnType>
    
    // a function that takes in deployment parameters, simulates a deployment transaction and returns the orchestratorAddress
    simulate: (userArgs: GeDeployWorkflowArgs) => Promise<DeployWorkflowSimulateReturnType>
    
    // a function that takes in deployment parameters, estimates the deployment gas and return value and formatted value
    estimateGas: (userArgs: GeDeployWorkflowArgs) => Promise<DeployWorkflowEstimateGasReturnType>
    
    // a function that returns the bytecode which can be used to deploy the workflow
    bytecode: (userArgs: GeDeployWorkflowArgs) => Promise<DeployWorkflowBytecodeReturnType>
}