Class SolanaMintfxWithdrawService

constructor

• new SolanaMintfxWithdrawService(
      __namedParameters: {
          backofficeWalletQueryService: BackofficeWalletQueryService;
          solanaTokenMintAddressService: SolanaTokenMintAddressService;
      },
  ): SolanaMintfxWithdrawService

  Parameters

  • __namedParameters: {
        backofficeWalletQueryService: BackofficeWalletQueryService;
        solanaTokenMintAddressService: SolanaTokenMintAddressService;
    }

  Returns SolanaMintfxWithdrawService

Staticinstance

commitWithdrawalInstructions

• commitWithdrawalInstructions(
      __namedParameters: {
          idempotencyKey: string;
          skipTargetAtaCreate?: boolean;
          targets: { address?: Address; amount: BigNumber; owner?: Address }[];
          token: Token;
      },
  ): Promise<
      Instruction<
          string,
          readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[],
      >[],
  >

  Token transfer instruction and create ATA instructions (if required)

  Parameters

  • __namedParameters: {
        idempotencyKey: string;
        skipTargetAtaCreate?: boolean;
        targets: { address?: Address; amount: BigNumber; owner?: Address }[];
        token: Token;
    }

  Returns Promise<
      Instruction<
          string,
          readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[],
      >[],
  >

ledgerAccountTokenAccount

• ledgerAccountTokenAccount(
      __namedParameters: { ledgerAccountId: string; token: Token },
  ): Promise<Address>

  The token account of token the ledger account's mintfx PDA owns.

  Parameters

  • __namedParameters: { ledgerAccountId: string; token: Token }

  Returns Promise<Address>

voidWithdrawalInstructions

• voidWithdrawalInstructions(
      __namedParameters: {
          idempotencyKey: string;
          refund: { ledgerAccountId: string } | { owner: Address };
          token: Token;
      },
  ): Promise<
      Instruction<
          string,
          readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[],
      >[],
  >

  Refund a hold, to a ledger account or to a wallet CFX does not control.

  Parameters

  • __namedParameters: {
        idempotencyKey: string;
        refund: { ledgerAccountId: string } | { owner: Address };
        token: Token;
    }

  Returns Promise<
      Instruction<
          string,
          readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[],
      >[],
  >

withdrawExternalInstructions

• withdrawExternalInstructions(
      __namedParameters: {
          amount: number;
          idempotencyKey: string;
          sourceAuthority: Address;
          token: Token;
      },
  ): Promise<
      Instruction<
          string,
          readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[],
      >[],
  >

  Fund a hold from a wallet CFX does not control. sourceAuthority signs, so the transaction is built unsigned and returned to that wallet first.

  Parameters

  • __namedParameters: {
        amount: number;
        idempotencyKey: string;
        sourceAuthority: Address;
        token: Token;
    }

  Returns Promise<
      Instruction<
          string,
          readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[],
      >[],
  >

withdrawHasBeenCommitted

• withdrawHasBeenCommitted(
      __namedParameters: { idempotencyKey: string },
  ): Promise<{ executed: boolean; signature?: string }>

  Parameters

  • __namedParameters: { idempotencyKey: string }

  Returns Promise<{ executed: boolean; signature?: string }>

withdrawHasBeenSubmitted

• withdrawHasBeenSubmitted(
      __namedParameters: { idempotencyKey: string },
  ): Promise<{ executed: boolean; signature?: string }>

  Parameters

  • __namedParameters: { idempotencyKey: string }

  Returns Promise<{ executed: boolean; signature?: string }>

withdrawHasBeenVoided

• withdrawHasBeenVoided(
      __namedParameters: { idempotencyKey: string },
  ): Promise<{ executed: boolean; signature?: string }>

  Parameters

  • __namedParameters: { idempotencyKey: string }

  Returns Promise<{ executed: boolean; signature?: string }>

withdrawInstructions

• withdrawInstructions(
      __namedParameters: {
          amount: number;
          idempotencyKey: string;
          ledgerAccountId: string;
          token: Token;
      },
  ): Promise<
      Instruction<
          string,
          readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[],
      >[],
  >

  Token transfer instruction and create ATA instructions (if required)

  Parameters

  • __namedParameters: {
        amount: number;
        idempotencyKey: string;
        ledgerAccountId: string;
        token: Token;
    }

  Returns Promise<
      Instruction<
          string,
          readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[],
      >[],
  >

withdrawToOwnerInstructions

• withdrawToOwnerInstructions(
      __namedParameters: {
          amount: BigNumber;
          idempotencyKey: string;
          ledgerAccountId: string;
          owner: Address;
          token: Token;
      },
  ): Promise<
      Instruction<
          string,
          readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[],
      >[],
  >

  Move amount from a ledger account's PDA to owner's token account in one transaction: a withdrawal hold committed whole to that one target. Built without reading the chain, so it can precede the hold's existence. Build the transaction with cuLimit: WITHDRAW_TO_OWNER_CU_LIMIT.

  Parameters

  • __namedParameters: {
        amount: BigNumber;
        idempotencyKey: string;
        ledgerAccountId: string;
        owner: Address;
        token: Token;
    }

  Returns Promise<
      Instruction<
          string,
          readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[],
      >[],
  >