Class SPLTokenProcessor

constructor

• new SPLTokenProcessor(options: SolanaBindOptions): SPLTokenProcessor

  Parameters

  • options: SolanaBindOptions

  Returns SPLTokenProcessor

fromParsedInstruction

onAmountToUiAmount

• onAmountToUiAmount(
      handler: (
          data: { amount: string | number; mint: String },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (data: { amount: string | number; mint: String }, ctx: SolanaContext) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onApprove

• onApprove(
      handler: (
          data: {
              amount: string | number;
              delegate: String;
              multisigOwner?: String;
              owner?: String;
              signers?: String[];
              source: String;
          },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: {
            amount: string | number;
            delegate: String;
            multisigOwner?: String;
            owner?: String;
            signers?: String[];
            source: String;
        },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onApproveChecked

• onApproveChecked(
      handler: (
          data: {
              delegate: String;
              mint: String;
              multisigOwner?: String;
              owner?: String;
              signers?: String[];
              source: String;
              tokenAmount: { amount: string; decimals: number; uiAmountString: string };
          },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: {
            delegate: String;
            mint: String;
            multisigOwner?: String;
            owner?: String;
            signers?: String[];
            source: String;
            tokenAmount: { amount: string; decimals: number; uiAmountString: string };
        },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onBurn

• onBurn(
      handler: (
          data: {
              account: String;
              amount: string | number;
              authority?: String;
              mint: String;
              multisigAuthority?: String;
              signers?: String[];
          },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: {
            account: String;
            amount: string | number;
            authority?: String;
            mint: String;
            multisigAuthority?: String;
            signers?: String[];
        },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onBurnChecked

• onBurnChecked(
      handler: (
          data: {
              account: String;
              authority?: String;
              mint: String;
              multisigAuthority?: String;
              signers?: String[];
              tokenAmount: { amount: string; decimals: number; uiAmountString: string };
          },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: {
            account: String;
            authority?: String;
            mint: String;
            multisigAuthority?: String;
            signers?: String[];
            tokenAmount: { amount: string; decimals: number; uiAmountString: string };
        },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onCloseAccount

• onCloseAccount(
      handler: (
          data: {
              account: String;
              destination: String;
              multisigOwner?: String;
              owner?: String;
              signers?: String[];
          },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: {
            account: String;
            destination: String;
            multisigOwner?: String;
            owner?: String;
            signers?: String[];
        },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onCreateNativeMint

• onCreateNativeMint(
      handler: (
          data: { nativeMint: String; payer: String; systemProgram: String },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: { nativeMint: String; payer: String; systemProgram: String },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onDefaultAccountStateExtension

• onDefaultAccountStateExtension(
      handler: (
          data: { accountState: string; freezeAuthority?: String; mint: String },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: { accountState: string; freezeAuthority?: String; mint: String },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onFreezeAccount

• onFreezeAccount(
      handler: (
          data: {
              account: String;
              freezeAuthority?: String;
              mint: String;
              multisigFreezeAuthority?: String;
              signers?: String[];
          },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: {
            account: String;
            freezeAuthority?: String;
            mint: String;
            multisigFreezeAuthority?: String;
            signers?: String[];
        },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onGetAccountDataSize

• onGetAccountDataSize(
      handler: (
          data: { extensionTypes?: string[]; mint: String },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (data: { extensionTypes?: string[]; mint: String }, ctx: SolanaContext) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onInitializeAccount

• onInitializeAccount(
      handler: (
          data: {
              account: String;
              mint: String;
              owner: String;
              rentSysvar: String;
          },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: {
            account: String;
            mint: String;
            owner: String;
            rentSysvar: String;
        },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onInitializeAccount2

• onInitializeAccount2(
      handler: (
          data: {
              account: String;
              mint: String;
              owner: String;
              rentSysvar: String;
          },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: {
            account: String;
            mint: String;
            owner: String;
            rentSysvar: String;
        },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onInitializeAccount3

• onInitializeAccount3(
      handler: (
          data: { account: String; mint: String; owner: String },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: { account: String; mint: String; owner: String },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onInitializeImmutableOwner

• onInitializeImmutableOwner(
      handler: (data: { account: String }, ctx: SolanaContext) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (data: { account: String }, ctx: SolanaContext) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onInitializeMint

• onInitializeMint(
      handler: (
          data: {
              decimals: number;
              freezeAuthority?: String;
              mint: String;
              mintAuthority: String;
              rentSysvar: String;
          },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: {
            decimals: number;
            freezeAuthority?: String;
            mint: String;
            mintAuthority: String;
            rentSysvar: String;
        },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onInitializeMintCloseAuthority

• onInitializeMintCloseAuthority(
      handler: (
          data: { mint: String; newAuthority: String },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (data: { mint: String; newAuthority: String }, ctx: SolanaContext) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onInitializeMultisig

• onInitializeMultisig(
      handler: (
          data: {
              m: number;
              multisig: String;
              rentSysvar: String;
              signers: String[];
          },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: {
            m: number;
            multisig: String;
            rentSysvar: String;
            signers: String[];
        },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onMemoTransferExtension

• onMemoTransferExtension(
      handler: (
          data: {
              account: String;
              multisigOwner?: String;
              owner?: String;
              signers?: String[];
          },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: {
            account: String;
            multisigOwner?: String;
            owner?: String;
            signers?: String[];
        },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onMintTo

• onMintTo(
      handler: (
          data: {
              account: String;
              amount: string | number;
              mint: String;
              mintAuthority?: String;
              multisigMintAuthority?: String;
              signers?: String[];
          },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: {
            account: String;
            amount: string | number;
            mint: String;
            mintAuthority?: String;
            multisigMintAuthority?: String;
            signers?: String[];
        },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onMintToChecked

• onMintToChecked(
      handler: (
          data: {
              account: String;
              mint: String;
              mintAuthority?: String;
              multisigMintAuthority?: String;
              signers?: String[];
              tokenAmount: { amount: string; decimals: number; uiAmountString: string };
          },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: {
            account: String;
            mint: String;
            mintAuthority?: String;
            multisigMintAuthority?: String;
            signers?: String[];
            tokenAmount: { amount: string; decimals: number; uiAmountString: string };
        },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onReallocate

• onReallocate(
      handler: (
          data: {
              account: String;
              extensionTypes: string[];
              payer: String;
              systemProgram: String;
          },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: {
            account: String;
            extensionTypes: string[];
            payer: String;
            systemProgram: String;
        },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onRevoke

• onRevoke(
      handler: (
          data: {
              multisigOwner?: String;
              owner?: String;
              signers?: String[];
              source: String;
          },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: {
            multisigOwner?: String;
            owner?: String;
            signers?: String[];
            source: String;
        },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onSetAuthority

• onSetAuthority(
      handler: (data: any, ctx: SolanaContext) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (data: any, ctx: SolanaContext) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onSyncNative

• onSyncNative(
      handler: (
          data: {
              account: String;
              authority?: String;
              mint: String;
              multisigAuthority?: String;
              signers?: String[];
              tokenAmount: { amount: string; decimals: number; uiAmountString: string };
          },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: {
            account: String;
            authority?: String;
            mint: String;
            multisigAuthority?: String;
            signers?: String[];
            tokenAmount: { amount: string; decimals: number; uiAmountString: string };
        },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onThawAccount

• onThawAccount(
      handler: (
          data: {
              account: String;
              freezeAuthority?: String;
              mint: String;
              multisigFreezeAuthority?: String;
              signers?: String[];
          },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: {
            account: String;
            freezeAuthority?: String;
            mint: String;
            multisigFreezeAuthority?: String;
            signers?: String[];
        },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onTransfer

• onTransfer(
      handler: (
          data: {
              amount: string | number;
              authority?: String;
              destination: String;
              multisigAuthority?: String;
              signers?: String[];
              source: String;
          },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: {
            amount: string | number;
            authority?: String;
            destination: String;
            multisigAuthority?: String;
            signers?: String[];
            source: String;
        },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onTransferChecked

• onTransferChecked(
      handler: (
          data: {
              authority?: String;
              destination: String;
              mint: String;
              multisigAuthority?: String;
              signers?: String[];
              source: String;
              tokenAmount: { amount: string; decimals: number; uiAmountString: string };
          },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: {
            authority?: String;
            destination: String;
            mint: String;
            multisigAuthority?: String;
            signers?: String[];
            source: String;
            tokenAmount: { amount: string; decimals: number; uiAmountString: string };
        },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onTransferFeeExtension

• onTransferFeeExtension(
      handler: (
          data: {
              maximumFee: number;
              mint: String;
              transferFeeBasisPoints: number;
              transferFeeConfigAuthority: String;
              withdrawWitheldAuthority: String;
          },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (
        data: {
            maximumFee: number;
            mint: String;
            transferFeeBasisPoints: number;
            transferFeeConfigAuthority: String;
            withdrawWitheldAuthority: String;
        },
        ctx: SolanaContext,
    ) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

onUiAmountToAmount

• onUiAmountToAmount(
      handler: (
          data: { mint: String; uiAmount: string },
          ctx: SolanaContext,
      ) => void,
      handlerOptions?: HandlerOptions<SolanaFetchConfig, Instruction>,
  ): SPLTokenProcessor

  Parameters

  • handler: (data: { mint: String; uiAmount: string }, ctx: SolanaContext) => void
  • OptionalhandlerOptions: HandlerOptions<SolanaFetchConfig, Instruction>

  Returns SPLTokenProcessor

Staticbind

• bind(options: SolanaBindOptions): SPLTokenProcessor

  For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.

  Parameters

  • options: SolanaBindOptions

  Returns SPLTokenProcessor