Inverter

The Inverter class is the most efficient entry point to the sdk, it provides the main API's with the required param's pre-filled.

Parameters:

Inverter.getInstance({
    publicClient: PublicClient,
    walletClient?: WalletClient
})

Returns: Inverter instance

{
  publicClient: PublicClient
  walletClient: WalletClient

  getWorkflow: ({
    orchestratorAddress: `0x${string}`
    requestedModules?: MixedRequestedModules
    fundingTokenType?: WorkflowToken
    issuanceTokenType?: WorkflowIssuanceToken
  }) => Promise<Workflow>

  getDeployWorklowOptions: () => {
    fundingManager: string[]
    authorizer: string[]
    paymentProcessor: string[]
    optionalModules: string[]
  }

  deployWorkflow: <T extends MixedRequestedModules>({
    requestedModules: MixedRequestedModules,
  }) => {
    inputs: GetDeployWorkflowInputs<T>,
    run,
    simulate,
    estimateGas
  }
  
  deploy: <T extends DeployableContracts>(
    {
      name,
      args,
    }
  ) => {
    contractAddress: `0x${string}`
    transactionHash: `0x${string}`
  }
  
  getModule: (
    params: Omit<GetModuleParams, 'walletClient' | 'publicClient' | 'self'>
  ) => GetModuleReturnType
}

Example:

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

const sdk = Inverter.getInstance({ publicClient, walletClient })

const { 
    publicClient,
    walletClient,
    updatePublicClient,
    updateWalletClient,
    getWorkflow, 
    getDeployWorkflowOptions,
    deployWorkflow,
    getModule,
    deploy
} = sdk