ZkgmClientRequest.ts

This module prepares cross-chain request submissions.

Added in v2.0.0

combinators

setDestination

Signature

export declare const setDestination: {
  (destination: Chain): (self: ZkgmClientRequest) => ZkgmClientRequest
  (self: ZkgmClientRequest, destination: Chain): ZkgmClientRequest
}

Source: src/ZkgmClientRequest.ts:84

Added in v2.0.0

setKind

Signature

export declare const setKind: {
  (kind: "execute" | "simulateAndExecute"): (self: ZkgmClientRequest) => ZkgmClientRequest
  (self: ZkgmClientRequest, kind: "execute" | "simulateAndExecute"): ZkgmClientRequest
}

Source: src/ZkgmClientRequest.ts:93

Added in v2.0.0

setSource

Signature

export declare const setSource: {
  (source: Chain): (self: ZkgmClientRequest) => ZkgmClientRequest
  (self: ZkgmClientRequest, source: Chain): ZkgmClientRequest
}

Source: src/ZkgmClientRequest.ts:75

Added in v2.0.0

constructors

make

Signature

export declare const make: (options: {
  source: Chain
  destination: Chain
  channelId: ChannelId
  ucs03Address: string
  instruction: ZkgmInstruction.ZkgmInstruction
  kind?: "execute" | "simulateAndExecute" | undefined
}) => ZkgmClientRequest

Source: src/ZkgmClientRequest.ts:62

Added in v2.0.0

models

Options (interface)

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
}

Source: src/ZkgmClientRequest.ts:49

Added in v2.0.0

ZkgmClientRequest (interface)

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"
}

Source: src/ZkgmClientRequest.ts:32

Added in v2.0.0

type ids

TypeId

Signature

export declare const TypeId: typeof TypeId

Source: src/ZkgmClientRequest.ts:20

Added in v2.0.0

TypeId (type alias)

Signature

export type TypeId = typeof TypeId

Source: src/ZkgmClientRequest.ts:26

Added in v2.0.0

utils

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:105

Added in v2.0.0