Class SolanaMintfxRedeemService

Interact with Solana Mintfx program and related components

This service is aware token mints and configuration

Index

Constructors

Methods

commitRedemptionInstructions redeemHasBeenCommitted redeemHasBeenSubmitted redeemHasBeenVoided redeemInstructions searchRedemptions voidRedemptionInstructions

Constructors

constructor

new SolanaMintfxRedeemService(
    __namedParameters: {
        mintfxEnv: MintfxEnv;
        rpcUrl: string;
        solanaBackofficeWalletService: SolanaBackofficeWalletService;
        solanaTokenMintAddressService: SolanaTokenMintAddressService;
    },
): SolanaMintfxRedeemService
Parameters
- __namedParameters: {
      mintfxEnv: MintfxEnv;
      rpcUrl: string;
      solanaBackofficeWalletService: SolanaBackofficeWalletService;
      solanaTokenMintAddressService: SolanaTokenMintAddressService;
  }
Returns SolanaMintfxRedeemService
- Defined in packages/solana-services/src/SolanaMintfxRedeemService.ts:33

Methods

commitRedemptionInstructions

commitRedemptionInstructions(
    __namedParameters: { idempotencyKey: string; token: Token },
): Promise<
    Instruction<
        string,
        readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[],
    >[],
>
Token transfer instruction and create ATA instructions (if required)
Parameters
- __namedParameters: { idempotencyKey: string; token: Token }
Returns Promise<
    Instruction<
        string,
        readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[],
    >[],
>
- Defined in packages/solana-services/src/SolanaMintfxRedeemService.ts:178

redeemHasBeenCommitted

redeemHasBeenCommitted(
__namedParameters: { idempotencyKey: string },
): Promise<{ executed: boolean; signature?: string }>
Parameters
- __namedParameters: { idempotencyKey: string }
Returns Promise<{ executed: boolean; signature?: string }>
- Defined in packages/solana-services/src/SolanaMintfxRedeemService.ts:67

redeemHasBeenSubmitted

redeemHasBeenSubmitted(
__namedParameters: { idempotencyKey: string },
): Promise<{ executed: boolean; signature?: string }>
Parameters
- __namedParameters: { idempotencyKey: string }
Returns Promise<{ executed: boolean; signature?: string }>
- Defined in packages/solana-services/src/SolanaMintfxRedeemService.ts:50

redeemHasBeenVoided

redeemHasBeenVoided(
__namedParameters: { idempotencyKey: string },
): Promise<{ executed: boolean; signature?: string }>
Parameters
- __namedParameters: { idempotencyKey: string }
Returns Promise<{ executed: boolean; signature?: string }>
- Defined in packages/solana-services/src/SolanaMintfxRedeemService.ts:84

redeemInstructions

redeemInstructions(
    __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>)[],
    >[],
>
- Defined in packages/solana-services/src/SolanaMintfxRedeemService.ts:137

searchRedemptions

searchRedemptions(): Promise<
    {
        address: string;
        amount: string;
        redeemer: string;
        stage: "submitted"
        | "committed"
        | "voided";
        tokenId: string;
        type: "Redemption";
    }[],
>
Fetch every idempotent redemption PDA owned by the mintfx program.

Returns Promise<
    {
        address: string;
        amount: string;
        redeemer: string;
        stage: "submitted"
        | "committed"
        | "voided";
        tokenId: string;
        type: "Redemption";
    }[],
>
- Defined in packages/solana-services/src/SolanaMintfxRedeemService.ts:104

voidRedemptionInstructions

voidRedemptionInstructions(
    __namedParameters: {
        idempotencyKey: string;
        refundLedgerAccountId: string;
        token: Token;
    },
): Promise<
    Instruction<
        string,
        readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[],
    >[],
>
Token transfer instruction and create ATA instructions (if required)
Parameters
- __namedParameters: { idempotencyKey: string; refundLedgerAccountId: string; token: Token }
Returns Promise<
    Instruction<
        string,
        readonly (AccountLookupMeta<string, string> | AccountMeta<string>)[],
    >[],
>
- Defined in packages/solana-services/src/SolanaMintfxRedeemService.ts:212

Class SolanaMintfxRedeemService

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SolanaMintfxRedeemService

Methods

commitRedemptionInstructions

Parameters

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

redeemHasBeenCommitted

Parameters

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

redeemHasBeenSubmitted

Parameters

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

redeemHasBeenVoided

Parameters

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

redeemInstructions

Parameters

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

searchRedemptions

Returns Promise<
    {
        address: string;
        amount: string;
        redeemer: string;
        stage: "submitted"
        | "committed"
        | "voided";
        tokenId: string;
        type: "Redemption";
    }[],
>

voidRedemptionInstructions

Parameters

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

Settings

On This Page

Class SolanaMintfxRedeemService

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SolanaMintfxRedeemService

Methods

commitRedemptionInstructions

Parameters

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

redeemHasBeenCommitted

Parameters

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

redeemHasBeenSubmitted

Parameters

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

redeemHasBeenVoided

Parameters

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

redeemInstructions

Parameters

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

searchRedemptions

Returns Promise< { address: string; amount: string; redeemer: string; stage: "submitted" | "committed" | "voided"; tokenId: string; type: "Redemption"; }[],>

voidRedemptionInstructions

Parameters

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

Settings

On This Page

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

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

Returns Promise<
{
address: string;
amount: string;
redeemer: string;
stage: "submitted"
| "committed"
| "voided";
tokenId: string;
type: "Redemption";
}[],
>

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