promises/Payment.ts

This module provides promise-based core functionality.

Added in v0.3.2

utils

createBatchPayment

Signature

export declare const createBatchPayment: (options: {
  payees: ReadonlyArray<payment.CreateBatchPaymentPayee>
  destinationChainId: UniversalChainId
}) => Promise<payment.CreateBatchPaymentResult[]>

Added in v0.4.0

generateKey

Signature

export declare const generateKey: () => Promise<PaymentKey>

Added in v0.4.0

generateProof

Signature

export declare const generateProof: (
  options: {
    destinationPublicClient: PublicClient.PublicClient
    sourcePublicClient: PublicClient.PublicClient
    publicClient: PublicClient.PublicClient
    prover: Prover.Prover
  } & {
    paymentKey: PaymentKey
    beneficiary: Erc20Address
    amount: bigint
    clientIds: number[]
    selectedClientId: number
    nullifier: Nullifier
    depositAddress: payment.DepositAddress
    srcChainId: UniversalChainId
    srcErc20Address: Erc20Address
    dstErc20Address: Erc20Address
  }
) => Promise<payment.Proof>

Added in v0.4.0

getDepositAddress

Signature

export declare const getDepositAddress: (options: {
  paymentKey: PaymentKey
  beneficiaries: ReadonlyArray<Erc20Address>
  destinationChainId: UniversalChainId
}) => Promise<{
  beneficiaries: [Erc20Address, Erc20Address, Erc20Address, Erc20Address]
  zAssetAddress: ZAssetAddress
  destinationChainId: string & Brand<"UniversalChainId">
}>

Added in v0.4.0

getNullifier

Signature

export declare const getNullifier: (options: {
  paymentKey: PaymentKey
  destinationChainId: UniversalChainId
}) => Promise<Nullifier>

Added in v0.4.0

prepareDeposit

Signature

export declare const prepareDeposit: (
  options: { sourceWalletClient: WalletClient.WalletClient } & payment.DepositOptions
) => Promise<
  readonly [
    {
      readonly _tag: "PreparedEvm"
      readonly kind: "Erc20.Approve" | "Erc20.Wrap" | "ZAsset.Transfer" | "LoopbackClient.Update"
      readonly universalChainId: UniversalChainId
      readonly contractAddress: Erc20Address
      readonly abi: Abi
      readonly functionName: string
      readonly args: ReadonlyArray<unknown>
    },
    ...{
      readonly _tag: "PreparedEvm"
      readonly kind: "Erc20.Approve" | "Erc20.Wrap" | "ZAsset.Transfer" | "LoopbackClient.Update"
      readonly universalChainId: UniversalChainId
      readonly contractAddress: Erc20Address
      readonly abi: Abi
      readonly functionName: string
      readonly args: ReadonlyArray<unknown>
    }[]
  ]
>

Added in v0.4.0

prepareRedemption

Signature

export declare const prepareRedemption: (
  options: { destinationWalletClient: WalletClient.WalletClient } & {
    universalChainId: UniversalChainId
    dstErc20Address: Erc20Address
    attestation: Attestation
    proof: payment.Proof
  }
) => Promise<{
  readonly _tag: "PreparedEvm"
  readonly kind: "Erc20.Approve" | "Erc20.Wrap" | "ZAsset.Transfer" | "LoopbackClient.Update"
  readonly universalChainId: UniversalChainId
  readonly contractAddress: Erc20Address
  readonly abi: Abi
  readonly functionName: string
  readonly args: ReadonlyArray<unknown>
}>

Added in v0.4.0