ZkgmClientRequest.ts
This module prepares cross-chain request submissions.
Added in v2.0.0
Signature
export declare const setDestination: { (destination: Chain): (self: ZkgmClientRequest) => ZkgmClientRequest (self: ZkgmClientRequest, destination: Chain): ZkgmClientRequest}Source: src/ZkgmClientRequest.ts:135
Added in v2.0.0
Signature
export declare const setKind: { (kind: "execute" | "simulateAndExecute"): (self: ZkgmClientRequest) => ZkgmClientRequest (self: ZkgmClientRequest, kind: "execute" | "simulateAndExecute"): ZkgmClientRequest}Source: src/ZkgmClientRequest.ts:144
Added in v2.0.0
Signature
export declare const setSource: { (source: Chain): (self: ZkgmClientRequest) => ZkgmClientRequest (self: ZkgmClientRequest, source: Chain): ZkgmClientRequest}Source: src/ZkgmClientRequest.ts:126
Added in v2.0.0
Signature
export declare const make: (options: { source: Chain destination: Chain channelId: ChannelId ucs03Address: string instruction: ZkgmInstruction.ZkgmInstruction kind?: "execute" | "simulateAndExecute" | undefined transport?: Transport.Params | undefined}) => ZkgmClientRequestSource: src/ZkgmClientRequest.ts:112
Added in v2.0.0
Signature
export interface Options { readonly source?: Chain | undefined readonly destination?: Chain | undefined readonly channelId: ChannelId readonly ucs03Address: string // XXX: narrow readonly instruction?: ZkgmInstruction.ZkgmInstruction | undefined readonly kind?: "execute" | "simulateAndExecute" | undefined /** NEW: optional, per-runtime parameters (non-breaking) */ readonly transport?: Transport.Params | undefined}Source: src/ZkgmClientRequest.ts:97
Added in v2.0.0
Signature
export interface ZkgmClientRequest extends Inspectable, Pipeable { readonly [TypeId]: TypeId readonly source: Chain readonly destination: Chain readonly channelId: ChannelId readonly ucs03Address: string readonly instruction: ZkgmInstruction.ZkgmInstruction /** * **NOTE:** only for EVM submission */ readonly kind: "execute" | "simulateAndExecute" /** NEW: optional, per-runtime parameters (non-breaking) */ readonly transport?: Transport.Params | undefined}Source: src/ZkgmClientRequest.ts:78
Added in v2.0.0
Signature
export declare const TypeId: typeof TypeIdSource: src/ZkgmClientRequest.ts:66
Added in v2.0.0
Signature
export type TypeId = typeof TypeIdSource: src/ZkgmClientRequest.ts:72
Added in v2.0.0
Added in v2.0.0
Cosmos client request params.
Signature
export interface Cosmos { readonly _?: never}Source: src/ZkgmClientRequest.ts:47
Added in v2.0.0
EVM client request params.
Signature
export interface Evm { readonly _?: never}Source: src/ZkgmClientRequest.ts:39
Added in v2.0.0
Common request params.
Signature
export interface Params { readonly sui?: Sui | undefined readonly evm?: Evm | undefined readonly cosmos?: Cosmos | undefined}Source: src/ZkgmClientRequest.ts:55
Added in v2.0.0
Sui client request params.
Signature
export interface Sui { readonly relayStoreId: string readonly vaultId: string readonly ibcStoreId: string /** One or more coins a user wants to spend. Keep array for multi-coin support. */ readonly coins: ReadonlyArray<{ /** e.g. "0x2::sui::SUI" or a custom coin type */ readonly typeArg: string /** Concrete coin object id(s) for spending */ readonly objectId: string }>}Source: src/ZkgmClientRequest.ts:22
Added in v2.0.0
Extracts from a {@link ZkgmClientRequest} any {@link Token.Any}s required for execution along each amount. NOTE: Amounts are reduced by summation such that the resulting array is {@link Token.Any}s deduplicated.
Signature
export declare const requiredFunds: ( self: ZkgmClientRequest) => Option.Option<NonEmptyReadonlyArray<readonly [token: Token.Any, amount: bigint]>>Source: src/ZkgmClientRequest.ts:156
Added in v2.0.0