@lightprotocol/compressed-token 0.15.1 → 0.15.3

package/README.md

@@ -16,7 +16,6 @@
   <img src="https://img.shields.io/npm/dw/%40lightprotocol%2Fcompressed-token" alt="package weekly downloads" height="18" />
 </p>
 
-
 ### Installation
 
 **For use in Node.js or web**

package/dist/cjs/browser/index.cjs

@@ -166,6 +166,106 @@ const IDL = {
                 },
             ],
         },
+        {
+            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: [
@@ -6609,6 +6709,20 @@ class CompressedTokenProgram {
      * @internal
      */
     constructor() { }
+    /**
+     * 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.
+     */
+    static setProgramId(programId) {
+        this.programId =
+            typeof programId === 'string'
+                ? new web3_js.PublicKey(programId)
+                : programId;
+        // Reset program when programId changes
+        this._program = null;
+    }
     /** @internal */
     static get program() {
         if (!this._program) {
@@ -6967,6 +7081,36 @@ class CompressedTokenProgram {
         });
         return [ix];
     }
+    static async compressSplTokenAccount(params) {
+        const { feePayer, authority, tokenAccount, mint, remainingAmount, outputStateTree, } = params;
+        const remainingAccountMetas = [
+            {
+                pubkey: outputStateTree,
+                isSigner: false,
+                isWritable: true,
+            },
+        ];
+        const instruction = await this.program.methods
+            .compressSplTokenAccount(authority, remainingAmount !== null && remainingAmount !== void 0 ? remainingAmount : null, null)
+            .accounts({
+            feePayer,
+            authority,
+            cpiAuthorityPda: this.deriveCpiAuthorityPda,
+            lightSystemProgram: stateless_js.LightSystemProgram.programId,
+            registeredProgramPda: stateless_js.defaultStaticAccountsStruct().registeredProgramPda,
+            noopProgram: stateless_js.defaultStaticAccountsStruct().noopProgram,
+            accountCompressionAuthority: stateless_js.defaultStaticAccountsStruct().accountCompressionAuthority,
+            accountCompressionProgram: stateless_js.defaultStaticAccountsStruct().accountCompressionProgram,
+            selfProgram: this.programId,
+            tokenPoolPda: this.deriveTokenPoolPda(mint),
+            compressOrDecompressTokenAccount: tokenAccount,
+            tokenProgram: TOKEN_PROGRAM_ID,
+            systemProgram: web3_js.SystemProgram.programId,
+        })
+            .remainingAccounts(remainingAccountMetas)
+            .instruction();
+        return instruction;
+    }
 }
 /**
  * Public key that identifies the CompressedPda program
@@ -7326,6 +7470,41 @@ async function createTokenProgramLookupTable(rpc, payer, authority, mints, addit
     return { txIds: [txId, txId2], address };
 }
 
+/**
+ * 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
+ */
+async function compressSplTokenAccount(rpc, payer, mint, owner, tokenAccount, outputStateTree, remainingAmount, confirmOptions) {
+    const compressIx = await CompressedTokenProgram.compressSplTokenAccount({
+        feePayer: payer.publicKey,
+        authority: owner.publicKey,
+        tokenAccount,
+        mint,
+        remainingAmount,
+        outputStateTree,
+    });
+    const blockhashCtx = await rpc.getLatestBlockhash();
+    const additionalSigners = stateless_js.dedupeSigner(payer, [owner]);
+    const signedTx = stateless_js.buildAndSignTx([
+        web3_js.ComputeBudgetProgram.setComputeUnitLimit({
+            units: 1000000,
+        }),
+        compressIx,
+    ], payer, blockhashCtx.blockhash, additionalSigners);
+    const txId = await stateless_js.sendAndConfirmTx(rpc, signedTx, confirmOptions, blockhashCtx);
+    return txId;
+}
+
 exports.CPI_AUTHORITY_SEED = CPI_AUTHORITY_SEED;
 exports.CompressedTokenProgram = CompressedTokenProgram;
 exports.IDL = IDL;
@@ -7333,6 +7512,7 @@ exports.POOL_SEED = POOL_SEED;
 exports.SPL_TOKEN_MINT_RENT_EXEMPT_BALANCE = SPL_TOKEN_MINT_RENT_EXEMPT_BALANCE;
 exports.approveAndMintTo = approveAndMintTo;
 exports.compress = compress;
+exports.compressSplTokenAccount = compressSplTokenAccount;
 exports.createDecompressOutputState = createDecompressOutputState;
 exports.createMint = createMint;
 exports.createTokenPool = createTokenPool;