@lightprotocol/compressed-token 0.15.4 → 0.17.0

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 import { CompressedProof, ParsedTokenAccount, TokenTransferOutputData as TokenTransferOutputData$1, InputTokenDataWithContext as InputTokenDataWithContext$1, Rpc } from '@lightprotocol/stateless.js';
-import { PublicKey, AccountMeta, TransactionInstruction, Signer, ConfirmOptions, TransactionSignature, Keypair } from '@solana/web3.js';
+import { PublicKey, AccountMeta, TransactionInstruction, Connection, Signer, ConfirmOptions, TransactionSignature, Keypair } from '@solana/web3.js';
 import { BN, Program } from '@coral-xyz/anchor';
 
 type LightCompressedToken = {
@@ -86,9 +86,6 @@ type LightCompressedToken = {
                     name: 'tokenPoolPda';
                     isMut: true;
                     isSigner: false;
-                    docs: [
-                        'account to a token account of a different mint will fail'
-                    ];
                 },
                 {
                     name: 'tokenProgram';
@@ -166,6 +163,11 @@ type LightCompressedToken = {
         },
         {
             name: 'compressSplTokenAccount';
+            docs: [
+                'Compresses the balance of an spl token account sub an optional remaining',
+                'amount. This instruction does not close the spl token account. To close',
+                'the account bundle a close spl account instruction in your transaction.'
+            ];
             accounts: [
                 {
                     name: 'feePayer';
@@ -1653,23 +1655,141 @@ type LightCompressedToken = {
     errors: [
         {
             code: 6000;
-            name: 'SignerCheckFailed';
-            msg: 'Signer check failed';
+            name: 'PublicKeyAmountMissmatch';
+            msg: 'public keys and amounts must be of same length';
         },
         {
             code: 6001;
-            name: 'CreateTransferInstructionFailed';
-            msg: 'Create transfer instruction failed';
+            name: 'ComputeInputSumFailed';
+            msg: 'ComputeInputSumFailed';
         },
         {
             code: 6002;
-            name: 'AccountNotFound';
-            msg: 'Account not found';
+            name: 'ComputeOutputSumFailed';
+            msg: 'ComputeOutputSumFailed';
         },
         {
             code: 6003;
-            name: 'SerializationError';
-            msg: 'Serialization error';
+            name: 'ComputeCompressSumFailed';
+            msg: 'ComputeCompressSumFailed';
+        },
+        {
+            code: 6004;
+            name: 'ComputeDecompressSumFailed';
+            msg: 'ComputeDecompressSumFailed';
+        },
+        {
+            code: 6005;
+            name: 'SumCheckFailed';
+            msg: 'SumCheckFailed';
+        },
+        {
+            code: 6006;
+            name: 'DecompressRecipientUndefinedForDecompress';
+            msg: 'DecompressRecipientUndefinedForDecompress';
+        },
+        {
+            code: 6007;
+            name: 'CompressedPdaUndefinedForDecompress';
+            msg: 'CompressedPdaUndefinedForDecompress';
+        },
+        {
+            code: 6008;
+            name: 'DeCompressAmountUndefinedForDecompress';
+            msg: 'DeCompressAmountUndefinedForDecompress';
+        },
+        {
+            code: 6009;
+            name: 'CompressedPdaUndefinedForCompress';
+            msg: 'CompressedPdaUndefinedForCompress';
+        },
+        {
+            code: 6010;
+            name: 'DeCompressAmountUndefinedForCompress';
+            msg: 'DeCompressAmountUndefinedForCompress';
+        },
+        {
+            code: 6011;
+            name: 'DelegateSignerCheckFailed';
+            msg: 'DelegateSignerCheckFailed';
+        },
+        {
+            code: 6012;
+            name: 'MintTooLarge';
+            msg: 'Minted amount greater than u64::MAX';
+        },
+        {
+            code: 6013;
+            name: 'SplTokenSupplyMismatch';
+            msg: 'SplTokenSupplyMismatch';
+        },
+        {
+            code: 6014;
+            name: 'HeapMemoryCheckFailed';
+            msg: 'HeapMemoryCheckFailed';
+        },
+        {
+            code: 6015;
+            name: 'InstructionNotCallable';
+            msg: 'The instruction is not callable';
+        },
+        {
+            code: 6016;
+            name: 'ArithmeticUnderflow';
+            msg: 'ArithmeticUnderflow';
+        },
+        {
+            code: 6017;
+            name: 'HashToFieldError';
+            msg: 'HashToFieldError';
+        },
+        {
+            code: 6018;
+            name: 'InvalidAuthorityMint';
+            msg: 'Expected the authority to be also a mint authority';
+        },
+        {
+            code: 6019;
+            name: 'InvalidFreezeAuthority';
+            msg: 'Provided authority is not the freeze authority';
+        },
+        {
+            code: 6020;
+            name: 'InvalidDelegateIndex';
+        },
+        {
+            code: 6021;
+            name: 'TokenPoolPdaUndefined';
+        },
+        {
+            code: 6022;
+            name: 'IsTokenPoolPda';
+            msg: 'Compress or decompress recipient is the same account as the token pool pda.';
+        },
+        {
+            code: 6023;
+            name: 'InvalidTokenPoolPda';
+        },
+        {
+            code: 6024;
+            name: 'NoInputTokenAccountsProvided';
+        },
+        {
+            code: 6025;
+            name: 'NoInputsProvided';
+        },
+        {
+            code: 6026;
+            name: 'MintHasNoFreezeAuthority';
+        },
+        {
+            code: 6027;
+            name: 'MintWithInvalidExtension';
+        },
+        {
+            code: 6028;
+            name: 'InsufficientTokenAccountBalance';
+            msg: 'The token account balance is less than the remaining amount.';
         }
     ];
 };
@@ -1871,6 +1991,10 @@ type CompressParams = {
      * public state tree if unspecified.
      */
     outputStateTree?: PublicKey;
+    /**
+     * Optional: The token program ID. Default: SPL Token Program ID
+     */
+    tokenProgramId?: PublicKey;
 };
 type CompressSplTokenAccountParams = {
     /**
@@ -1897,6 +2021,10 @@ type CompressSplTokenAccountParams = {
      * The state tree that the compressed token account should be inserted into.
      */
     outputStateTree: PublicKey;
+    /**
+     * Optional: The token program ID. Default: SPL Token Program ID
+     */
+    tokenProgramId?: PublicKey;
 };
 type DecompressParams = {
     /**
@@ -1930,6 +2058,10 @@ type DecompressParams = {
      * Defaults to a public state tree if unspecified.
      */
     outputStateTree?: PublicKey;
+    /**
+     * Optional: The token program ID. Default: SPL Token Program ID
+     */
+    tokenProgramId?: PublicKey;
 };
 type TransferParams = {
     /**
@@ -1994,6 +2126,14 @@ type CreateMintParams = {
      * lamport amount for mint account rent exemption
      */
     rentExemptBalance: number;
+    /**
+     * Optional: The token program ID. Default: SPL Token Program ID
+     */
+    tokenProgramId?: PublicKey;
+    /**
+     * Optional: Mint size to use, defaults to MINT_SIZE
+     */
+    mintSize?: number;
 };
 /**
  * Parameters for merging compressed token accounts
@@ -2057,6 +2197,10 @@ type MintToParams = {
      * tree if unspecified.
      */
     merkleTree?: PublicKey;
+    /**
+     * Optional: The token program ID. Default: SPL Token Program ID
+     */
+    tokenProgramId?: PublicKey;
 };
 /**
  * Register an existing SPL mint account to the compressed token program
@@ -2067,6 +2211,10 @@ type RegisterMintParams = {
     feePayer: PublicKey;
     /** Mint public key */
     mint: PublicKey;
+    /**
+     * Optional: The token program ID. Default: SPL Token Program ID
+     */
+    tokenProgramId?: PublicKey;
 };
 /**
  * Mint from existing SPL mint to compressed token accounts
@@ -2101,6 +2249,10 @@ type ApproveAndMintToParams = {
      * tree if unspecified.
      */
     merkleTree?: PublicKey;
+    /**
+     * Optional: The token program ID. Default: SPL Token Program ID
+     */
+    tokenProgramId?: PublicKey;
 };
 type CreateTokenProgramLookupTableParams = {
     /**
@@ -2199,7 +2351,7 @@ declare class CompressedTokenProgram {
      */
     static mintTo(params: MintToParams): Promise<TransactionInstruction>;
     /**
-     * Mint tokens from registed SPL mint account to a compressed account
+     * Mint tokens from registered SPL mint account to a compressed account
      */
     static approveAndMintTo(params: ApproveAndMintToParams): Promise<TransactionInstruction[]>;
     /**
@@ -2224,6 +2376,7 @@ declare class CompressedTokenProgram {
     static decompress(params: DecompressParams): Promise<TransactionInstruction>;
     static mergeTokenAccounts(params: MergeTokenAccountsParams): Promise<TransactionInstruction[]>;
     static compressSplTokenAccount(params: CompressSplTokenAccountParams): Promise<TransactionInstruction>;
+    static get_mint_program_id(mint: PublicKey, connection: Connection): Promise<PublicKey | undefined>;
 }
 
 /**
@@ -2241,7 +2394,7 @@ declare class CompressedTokenProgram {
  *
  * @return Signature of the confirmed transaction
  */
-declare function approveAndMintTo(rpc: Rpc, payer: Signer, mint: PublicKey, destination: PublicKey, authority: Signer, amount: number | BN, merkleTree?: PublicKey, confirmOptions?: ConfirmOptions): Promise<TransactionSignature>;
+declare function approveAndMintTo(rpc: Rpc, payer: Signer, mint: PublicKey, destination: PublicKey, authority: Signer, amount: number | BN, merkleTree?: PublicKey, confirmOptions?: ConfirmOptions, tokenProgramId?: PublicKey): Promise<TransactionSignature>;
 
 /**
  * Compress SPL tokens
@@ -2261,7 +2414,7 @@ declare function approveAndMintTo(rpc: Rpc, payer: Signer, mint: PublicKey, dest
  *
  * @return Signature of the confirmed transaction
  */
-declare function compress(rpc: Rpc, payer: Signer, mint: PublicKey, amount: number | BN | number[] | BN[], owner: Signer, sourceTokenAccount: PublicKey, toAddress: PublicKey | Array<PublicKey>, merkleTree?: PublicKey, confirmOptions?: ConfirmOptions): Promise<TransactionSignature>;
+declare function compress(rpc: Rpc, payer: Signer, mint: PublicKey, amount: number | BN | number[] | BN[], owner: Signer, sourceTokenAccount: PublicKey, toAddress: PublicKey | Array<PublicKey>, merkleTree?: PublicKey, confirmOptions?: ConfirmOptions, tokenProgramId?: PublicKey): Promise<TransactionSignature>;
 
 /**
  * Decompress compressed tokens
@@ -2281,7 +2434,7 @@ declare function compress(rpc: Rpc, payer: Signer, mint: PublicKey, amount: numb
  *
  * @return Signature of the confirmed transaction
  */
-declare function decompress(rpc: Rpc, payer: Signer, mint: PublicKey, amount: number | BN, owner: Signer, toAddress: PublicKey, merkleTree?: PublicKey, confirmOptions?: ConfirmOptions): Promise<TransactionSignature>;
+declare function decompress(rpc: Rpc, payer: Signer, mint: PublicKey, amount: number | BN, owner: Signer, toAddress: PublicKey, merkleTree?: PublicKey, confirmOptions?: ConfirmOptions, tokenProgramId?: PublicKey): Promise<TransactionSignature>;
 
 /**
  * Create and initialize a new compressed token mint
@@ -2292,10 +2445,11 @@ declare function decompress(rpc: Rpc, payer: Signer, mint: PublicKey, amount: nu
  * @param decimals        Location of the decimal place
  * @param keypair         Optional keypair, defaulting to a new random one
  * @param confirmOptions  Options for confirming the transaction
+ * @param isToken22       Whether to create a Token 2022 mint. Defaults to false.
  *
  * @return Address of the new mint and the transaction signature
  */
-declare function createMint(rpc: Rpc, payer: Signer, mintAuthority: PublicKey, decimals: number, keypair?: Keypair, confirmOptions?: ConfirmOptions): Promise<{
+declare function createMint(rpc: Rpc, payer: Signer, mintAuthority: PublicKey, decimals: number, keypair?: Keypair, confirmOptions?: ConfirmOptions, isToken22?: boolean): Promise<{
     mint: PublicKey;
     transactionSignature: TransactionSignature;
 }>;
@@ -2317,7 +2471,7 @@ declare function createMint(rpc: Rpc, payer: Signer, mintAuthority: PublicKey, d
  *
  * @return Signature of the confirmed transaction
  */
-declare function mintTo(rpc: Rpc, payer: Signer, mint: PublicKey, destination: PublicKey | PublicKey[], authority: Signer, amount: number | BN | number[] | BN[], merkleTree?: PublicKey, confirmOptions?: ConfirmOptions): Promise<TransactionSignature>;
+declare function mintTo(rpc: Rpc, payer: Signer, mint: PublicKey, destination: PublicKey | PublicKey[], authority: Signer, amount: number | BN | number[] | BN[], merkleTree?: PublicKey, confirmOptions?: ConfirmOptions, tokenProgramId?: PublicKey): Promise<TransactionSignature>;
 
 /**
  * Merge multiple compressed token accounts for a given mint into a single
@@ -2345,7 +2499,7 @@ declare function mergeTokenAccounts(rpc: Rpc, payer: Signer, mint: PublicKey, ow
  *
  * @return transaction signature
  */
-declare function createTokenPool(rpc: Rpc, payer: Signer, mintAddress: PublicKey, confirmOptions?: ConfirmOptions): Promise<TransactionSignature>;
+declare function createTokenPool(rpc: Rpc, payer: Signer, mint: PublicKey, confirmOptions?: ConfirmOptions, tokenProgramId?: PublicKey): Promise<TransactionSignature>;
 
 /**
  * Transfer compressed tokens from one owner to another
@@ -2410,6 +2564,6 @@ declare function createTokenProgramLookupTable(rpc: Rpc, payer: Signer, authorit
  *
  * @return Signature of the confirmed transaction
  */
-declare function compressSplTokenAccount(rpc: Rpc, payer: Signer, mint: PublicKey, owner: Signer, tokenAccount: PublicKey, outputStateTree: PublicKey, remainingAmount?: BN, confirmOptions?: ConfirmOptions): Promise<TransactionSignature>;
+declare function compressSplTokenAccount(rpc: Rpc, payer: Signer, mint: PublicKey, owner: Signer, tokenAccount: PublicKey, outputStateTree: PublicKey, remainingAmount?: BN, confirmOptions?: ConfirmOptions, tokenProgramId?: PublicKey): Promise<TransactionSignature>;
 
 export { type ApproveAndMintToParams, CPI_AUTHORITY_SEED, type CompressParams, type CompressSplTokenAccountParams, type CompressedTokenInstructionDataInvoke, CompressedTokenProgram, type CreateMintParams, type CreateTokenProgramLookupTableParams, type DecompressParams, IDL, type InputTokenDataWithContext, type LightCompressedToken, type MergeTokenAccountsParams, type MintToParams, POOL_SEED, type PackCompressedTokenAccountsParams, type PackedTokenTransferOutputData, type RegisterMintParams, SPL_TOKEN_MINT_RENT_EXEMPT_BALANCE, type TokenData, type TokenTransferOutputData, type TransferParams, approveAndMintTo, compress, compressSplTokenAccount, createDecompressOutputState, createMint, createTokenPool, createTokenProgramLookupTable, createTransferOutputState, decompress, mergeTokenAccounts, mintTo, packCompressedTokenAccounts, parseTokenData, selectMinCompressedTokenAccountsForTransfer, sumUpTokenAmount, transfer, validateSameTokenOwner };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightprotocol/compressed-token",
-  "version": "0.15.4",
+  "version": "0.17.0",
   "description": "JS client to interact with the compressed-token program",
   "sideEffects": false,
   "main": "dist/cjs/node/index.cjs",
@@ -36,14 +36,14 @@
   ],
   "license": "Apache-2.0",
   "peerDependencies": {
-    "@lightprotocol/stateless.js": "0.15.4"
+    "@lightprotocol/stateless.js": "0.17.0"
   },
   "dependencies": {
     "@coral-xyz/anchor": "0.29.0",
-    "@solana/web3.js": "^1.95.3",
-    "@solana/spl-token": "^0.4.8",
-    "buffer": "^6.0.3",
-    "tweetnacl": "^1.0.3"
+    "@solana/web3.js": "1.95.3",
+    "@solana/spl-token": "0.4.8",
+    "buffer": "6.0.3",
+    "tweetnacl": "1.0.3"
   },
   "devDependencies": {
     "@esbuild-plugins/node-globals-polyfill": "^0.2.3",