Class ClientEnv

The main class used to interact with the Sei network, optionally associated with a wallet.

This provides various abstractions for interacting with different assets usable on Sei, along with the ability to interact with both EVM and WASM contracts.

Hierarchy (view full)

ClientEnv
- ContractDeployingClientEnv

Constructors

constructor

new ClientEnv(__namedParameters): ClientEnv
use of the constructor is discouraged and isn't guaranteed to be stable. Use the get() function instead.
Parameters
- __namedParameters: ClientEnvConstruct
Returns ClientEnv
- Defined in packages/npm/sei-utils/src/client_env.ts:534

Properties

`Readonly`account

account: null | SeiClientAccountData

User's account data. Will be null if this isn't associated with an account

`Readonly`chainId

chainId:
    | "sei-chain"
    | "arctic-1"
    | "atlantic-2"
    | "pacific-1"

The Sei network ID this client is connected to

`Protected`cometClient

cometClient: CometClient

`Readonly`cosmRegistry

cosmRegistry: Registry

The stargateClient needs this to encode things properly.

`Readonly`ethereumClient

ethereumClient: null | EthereumProvider

If an ethereum wallet is connected, it will be exposed here.

`Readonly`queryClient

queryClient: SeiQueryClient

The underlying query client, used to query the specific modules on Sei.

`Readonly`readonlyReason

readonlyReason: string

If this is a read-only account, this says why.

`Protected`signer

signer: null | OfflineSigner

`Readonly`stargateClient

stargateClient: SigningStargateClient | StargateClient

A SigningStargateClient if this ClientEnv is used with an account which can sign transactions, or a StargateClient otherwise. Used for general network information and optionally signing things.

Methods

evmSignAndSend

evmSignAndSend(msg): Promise<ReceiptInformation>
Parameters
- msg: Transaction
Returns Promise<ReceiptInformation>
- Defined in packages/npm/sei-utils/src/client_env.ts:713
evmSignAndSend(msg, finality): Promise<string>
Parameters
- msg: Transaction
- finality: "broadcasted"
Returns Promise<string>
- Defined in packages/npm/sei-utils/src/client_env.ts:716
evmSignAndSend(msg, finality?): Promise<ReceiptInformation>
Parameters
- msg: Transaction
- Optionalfinality: {
      confirmed: {
          timeoutMs?: number;
      };
  }
  - confirmed: {
    timeoutMs?: number;
    }
    - OptionaltimeoutMs?: number
Returns Promise<ReceiptInformation>
- Defined in packages/npm/sei-utils/src/client_env.ts:720
evmSignAndSend(msg, finality?): Promise<string | ReceiptInformation>
Parameters
- msg: Transaction
- Optionalfinality: TransactionFinality
Returns Promise<string | ReceiptInformation>
- Defined in packages/npm/sei-utils/src/client_env.ts:724

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[]
- Defined in packages/npm/sei-utils/src/client_env.ts:1061

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
- Defined in packages/npm/sei-utils/src/client_env.ts:840
executeContract(instruction, memo?): Promise<DeliverTxResponse>
Parameters
- instruction: EvmOrWasmExecuteInstruction
- Optionalmemo: string
Returns Promise<DeliverTxResponse>
- Defined in packages/npm/sei-utils/src/client_env.ts:841
executeContract(instruction, memo?, fee?): Promise<DeliverTxResponse>
Parameters
- instruction: EvmOrWasmExecuteInstruction
- Optionalmemo: string
- Optionalfee: "auto" | StdFee
Returns Promise<DeliverTxResponse>
- Defined in packages/npm/sei-utils/src/client_env.ts:842
executeContract(instruction, memo, fee, finality): Promise<string>
Parameters
- instruction: EvmOrWasmExecuteInstruction
- memo: undefined | string
- fee: undefined | "auto" | StdFee
- finality: "broadcasted"
Returns Promise<string>
- Defined in packages/npm/sei-utils/src/client_env.ts:843
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>
- Defined in packages/npm/sei-utils/src/client_env.ts:849
executeContract(instruction, memo?, fee?, finality?): Promise<string | DeliverTxResponse>
Parameters
- instruction: EvmOrWasmExecuteInstruction
- Optionalmemo: string
- Optionalfee: "auto" | StdFee
- Optionalfinality: TransactionFinality
Returns Promise<string | DeliverTxResponse>
- Defined in packages/npm/sei-utils/src/client_env.ts:855

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
- Defined in packages/npm/sei-utils/src/client_env.ts:884
executeContractMulti(instructions, memo?): Promise<DeliverTxResponse>
Parameters
- instructions: EvmOrWasmExecuteInstruction[]
- Optionalmemo: string
Returns Promise<DeliverTxResponse>
- Defined in packages/npm/sei-utils/src/client_env.ts:885
executeContractMulti(instructions, memo?, fee?): Promise<DeliverTxResponse>
Parameters
- instructions: EvmOrWasmExecuteInstruction[]
- Optionalmemo: string
- Optionalfee: "auto" | StdFee
Returns Promise<DeliverTxResponse>
- Defined in packages/npm/sei-utils/src/client_env.ts:886
executeContractMulti(instructions, memo, fee, finality): Promise<string>
Parameters
- instructions: EvmOrWasmExecuteInstruction[]
- memo: undefined | string
- fee: undefined | "auto" | StdFee
- finality: "broadcasted"
Returns Promise<string>
- Defined in packages/npm/sei-utils/src/client_env.ts:891
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>
- Defined in packages/npm/sei-utils/src/client_env.ts:897
executeContractMulti(instructions, memo?, fee?, finality?): Promise<string | DeliverTxResponse>
Parameters
- instructions: EvmOrWasmExecuteInstruction[]
- Optionalmemo: string
- Optionalfee: "auto" | StdFee
- Optionalfinality: TransactionFinality
Returns Promise<string | DeliverTxResponse>
- Defined in packages/npm/sei-utils/src/client_env.ts:903

getAccount

getAccount(): SeiClientAccountData
Conveniently throws an error with the underlying reason if the account property is null

Returns SeiClientAccountData
- Defined in packages/npm/sei-utils/src/client_env.ts:558

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.
- Defined in packages/npm/sei-utils/src/client_env.ts:993

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.
- Defined in packages/npm/sei-utils/src/client_env.ts:1140

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
- Defined in packages/npm/sei-utils/src/client_env.ts:610

hasEthereum

hasEthereum(): this is {
ethereumClient: EthereumProvider;
}
Returns this is {
ethereumClient: EthereumProvider;
}
true if ethereum transaction signing is available
- Defined in packages/npm/sei-utils/src/client_env.ts:590

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>
- Defined in packages/npm/sei-utils/src/client_env.ts:1168

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
- Defined in packages/npm/sei-utils/src/client_env.ts:597

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
- Defined in packages/npm/sei-utils/src/client_env.ts:567

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
- Defined in packages/npm/sei-utils/src/client_env.ts:578

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[];
})[]>
- Defined in packages/npm/sei-utils/src/client_env.ts:1113

queryContract

queryContract(contractAddress, query): Promise<any>
Parameters
- contractAddress: string
- query: object
Returns Promise<any>
- Defined in packages/npm/sei-utils/src/client_env.ts:954

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
- Defined in packages/npm/sei-utils/src/client_env.ts:964

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
- Defined in packages/npm/sei-utils/src/client_env.ts:978

signAndSend

signAndSend(msgs): Promise<DeliverTxResponse>
Parameters
- msgs: EncodeObject[]
Returns Promise<DeliverTxResponse>
- Defined in packages/npm/sei-utils/src/client_env.ts:757
signAndSend(msgs, memo?): Promise<DeliverTxResponse>
Parameters
- msgs: EncodeObject[]
- Optionalmemo: string
Returns Promise<DeliverTxResponse>
- Defined in packages/npm/sei-utils/src/client_env.ts:758
signAndSend(msgs, memo?, fee?): Promise<DeliverTxResponse>
Parameters
- msgs: EncodeObject[]
- Optionalmemo: string
- Optionalfee: "auto" | StdFee
Returns Promise<DeliverTxResponse>
- Defined in packages/npm/sei-utils/src/client_env.ts:759
signAndSend(msgs, memo, fee, finality): Promise<string>
Parameters
- msgs: EncodeObject[]
- memo: undefined | string
- fee: undefined | "auto" | StdFee
- finality: "broadcasted"
Returns Promise<string>
- Defined in packages/npm/sei-utils/src/client_env.ts:760
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>
- Defined in packages/npm/sei-utils/src/client_env.ts:766
signAndSend(msgs, memo?, fee?, finality?): Promise<string | DeliverTxResponse>
Parameters
- msgs: EncodeObject[]
- Optionalmemo: string
- Optionalfee: "auto" | StdFee
- Optionalfinality: TransactionFinality
Returns Promise<string | DeliverTxResponse>
- Defined in packages/npm/sei-utils/src/client_env.ts:772

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
- Defined in packages/npm/sei-utils/src/client_env.ts:951

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
- Defined in packages/npm/sei-utils/src/client_env.ts:942

simulateTransaction

simulateTransaction(messages): Promise<SimulateResponse>
Simulates the transaction and provides actually useful information. Like the events emitted.
Parameters
- messages: readonly EncodeObject[]
Returns Promise<SimulateResponse>
- Defined in packages/npm/sei-utils/src/client_env.ts:920

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
- Defined in packages/npm/sei-utils/src/client_env.ts:621
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
- Defined in packages/npm/sei-utils/src/client_env.ts:629

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
- Defined in packages/npm/sei-utils/src/client_env.ts:671
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
- Defined in packages/npm/sei-utils/src/client_env.ts:679

`Static`get

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>>
- Defined in packages/npm/sei-utils/src/client_env.ts:427

`Static`getDefaultGasPrice

getDefaultGasPrice(): GasPrice
Returns GasPrice
- Defined in packages/npm/sei-utils/src/client_env.ts:181

`Static`getDefaultProvider

getDefaultProvider(): MaybeSelectedProviderString
Returns the current default provider

Returns MaybeSelectedProviderString
The default provider
- Defined in packages/npm/sei-utils/src/client_env.ts:146

`Static`nullifyDefaultProvider

nullifyDefaultProvider(): void
Sets the default provider to null synchronously

Returns void
- Defined in packages/npm/sei-utils/src/client_env.ts:152

`Static`setDefaultGasPrice

setDefaultGasPrice(gasPrice): void
Parameters
- gasPrice: GasPrice
Returns void
- Defined in packages/npm/sei-utils/src/client_env.ts:178

`Static`setDefaultProvider

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>
- Defined in packages/npm/sei-utils/src/client_env.ts:189

Class ClientEnv

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ClientEnv

Properties

Readonlyaccount

ReadonlychainId

ProtectedcometClient

ReadonlycosmRegistry

ReadonlyethereumClient

ReadonlyqueryClient

ReadonlyreadonlyReason

Protectedsigner

ReadonlystargateClient

Methods

evmSignAndSend

Parameters

Returns Promise<ReceiptInformation>

Parameters

Returns Promise<string>

Parameters

confirmed: { timeoutMs?: number; }

OptionaltimeoutMs?: number

Returns Promise<ReceiptInformation>

Parameters

Returns Promise<string | ReceiptInformation>

execIxsToCosmosMsgs

Parameters

Returns EncodeObject[]

executeContract

Parameters

Returns Promise<DeliverTxResponse>

Parameters

Returns Promise<DeliverTxResponse>

Parameters

Returns Promise<DeliverTxResponse>

Parameters

Returns Promise<string>

Parameters

confirmed: { timeoutMs?: number; }

OptionaltimeoutMs?: number

Returns Promise<DeliverTxResponse>

Parameters

Returns Promise<string | DeliverTxResponse>

executeContractMulti

Parameters

Returns Promise<DeliverTxResponse>

Parameters

Returns Promise<DeliverTxResponse>

Parameters

Returns Promise<DeliverTxResponse>

Parameters

Returns Promise<string>

Parameters

confirmed: { timeoutMs?: number; }

OptionaltimeoutMs?: number

Returns Promise<DeliverTxResponse>

Parameters

Returns Promise<string | DeliverTxResponse>

getAccount

Returns SeiClientAccountData

getBalance

Parameters

Returns Promise<bigint>

getSupplyOf

Parameters

Returns Promise<bigint>

hasAccount

Returns this is { account: SeiClientAccountData; }

hasEthereum

Returns this is { ethereumClient: EthereumProvider; }

isAssociated

Returns Promise<boolean>

isEthereumOnly

`Readonly`account

`Readonly`chainId

`Protected`cometClient

`Readonly`cosmRegistry

`Readonly`ethereumClient

`Readonly`queryClient

`Readonly`readonlyReason

`Protected`signer

`Readonly`stargateClient

confirmed: {
timeoutMs?: number;
}

`Optional`timeoutMs?: number

confirmed: {
timeoutMs?: number;
}

`Optional`timeoutMs?: number

confirmed: {
timeoutMs?: number;
}

`Optional`timeoutMs?: number

Returns this is {
account: SeiClientAccountData;
}

Returns this is {
ethereumClient: EthereumProvider;
}

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

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

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

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

confirmed: {
timeoutMs?: number;
}

`Optional`timeoutMs?: number

`Static`get

`Static`getDefaultGasPrice

`Static`getDefaultProvider

`Static`nullifyDefaultProvider

`Static`setDefaultGasPrice

`Static`setDefaultProvider