@lightprotocol/compressed-token 0.15.1 → 0.15.2

package/dist/types/index.d.ts

@@ -164,6 +164,106 @@ type LightCompressedToken = {
                 }
             ];
         },
+        {
+            name: 'compressSplTokenAccount';
+            accounts: [
+                {
+                    name: 'feePayer';
+                    isMut: true;
+                    isSigner: true;
+                    docs: ['UNCHECKED: only pays fees.'];
+                },
+                {
+                    name: 'authority';
+                    isMut: false;
+                    isSigner: true;
+                    docs: [
+                        'Authority is verified through proof since both owner and delegate',
+                        'are included in the token data hash, which is a public input to the',
+                        'validity proof.'
+                    ];
+                },
+                {
+                    name: 'cpiAuthorityPda';
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: 'lightSystemProgram';
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: 'registeredProgramPda';
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: 'noopProgram';
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: 'accountCompressionAuthority';
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: 'accountCompressionProgram';
+                    isMut: false;
+                    isSigner: false;
+                },
+                {
+                    name: 'selfProgram';
+                    isMut: false;
+                    isSigner: false;
+                    docs: ['this program is the signer of the cpi.'];
+                },
+                {
+                    name: 'tokenPoolPda';
+                    isMut: true;
+                    isSigner: false;
+                    isOptional: true;
+                },
+                {
+                    name: 'compressOrDecompressTokenAccount';
+                    isMut: true;
+                    isSigner: false;
+                    isOptional: true;
+                },
+                {
+                    name: 'tokenProgram';
+                    isMut: false;
+                    isSigner: false;
+                    isOptional: true;
+                },
+                {
+                    name: 'systemProgram';
+                    isMut: false;
+                    isSigner: false;
+                }
+            ];
+            args: [
+                {
+                    name: 'owner';
+                    type: 'publicKey';
+                },
+                {
+                    name: 'remainingAmount';
+                    type: {
+                        option: 'u64';
+                    };
+                },
+                {
+                    name: 'cpiContext';
+                    type: {
+                        option: {
+                            defined: 'CompressedCpiContext';
+                        };
+                    };
+                }
+            ];
+        },
         {
             name: 'transfer';
             docs: [
@@ -2031,6 +2131,32 @@ declare function createTransferOutputState(inputCompressedTokenAccounts: ParsedT
  *                                      instruction
  */
 declare function createDecompressOutputState(inputCompressedTokenAccounts: ParsedTokenAccount[], amount: number | BN): TokenTransferOutputData$1[];
+type CompressSplTokenAccountParams = {
+    /**
+     * Tx feepayer
+     */
+    feePayer: PublicKey;
+    /**
+     * Authority that owns the token account
+     */
+    authority: PublicKey;
+    /**
+     * Token account to compress
+     */
+    tokenAccount: PublicKey;
+    /**
+     * Mint public key
+     */
+    mint: PublicKey;
+    /**
+     * Optional: remaining amount to leave in token account. Default: 0
+     */
+    remainingAmount?: BN;
+    /**
+     * The state tree that the compressed token account should be inserted into.
+     */
+    outputStateTree: PublicKey;
+};
 declare class CompressedTokenProgram {
     /**
      * @internal
@@ -2090,6 +2216,7 @@ declare class CompressedTokenProgram {
      */
     static decompress(params: DecompressParams): Promise<TransactionInstruction>;
     static mergeTokenAccounts(params: MergeTokenAccountsParams): Promise<TransactionInstruction[]>;
+    static compressSplTokenAccount(params: CompressSplTokenAccountParams): Promise<TransactionInstruction>;
 }
 
 /**
@@ -2262,4 +2389,20 @@ declare function createTokenProgramLookupTable(rpc: Rpc, payer: Signer, authorit
     address: PublicKey;
 }>;
 
-export { type ApproveAndMintToParams, CPI_AUTHORITY_SEED, type CompressedTokenInstructionDataInvoke, CompressedTokenProgram, type CreateMintParams, type CreateTokenProgramLookupTableParams, 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, createDecompressOutputState, createMint, createTokenPool, createTokenProgramLookupTable, createTransferOutputState, decompress, mergeTokenAccounts, mintTo, packCompressedTokenAccounts, parseTokenData, selectMinCompressedTokenAccountsForTransfer, sumUpTokenAmount, transfer, validateSameTokenOwner };
+/**
+ * Compress SPL tokens into compressed token format
+ *
+ * @param rpc                   Rpc connection to use
+ * @param payer                 Payer of the transaction fees
+ * @param mint                  Mint of the token to compress
+ * @param owner                 Owner of the token account
+ * @param tokenAccount         Token account to compress
+ * @param outputStateTree       State tree to insert the compressed token account into
+ * @param remainingAmount      Optional: amount to leave in token account. Default: 0
+ * @param confirmOptions       Options for confirming the transaction
+ *
+ * @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>;
+
+export { type ApproveAndMintToParams, CPI_AUTHORITY_SEED, type CompressSplTokenAccountParams, type CompressedTokenInstructionDataInvoke, CompressedTokenProgram, type CreateMintParams, type CreateTokenProgramLookupTableParams, 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.1",
+  "version": "0.15.2",
   "description": "JS client to interact with the compressed-token program",
   "sideEffects": false,
   "main": "dist/cjs/node/index.cjs",
@@ -103,9 +103,10 @@
     "test:e2e:merge-token-accounts": "pnpm test-validator && vitest run tests/e2e/merge-token-accounts.test.ts --reporter=verbose",
     "test:e2e:transfer": "pnpm test-validator && vitest run tests/e2e/transfer.test.ts --reporter=verbose",
     "test:e2e:compress": "pnpm test-validator && vitest run tests/e2e/compress.test.ts --reporter=verbose",
+    "test:e2e:compress-spl-token-account": "pnpm test-validator && vitest run tests/e2e/compress-spl-token-account.test.ts --reporter=verbose",
     "test:e2e:decompress": "pnpm test-validator && vitest run tests/e2e/decompress.test.ts --reporter=verbose",
     "test:e2e:rpc-token-interop": "pnpm test-validator && vitest run tests/e2e/rpc-token-interop.test.ts --reporter=verbose",
-    "test:e2e:all": "pnpm test-validator && vitest run tests/e2e/create-mint.test.ts && vitest run tests/e2e/mint-to.test.ts && vitest run tests/e2e/transfer.test.ts && vitest run tests/e2e/compress.test.ts && vitest run tests/e2e/decompress.test.ts && vitest run tests/e2e/create-token-pool.test.ts && vitest run tests/e2e/approve-and-mint-to.test.ts && vitest run tests/e2e/rpc-token-interop.test.ts",
+    "test:e2e:all": "pnpm test-validator && vitest run tests/e2e/create-mint.test.ts && vitest run tests/e2e/mint-to.test.ts && vitest run tests/e2e/transfer.test.ts && vitest run tests/e2e/compress.test.ts && vitest run tests/e2e/compress-spl-token-account.test.ts && vitest run tests/e2e/decompress.test.ts && vitest run tests/e2e/create-token-pool.test.ts && vitest run tests/e2e/approve-and-mint-to.test.ts && vitest run tests/e2e/rpc-token-interop.test.ts",
     "pull-idl": "../../scripts/push-compressed-token-idl.sh",
     "build": "rimraf dist && pnpm pull-idl && pnpm build:bundle",
     "build:bundle": "rollup -c",