Class ZkSendLink

constructor

• new ZkSendLink(__namedParameters: ZkSendLinkOptions): ZkSendLink

  Parameters

  • __namedParameters: ZkSendLinkOptions

  Returns ZkSendLink

address

Optionalassets

OptionalbagObject

Optionalclaimed

OptionalclaimedBy

OptionalcreatorAddress

Optionalkeypair

claimAssets

• claimAssets(
      address: string,
      __namedParameters?:
          | { reclaim?: false; sign?: undefined }
          | { reclaim: true; sign: (transaction: Uint8Array) => Promise<string> },
  ): Promise<
      {
          $kind: "Transaction";
          FailedTransaction?: undefined;
          Transaction: SuiClientTypes.Transaction<{ effects: true }>;
      },
  >

  Parameters

  • address: string
  • __namedParameters:
        | { reclaim?: false; sign?: undefined }
        | { reclaim: true; sign: (transaction: Uint8Array) => Promise<string> } = {}

  Returns Promise<
      {
          $kind: "Transaction";
          FailedTransaction?: undefined;
          Transaction: SuiClientTypes.Transaction<{ effects: true }>;
      },
  >

createClaimTransaction

• createClaimTransaction(
      address: string,
      __namedParameters?: { reclaim?: boolean },
  ): Transaction

  Parameters

  • address: string
  • __namedParameters: { reclaim?: boolean } = {}

  Returns Transaction

createRegenerateTransaction

• createRegenerateTransaction(
      sender: string,
      options: Omit<ZkSendLinkBuilderOptions, "sender">,
  ): Promise<{ transaction: Transaction; url: string }>

  Parameters

  • sender: string
  • options: Omit<ZkSendLinkBuilderOptions, "sender">

  Returns Promise<{ transaction: Transaction; url: string }>

loadAssets

• loadAssets(
      options?: {
          loadAssets?: boolean;
          loadClaimedAssets?: boolean;
          transaction?: SuiClientTypes.TransactionResult<{}>;
      },
  ): Promise<void>

  Parameters

  • options: {
        loadAssets?: boolean;
        loadClaimedAssets?: boolean;
        transaction?: SuiClientTypes.TransactionResult<{}>;
    } = {}

  Returns Promise<void>

loadClaimedStatus

• loadClaimedStatus(): Promise<void>

  Returns Promise<void>

StaticfromAddress

• fromAddress(
      address: string,
      options: Omit<ZkSendLinkOptions, "keypair" | "address" | "isContractLink">,
  ): Promise<ZkSendLink>

  Parameters

  • address: string
  • options: Omit<ZkSendLinkOptions, "keypair" | "address" | "isContractLink">

  Returns Promise<ZkSendLink>

StaticfromUrl

• fromUrl(
      url: string,
      options: Omit<ZkSendLinkOptions, "keypair" | "address" | "isContractLink">,
  ): Promise<ZkSendLink>

  Parameters

  • url: string
  • options: Omit<ZkSendLinkOptions, "keypair" | "address" | "isContractLink">

  Returns Promise<ZkSendLink>