Class ContractDeployingClientEnv

Readonlyaccount

ReadonlychainId

ReadonlycosmRegistry

ReadonlyethereumClient

ReadonlyqueryClient

ReadonlyreadonlyReason

ReadonlystargateClient

evmSignAndSend

• evmSignAndSend(msg): Promise<ReceiptInformation>

• Parameters

  • msg: Transaction

  Returns Promise<ReceiptInformation>

• evmSignAndSend(msg, finality): Promise<string>

• Parameters

  • msg: Transaction
  • finality: "broadcasted"

  Returns Promise<string>

• evmSignAndSend(msg, finality?): Promise<ReceiptInformation>

• Parameters

  • msg: Transaction
  • Optionalfinality: {
        confirmed: {
            timeoutMs?: number;
        };
    }

    • confirmed: {
          timeoutMs?: number;
      }

      • OptionaltimeoutMs?: number

  Returns Promise<ReceiptInformation>

• evmSignAndSend(msg, finality?): Promise<string | ReceiptInformation>

• Parameters

  • msg: Transaction
  • Optionalfinality: TransactionFinality

  Returns Promise<string | ReceiptInformation>

execIxsToCosmosMsgs

• execIxsToCosmosMsgs(instructions): EncodeObject[]

• Encodes the specified contract instructions into an array of cosmos messages

  ⚠️ This uses a placeholder typeUrl for EVM invocations, as at the time of writing, Sei does not support calling the EVM in a top-level cosmos message without an EVM signature. Though the resulting EncodeObject[] may still be used with cosmosMessagesToEvmMessages and makeHackyTransactionSequenceAsNeeded

  Parameters

  • instructions: EvmOrWasmExecuteInstruction[]

    contract instructions to encode

  Returns EncodeObject[]

executeContract

• executeContract(instruction): Promise<DeliverTxResponse>

• Executes a single contract instrcution

  ⚠️ This currently cannot be used to execute EVM contracts, as the transaction will be signed with a cosmos signature, and Sei currently requires all top-level EVM invocations to have EVM signatures.

  Parameters

  • instruction: EvmOrWasmExecuteInstruction

    The contract instruction to execute.

  Returns Promise<DeliverTxResponse>

  the transaction hash or its receipt, depending on how finality was specified
• executeContract(instruction, memo?): Promise<DeliverTxResponse>

• Parameters

  • instruction: EvmOrWasmExecuteInstruction
  • Optionalmemo: string

  Returns Promise<DeliverTxResponse>

• executeContract(instruction, memo?, fee?): Promise<DeliverTxResponse>

• Parameters

  • instruction: EvmOrWasmExecuteInstruction
  • Optionalmemo: string
  • Optionalfee: "auto" | StdFee

  Returns Promise<DeliverTxResponse>

• executeContract(instruction, memo, fee, finality): Promise<string>

• Parameters

  • instruction: EvmOrWasmExecuteInstruction
  • memo: undefined | string
  • fee: undefined | "auto" | StdFee
  • finality: "broadcasted"

  Returns Promise<string>

• executeContract(instruction, memo?, fee?, finality?): Promise<DeliverTxResponse>

• Parameters

  • instruction: EvmOrWasmExecuteInstruction
  • Optionalmemo: string
  • Optionalfee: "auto" | StdFee
  • Optionalfinality: {
        confirmed: {
            timeoutMs?: number;
        };
    }

    • confirmed: {
          timeoutMs?: number;
      }

      • OptionaltimeoutMs?: number

  Returns Promise<DeliverTxResponse>

• executeContract(instruction, memo?, fee?, finality?): Promise<string | DeliverTxResponse>

• Parameters

  • instruction: EvmOrWasmExecuteInstruction
  • Optionalmemo: string
  • Optionalfee: "auto" | StdFee
  • Optionalfinality: TransactionFinality

  Returns Promise<string | DeliverTxResponse>

executeContractMulti

• executeContractMulti(instructions): Promise<DeliverTxResponse>

• Executes the specified contract instructions

  ⚠️ This currently cannot be used to execute EVM contracts, as the transaction will be signed with a cosmos signature, and Sei currently requires all top-level EVM invocations to have EVM signatures.

  Parameters

  • instructions: EvmOrWasmExecuteInstruction[]

  Returns Promise<DeliverTxResponse>

  the transaction hash or its receipt, depending on how finality was specified
• executeContractMulti(instructions, memo?): Promise<DeliverTxResponse>

• Parameters

  • instructions: EvmOrWasmExecuteInstruction[]
  • Optionalmemo: string

  Returns Promise<DeliverTxResponse>

• executeContractMulti(instructions, memo?, fee?): Promise<DeliverTxResponse>

• Parameters

  • instructions: EvmOrWasmExecuteInstruction[]
  • Optionalmemo: string
  • Optionalfee: "auto" | StdFee

  Returns Promise<DeliverTxResponse>

• executeContractMulti(instructions, memo, fee, finality): Promise<string>

• Parameters

  • instructions: EvmOrWasmExecuteInstruction[]
  • memo: undefined | string
  • fee: undefined | "auto" | StdFee
  • finality: "broadcasted"

  Returns Promise<string>

• executeContractMulti(instructions, memo?, fee?, finality?): Promise<DeliverTxResponse>

• Parameters

  • instructions: EvmOrWasmExecuteInstruction[]
  • Optionalmemo: string
  • Optionalfee: "auto" | StdFee
  • Optionalfinality: {
        confirmed: {
            timeoutMs?: number;
        };
    }

    • confirmed: {
          timeoutMs?: number;
      }

      • OptionaltimeoutMs?: number

  Returns Promise<DeliverTxResponse>

• executeContractMulti(instructions, memo?, fee?, finality?): Promise<string | DeliverTxResponse>

• Parameters

  • instructions: EvmOrWasmExecuteInstruction[]
  • Optionalmemo: string
  • Optionalfee: "auto" | StdFee
  • Optionalfinality: TransactionFinality

  Returns Promise<string | DeliverTxResponse>

getAccount

• getAccount(): SeiClientAccountData

• Conveniently throws an error with the underlying reason if the account property is null

  Returns SeiClientAccountData

getBalance

• getBalance(unifiedDenom, accountAddress?): Promise<bigint>

• Gets the balance of the specified fungible asset

  Parameters

  • unifiedDenom: string

    the fungible to get the balance of
  • OptionalaccountAddress: string

    account address, can be a 0x or sei1 address (if they're associated) defaults to this user's 0x or sei1 address depending on whether which asset is specified.

  Returns Promise<bigint>

  the raw value. If you wish to make it look pretty, use it with UIAmount.

getSupplyOf

• getSupplyOf(unifiedDenom): Promise<bigint>

• Gets the total supply of the specified fungible asset.

  Parameters

  • unifiedDenom: string

    the asset to look up

  Returns Promise<bigint>

  the raw value. If you wish to make it look pretty, use it with UIAmount.

hasAccount

• hasAccount(): this is {
      account: SeiClientAccountData;
  }

• If you want to actually check if transactions can be sent, use the isSignable method

  Returns this is {
      account: SeiClientAccountData;
  }

  true if the wallet is known

hasEthereum

• hasEthereum(): this is {
      ethereumClient: EthereumProvider;
  }

• Returns this is {
      ethereumClient: EthereumProvider;
  }

  true if ethereum transaction signing is available

isAssociated

• isAssociated(): Promise<boolean>

• Checks whether or not this account is associated. (The node is aware of the relationship between the 0x and sei1 accounts)

  Always returns false if this ClientEnv isn't associated with an account.

  Returns Promise<boolean>

isEthereumOnly

• isEthereumOnly(): this is {
      ethereumClient: EthereumProvider;
      signer: null;
      stargateClient: StargateClient;
  }

• Returns this is {
      ethereumClient: EthereumProvider;
      signer: null;
      stargateClient: StargateClient;
  }

  true if ethereum transaction signing is available, and cosmos tranasction signing is not available

isSignable

• isSignable(): this is {
      account: SeiClientAccountData;
      signer: OfflineSigner;
      stargateClient: SigningStargateClient;
  }

• Returns this is {
      account: SeiClientAccountData;
      signer: OfflineSigner;
      stargateClient: SigningStargateClient;
  }

  true if cosmos tranasction signing is available and the wallet is known

isSignableAndEthereum

• isSignableAndEthereum(): this is {
      account: SeiClientAccountData;
      ethereumClient: EthereumProvider;
      signer: OfflineSigner;
      stargateClient: SigningStargateClient;
  }

• Returns this is {
      account: SeiClientAccountData;
      ethereumClient: EthereumProvider;
      signer: OfflineSigner;
      stargateClient: SigningStargateClient;
  }

  true if cosmos tranasction signing and ethereum transaction signing is available

makeHackyTransactionSequenceAsNeeded

• makeHackyTransactionSequenceAsNeeded(msgs): Promise<({
      evmMsg: Transaction;
  } | {
      cosmMsg: EncodeObject[];
  })[]>

• A key compontent in compensating for Sei's idiosyncracies in its CosmWasm <> EVM interop.

  Idiosyncracies being:

  • Sei requires top-level EVM invoke instructions to be ...
    • the one and only thing that occupies the transaction.
    • signed by an Ethereum wallet. There's no way to invoke the EVM on the top level using a cosmos signature.

  Additionally, ethereum wallets cannot bundle multiple instructions per transaction.

  To help with this, this function takes the EncodeObject[] provided, which may include an internal typeUrl which reprensts EVM invocations, and seperates them into EVM messages or Cosmos messages as needed.

  • If this represents an Ethereum-only client
    • All messages will be converted to EVM messages using cosmosMessagesToEvmMessages
  • If this represents a cosmos client
    • Cosmos messages will be returned as-is, with any interspersed EVM messages returned as EVM messages

  Parameters

  • msgs: EncodeObject[]

  Returns Promise<({
      evmMsg: Transaction;
  } | {
      cosmMsg: EncodeObject[];
  })[]>

queryContract

• queryContract(contractAddress, query): Promise<any>

• Parameters

  • contractAddress: string
  • query: object

  Returns Promise<any>

queryEvmContract

• queryEvmContract(contractAddress, functionDefinition, params): Promise<any[]>

• Makes a read-only call to a solidity contract

  Parameters

  • contractAddress: string

    The 0x... contract address
  • functionDefinition: string | EVMABIFunctionDefinition

    Function to call with its return types
  • params: any[]

    Function arguments

  Returns Promise<any[]>

  the returned values as an array

queryEvmContractForObject

• queryEvmContractForObject(contractAddress, functionDefinition, params): Promise<any>

• Makes a read-only call to a solidity contract

  Parameters

  • contractAddress: string

    The 0x... contract address
  • functionDefinition: string | EVMABIFunctionDefinition

    Function to call with its return types
  • params: any[]

    Function arguments

  Returns Promise<any>

  the returned values as a struct

signAndSend

• signAndSend(msgs): Promise<DeliverTxResponse>

• Parameters

  • msgs: EncodeObject[]

  Returns Promise<DeliverTxResponse>

• signAndSend(msgs, memo?): Promise<DeliverTxResponse>

• Parameters

  • msgs: EncodeObject[]
  • Optionalmemo: string

  Returns Promise<DeliverTxResponse>

• signAndSend(msgs, memo?, fee?): Promise<DeliverTxResponse>

• Parameters

  • msgs: EncodeObject[]
  • Optionalmemo: string
  • Optionalfee: "auto" | StdFee

  Returns Promise<DeliverTxResponse>

• signAndSend(msgs, memo, fee, finality): Promise<string>

• Parameters

  • msgs: EncodeObject[]
  • memo: undefined | string
  • fee: undefined | "auto" | StdFee
  • finality: "broadcasted"

  Returns Promise<string>

• signAndSend(msgs, memo?, fee?, finality?): Promise<DeliverTxResponse>

• Parameters

  • msgs: EncodeObject[]
  • Optionalmemo: string
  • Optionalfee: "auto" | StdFee
  • Optionalfinality: {
        confirmed: {
            timeoutMs?: number;
        };
    }

    • confirmed: {
          timeoutMs?: number;
      }

      • OptionaltimeoutMs?: number

  Returns Promise<DeliverTxResponse>

• signAndSend(msgs, memo?, fee?, finality?): Promise<string | DeliverTxResponse>

• Parameters

  • msgs: EncodeObject[]
  • Optionalmemo: string
  • Optionalfee: "auto" | StdFee
  • Optionalfinality: TransactionFinality

  Returns Promise<string | DeliverTxResponse>

simulateContract

• simulateContract(instruction): Promise<SimulateResponse>

• convenience function for simulating transactions containing a single cosmwasm message

  Parameters

  • instruction: EvmOrWasmExecuteInstruction

    cosmwasm instructions to execute

  Returns Promise<SimulateResponse>

  the simulation result

simulateContractMulti

• simulateContractMulti(instructions): Promise<SimulateResponse>

• convenience function for simulating transactions containing cosmwasm messages

  Parameters

  • instructions: EvmOrWasmExecuteInstruction[]

    cosmwasm instructions to execute

  Returns Promise<SimulateResponse>

  the simulation result

simulateTransaction

• simulateTransaction(messages): Promise<SimulateResponse>

• Simulates the transaction and provides actually useful information. Like the events emitted.

  Parameters

  • messages: readonly EncodeObject[]

  Returns Promise<SimulateResponse>

waitForEvmTxConfirm

• waitForEvmTxConfirm(tx, timeoutMs?, throwOnTimeout?): Promise<null | ReceiptInformation>

• Waits for the specified EVM transaction hash to confirm

  Parameters

  • tx: string

    the transcation hash
  • OptionaltimeoutMs: number

    how long to wait until timing out. Defaults to 60 seconds
  • OptionalthrowOnTimeout: boolean

    whether or not to throw an error if the timeout time has elapsed instead of returning null

  Returns Promise<null | ReceiptInformation>

  the confirmed transaction, or null if we waited too long and throwOnTimeout is falsy
• waitForEvmTxConfirm(tx, timeoutMs, throwOnTimeout): Promise<ReceiptInformation>

• Waits for the specified EVM transaction hash to confirm

  Parameters

  • tx: string

    the transcation hash
  • timeoutMs: undefined | number

    how long to wait until timing out. Defaults to 60 seconds if undefined
  • throwOnTimeout: true

    you explicitly set this to true, so prepare for error throwing

  Returns Promise<ReceiptInformation>

  the confirmed transaction

waitForTxConfirm

• waitForTxConfirm(tx, timeoutMs?, throwOnTimeout?): Promise<null | DeliverTxResponse>

• Waits for the specified cosmos transaction to confirm

  Parameters

  • tx: string

    the transcation hash
  • OptionaltimeoutMs: number

    how long to wait until timing out. Defaults to 60 seconds
  • OptionalthrowOnTimeout: boolean

    whether or not to throw an error if the timeout time has elapsed instead of returning null

  Returns Promise<null | DeliverTxResponse>

  the confirmed transaction, or null if we waited too long and throwOnTimeout is falsy
• waitForTxConfirm(tx, timeoutMs, throwOnTimeout): Promise<DeliverTxResponse>

• Waits for the specified cosmos transaction to confirm

  Parameters

  • tx: string

    the transcation hash
  • timeoutMs: undefined | number

    how long to wait until timing out. Defaults to 60 seconds if undefined
  • throwOnTimeout: true

    you explicitly set this to true, so prepare for error throwing

  Returns Promise<DeliverTxResponse>

  the confirmed transaction

Staticget

• get<T>(this, provider?, chainId?, gasPrice?): Promise<InstanceType<T>>

• Don't be afraid of the type definition, just use ClientEnv.get()

  This gets a ClientEnv from the provider specified.

  Type Parameters

  • T extends typeof ClientEnv

  Parameters

  • this: T
  • provider: MaybeSelectedProvider = defaultProvider

    The provider to use
  • chainId:
        | "sei-chain"
        | "arctic-1"
        | "atlantic-2"
        | "pacific-1" = ...

    The network ID to connect to
  • gasPrice: GasPrice = defaultGasPrice

    gas price

  Returns Promise<InstanceType<T>>

StaticgetDefaultGasPrice

• getDefaultGasPrice(): GasPrice

• Returns GasPrice

StaticgetDefaultProvider

• getDefaultProvider(): MaybeSelectedProviderString

• Returns the current default provider

  Returns MaybeSelectedProviderString

  The default provider

StaticnullifyDefaultProvider

• nullifyDefaultProvider(): void

• Sets the default provider to null synchronously

  Returns void

StaticsetDefaultGasPrice

• setDefaultGasPrice(gasPrice): void

• Parameters

  • gasPrice: GasPrice

  Returns void

StaticsetDefaultProvider

• setDefaultProvider(provider, dontThrowOnFail?): Promise<void>

• Sets the specified provider as the default one when ClientEnv.get is called.

  Parameters

  • provider: MaybeSelectedProvider

    the provider to use.
  • dontThrowOnFail: boolean = false

    if false, this will throw an error on failure

  Returns Promise<void>