Class CompressedTokenProgram

StaticprogramId

StaticsetProgramId

• setProgramId(programId: string | PublicKey): void

  Set a custom programId via PublicKey or base58 encoded string. This method is not required for regular usage.

  Use this only if you know what you are doing.

  Parameters

  • programId: string | PublicKey

  Returns void

StaticderiveSplInterfacePda

• deriveSplInterfacePda(mint: PublicKey): PublicKey

  Derive the SPL interface PDA. To derive the SPL interface PDA with bump, use deriveSplInterfacePdaWithIndex.

  Parameters

  • mint: PublicKey

    The mint of the SPL interface

  Returns PublicKey

  The SPL interface PDA

StaticderiveTokenPoolPda

• deriveTokenPoolPda(mint: PublicKey): PublicKey

  Parameters

  • mint: PublicKey

  Returns PublicKey

  Deprecated

  Use deriveSplInterfacePda instead.

StaticfindSplInterfaceIndexAndBump

• findSplInterfaceIndexAndBump(
      poolPda: PublicKey,
      mint: PublicKey,
  ): [number, number]

  Find the index and bump for a given SPL interface PDA and mint.

  Parameters

  • poolPda: PublicKey

    The SPL interface PDA to find the index and bump for

  • mint: PublicKey

    The mint of the SPL interface

  Returns [number, number]

  The index and bump number.

StaticfindTokenPoolIndexAndBump

• findTokenPoolIndexAndBump(poolPda: PublicKey, mint: PublicKey): [number, number]

  Parameters

  • poolPda: PublicKey
  • mint: PublicKey

  Returns [number, number]

  Deprecated

  Use findSplInterfaceIndexAndBump instead.

StaticderiveSplInterfacePdaWithIndex

• deriveSplInterfacePdaWithIndex(
      mint: PublicKey,
      index: number,
  ): [PublicKey, number]

  Derive the SPL interface PDA with index.

  Parameters

  • mint: PublicKey

    The mint of the SPL interface

  • index: number

    Index. starts at 0. The Protocol supports 4 indexes aka SPL interfaces per mint.

  Returns [PublicKey, number]

  The SPL interface PDA and bump.

StaticderiveTokenPoolPdaWithIndex

• deriveTokenPoolPdaWithIndex(mint: PublicKey, index: number): [PublicKey, number]

  Parameters

  • mint: PublicKey
  • index: number

  Returns [PublicKey, number]

  Deprecated

  Use deriveSplInterfacePdaWithIndex instead.

StaticcreateMint

• createMint(feePayer: CreateMintParams): Promise<TransactionInstruction[]>

  Construct createMint instruction for SPL tokens.

  Parameters

  • feePayer: CreateMintParams

    Fee payer.

  Returns Promise<TransactionInstruction[]>

  [createMintAccountInstruction, initializeMintInstruction, createSplInterfaceInstruction]

  Note that createSplInterfaceInstruction must be executed after initializeMintInstruction.

StaticcreateSplInterface

• createSplInterface(
      feePayer: CreateSplInterfaceParams,
  ): Promise<TransactionInstruction>

  Create SPL interface (omnibus account) for an existing SPL mint. For new mints, use CompressedTokenProgram.createMint.

  Parameters

  • feePayer: CreateSplInterfaceParams

    Fee payer.

  Returns Promise<TransactionInstruction>

  The createSplInterface instruction

StaticcreateTokenPool

• createTokenPool(
      params: CreateSplInterfaceParams,
  ): Promise<TransactionInstruction>

  Parameters

  • params: CreateSplInterfaceParams

  Returns Promise<TransactionInstruction>

  Deprecated

  Use createSplInterface instead.

StaticaddTokenPool

• addTokenPool(feePayer: AddSplInterfaceParams): Promise<TransactionInstruction>

  Add a token pool to an existing SPL mint. For new mints, use createSplInterface.

  Parameters

  • feePayer: AddSplInterfaceParams

    Fee payer.

  Returns Promise<TransactionInstruction>

  The addTokenPool instruction

StaticmintTo

• mintTo(feePayer: MintToParams): Promise<TransactionInstruction>

  Construct mintTo instruction for compressed tokens

  Parameters

  • feePayer: MintToParams

    Fee payer.

  Returns Promise<TransactionInstruction>

  The mintTo instruction

StaticapproveAndMintTo

• approveAndMintTo(
      feePayer: ApproveAndMintToParams,
  ): Promise<TransactionInstruction[]>

  Mint tokens from registered SPL mint account to a compressed account

  Parameters

  • feePayer: ApproveAndMintToParams

    Fee payer.

  Returns Promise<TransactionInstruction[]>

  The mintTo instruction

Statictransfer

• transfer(payer: TransferParams): Promise<TransactionInstruction>

  Construct transfer instruction for compressed tokens.

  V1 inputs automatically migrate to V2 outputs when in V2 mode.

  Parameters

  • payer: TransferParams

    Fee payer.

  Returns Promise<TransactionInstruction>

  The transfer instruction

StaticcreateTokenProgramLookupTable

• createTokenProgramLookupTable(
      payer: CreateTokenProgramLookupTableParams,
  ): Promise<{ instructions: TransactionInstruction[]; address: PublicKey }>

  Create lookup table instructions for the token program's default accounts.

  Parameters

  • payer: CreateTokenProgramLookupTableParams

    Fee payer.

  Returns Promise<{ instructions: TransactionInstruction[]; address: PublicKey }>

  [createInstruction, extendInstruction, option(extendInstruction2)]

Staticcompress

• compress(payer: CompressParams): Promise<TransactionInstruction>

  Create compress instruction

  Parameters

  • payer: CompressParams

    Fee payer.

  Returns Promise<TransactionInstruction>

  The compress instruction

Staticdecompress

• decompress(payer: DecompressParams): Promise<TransactionInstruction>

  Construct decompress instruction

  Parameters

  • payer: DecompressParams

    Fee payer.

  Returns Promise<TransactionInstruction>

  The decompress instruction

StaticmergeTokenAccounts

• mergeTokenAccounts(
      payer: MergeTokenAccountsParams,
  ): Promise<TransactionInstruction[]>

  Create mergeTokenAccounts instruction.

  Parameters

  • payer: MergeTokenAccountsParams

    Fee payer.

  Returns Promise<TransactionInstruction[]>

  instruction

StaticcompressSplTokenAccount

• compressSplTokenAccount(
      feePayer: CompressSplTokenAccountParams,
  ): Promise<TransactionInstruction>

  Create compressSplTokenAccount instruction

  Parameters

  • feePayer: CompressSplTokenAccountParams

    Fee payer.

  Returns Promise<TransactionInstruction>

  instruction

StaticgetMintProgramId

• getMintProgramId(
      mint: PublicKey,
      connection: Connection,
  ): Promise<PublicKey | undefined>

  Get the program ID for a mint

  Parameters

  • mint: PublicKey

    SPL Token mint address.

  • connection: Connection

    Connection.

  Returns Promise<PublicKey | undefined>

  program ID

Staticapprove

• approve(payer: ApproveParams): Promise<TransactionInstruction>

  Create approve instruction to delegate compressed tokens.

  Parameters

  • payer: ApproveParams

    Fee payer.

  Returns Promise<TransactionInstruction>

  instruction

Staticrevoke

• revoke(payer: RevokeParams): Promise<TransactionInstruction>

  Create revoke instruction to revoke delegation of compressed tokens.

  Parameters

  • payer: RevokeParams

    Fee payer.

  Returns Promise<TransactionInstruction>

  instruction