lfx-reward-back-sdk 0.1.0

package/dist/client.d.ts

@@ -0,0 +1,63 @@
+import * as web3 from '@solana/web3.js';
+/**
+ * Admin/Backoffice SDK for LFX Reward program.
+ *
+ * Responsibilities:
+ * - Provide admin instructions for configuring global state.
+ * - Provide helpers for deposit, withdrawal, and withdrawal wallet voting.
+ * - Provide read helpers for global info and withdrawal vote state.
+ */
+export declare class LfxRewardBackClient {
+    private connection;
+    private wallet;
+    private programId;
+    private idl;
+    constructor(connection: web3.Connection, wallet: web3.Keypair, _opts?: web3.ConfirmOptions);
+    getDiscriminator(instructionName: string): Buffer;
+    getGlobalInfoPDA(): [web3.PublicKey, number];
+    getVaultTokenAccountPDA(): [web3.PublicKey, number];
+    getWithdrawalVotePDA(): [web3.PublicKey, number];
+    /**
+     * Admin: init_global_info
+     *
+     * NOTE:
+     * - This instruction initializes global config and vault PDA.
+     * - It should be called only once.
+     */
+    initGlobalInfoIx(adminWallet: web3.PublicKey, apiWallet: web3.PublicKey, internalMultisigWallets: web3.PublicKey[], withdrawalWallet: web3.PublicKey, rewardTokenMint: web3.PublicKey): web3.TransactionInstruction;
+    /**
+     * Admin: deposit_tokens
+     *
+     * High-level helper that derives admin ATA and vault PDA automatically.
+     */
+    depositTokensIx(amount: bigint | number, mint: web3.PublicKey): Promise<web3.TransactionInstruction>;
+    /**
+     * Admin: update_global_info
+     *
+     * Update admin_wallet / api_wallet / internal_multisig_wallets / is_emergency.
+     * withdrawal_wallet cannot be changed here (must use on-chain voting).
+     */
+    updateGlobalInfoIx(adminWallet: web3.PublicKey | null, isEmergency: boolean | null, apiWallet: web3.PublicKey | null, internalMultisigWallets: web3.PublicKey[] | null): web3.TransactionInstruction;
+    /**
+     * Admin: withdraw_tokens
+     *
+     * Withdraw from vault to the configured withdrawal_wallet's ATA.
+     * Caller must pass the recipient ATA (for withdrawal_wallet).
+     */
+    withdrawTokensIx(recipientTokenAccount: web3.PublicKey, tokenMint: web3.PublicKey, amount: bigint | number): web3.TransactionInstruction;
+    /**
+     * Admin: start_withdrawal_vote
+     */
+    startWithdrawalVoteIx(proposedWithdrawalWallet: web3.PublicKey): web3.TransactionInstruction;
+    /**
+     * Admin/Multisig member: vote_withdrawal_wallet
+     *
+     * Voter must be one of internal_multisig_wallets in GlobalInfo.
+     */
+    voteWithdrawalWalletIx(voter: web3.PublicKey): web3.TransactionInstruction;
+    getGlobalInfo(commitment?: web3.Commitment): Promise<any | null>;
+    getWithdrawalVote(commitment?: web3.Commitment): Promise<any | null>;
+    getConnection(): web3.Connection;
+    getWallet(): web3.Keypair;
+    getProgramId(): web3.PublicKey;
+}

package/dist/client.js

@@ -0,0 +1,308 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LfxRewardBackClient = void 0;
+const web3 = __importStar(require("@solana/web3.js"));
+const lfx_reward_sc_json_1 = __importDefault(require("./idl/lfx_reward_sc.json"));
+const anchor_1 = require("@coral-xyz/anchor");
+const spl_token_1 = require("@solana/spl-token");
+/**
+ * Admin/Backoffice SDK for LFX Reward program.
+ *
+ * Responsibilities:
+ * - Provide admin instructions for configuring global state.
+ * - Provide helpers for deposit, withdrawal, and withdrawal wallet voting.
+ * - Provide read helpers for global info and withdrawal vote state.
+ */
+class LfxRewardBackClient {
+    constructor(connection, wallet, _opts) {
+        this.connection = connection;
+        this.wallet = wallet;
+        this.idl = lfx_reward_sc_json_1.default;
+        if (this.idl.address) {
+            this.programId = new web3.PublicKey(this.idl.address);
+        }
+        else {
+            throw new Error('Program ID not found in IDL');
+        }
+    }
+    // Helper to extract discriminator from IDL
+    getDiscriminator(instructionName) {
+        const ix = this.idl.instructions?.find((i) => i.name === instructionName);
+        if (ix?.discriminator) {
+            return Buffer.from(ix.discriminator);
+        }
+        throw new Error(`Instruction ${instructionName} not found in IDL`);
+    }
+    ////////////////////////////////////////////////////////////////////////
+    // PDA helpers
+    ////////////////////////////////////////////////////////////////////////
+    getGlobalInfoPDA() {
+        return web3.PublicKey.findProgramAddressSync([Buffer.from('global')], this.programId);
+    }
+    getVaultTokenAccountPDA() {
+        return web3.PublicKey.findProgramAddressSync([Buffer.from('vault')], this.programId);
+    }
+    getWithdrawalVotePDA() {
+        return web3.PublicKey.findProgramAddressSync([Buffer.from('withdrawal_vote')], this.programId);
+    }
+    ////////////////////////////////////////////////////////////////////////
+    // Admin instruction builders
+    ////////////////////////////////////////////////////////////////////////
+    /**
+     * Admin: init_global_info
+     *
+     * NOTE:
+     * - This instruction initializes global config and vault PDA.
+     * - It should be called only once.
+     */
+    initGlobalInfoIx(adminWallet, apiWallet, internalMultisigWallets, withdrawalWallet, rewardTokenMint) {
+        if (internalMultisigWallets.length !== 5) {
+            throw new Error('internalMultisigWallets must contain exactly 5 wallets');
+        }
+        const [globalInfoPda] = this.getGlobalInfoPDA();
+        const [vaultTokenAccountPda] = this.getVaultTokenAccountPDA();
+        const discriminator = this.getDiscriminator('init_global_info');
+        // Anchor args layout now contains only:
+        // admin_wallet, api_wallet, internal_multisig_wallets[5], withdrawal_wallet
+        const data = Buffer.concat([
+            discriminator,
+            adminWallet.toBuffer(),
+            apiWallet.toBuffer(),
+            Buffer.concat(internalMultisigWallets.map((w) => w.toBuffer())),
+            withdrawalWallet.toBuffer(),
+        ]);
+        return new web3.TransactionInstruction({
+            programId: this.programId,
+            keys: [
+                { pubkey: this.wallet.publicKey, isSigner: true, isWritable: true }, // init_wallet signer & payer
+                { pubkey: globalInfoPda, isSigner: false, isWritable: true }, // global_info
+                { pubkey: vaultTokenAccountPda, isSigner: false, isWritable: true }, // vault_token_account
+                { pubkey: rewardTokenMint, isSigner: false, isWritable: true }, // mint
+                { pubkey: spl_token_1.TOKEN_2022_PROGRAM_ID, isSigner: false, isWritable: false }, // token_program
+                { pubkey: web3.SystemProgram.programId, isSigner: false, isWritable: false }, // system_program
+            ],
+            data,
+        });
+    }
+    /**
+     * Admin: deposit_tokens
+     *
+     * High-level helper that derives admin ATA and vault PDA automatically.
+     */
+    async depositTokensIx(amount, mint) {
+        const [globalInfoPda] = this.getGlobalInfoPDA();
+        const [vaultTokenAccountPda] = this.getVaultTokenAccountPDA();
+        const adminTokenAccount = await (0, spl_token_1.getAssociatedTokenAddress)(mint, this.wallet.publicKey, false, spl_token_1.TOKEN_2022_PROGRAM_ID);
+        const discriminator = this.getDiscriminator('deposit_tokens');
+        const amountBig = typeof amount === 'bigint' ? amount : BigInt(amount);
+        const amountBuffer = Buffer.allocUnsafe(8);
+        amountBuffer.writeBigUInt64LE(amountBig, 0);
+        const data = Buffer.concat([discriminator, amountBuffer]);
+        return new web3.TransactionInstruction({
+            programId: this.programId,
+            keys: [
+                { pubkey: this.wallet.publicKey, isSigner: true, isWritable: false }, // admin
+                { pubkey: adminTokenAccount, isSigner: false, isWritable: true }, // admin_token_account
+                { pubkey: vaultTokenAccountPda, isSigner: false, isWritable: true }, // vault_token_account
+                { pubkey: mint, isSigner: false, isWritable: true }, // mint
+                { pubkey: globalInfoPda, isSigner: false, isWritable: true }, // global_info
+                { pubkey: spl_token_1.TOKEN_2022_PROGRAM_ID, isSigner: false, isWritable: false }, // token_program
+                { pubkey: web3.SystemProgram.programId, isSigner: false, isWritable: false }, // system_program
+            ],
+            data,
+        });
+    }
+    /**
+     * Admin: update_global_info
+     *
+     * Update admin_wallet / api_wallet / internal_multisig_wallets / is_emergency.
+     * withdrawal_wallet cannot be changed here (must use on-chain voting).
+     */
+    updateGlobalInfoIx(adminWallet, isEmergency, apiWallet, internalMultisigWallets) {
+        if (internalMultisigWallets !== null && internalMultisigWallets.length !== 5) {
+            throw new Error('internalMultisigWallets must contain exactly 5 wallets');
+        }
+        const [globalInfoPda] = this.getGlobalInfoPDA();
+        const discriminator = this.getDiscriminator('update_global_info');
+        let data = discriminator;
+        // admin_wallet: Option<Pubkey>
+        if (adminWallet !== null) {
+            data = Buffer.concat([data, Buffer.from([1]), adminWallet.toBuffer()]);
+        }
+        else {
+            data = Buffer.concat([data, Buffer.from([0])]);
+        }
+        // is_emergency: Option<bool>
+        if (isEmergency !== null) {
+            data = Buffer.concat([data, Buffer.from([1]), Buffer.from([isEmergency ? 1 : 0])]);
+        }
+        else {
+            data = Buffer.concat([data, Buffer.from([0])]);
+        }
+        // api_wallet: Option<Pubkey>
+        if (apiWallet !== null) {
+            data = Buffer.concat([data, Buffer.from([1]), apiWallet.toBuffer()]);
+        }
+        else {
+            data = Buffer.concat([data, Buffer.from([0])]);
+        }
+        // internal_multisig_wallets: Option<[Pubkey;5]>
+        if (internalMultisigWallets !== null) {
+            const buf = Buffer.concat(internalMultisigWallets.map((w) => w.toBuffer()));
+            data = Buffer.concat([data, Buffer.from([1]), buf]);
+        }
+        else {
+            data = Buffer.concat([data, Buffer.from([0])]);
+        }
+        return new web3.TransactionInstruction({
+            programId: this.programId,
+            keys: [
+                { pubkey: this.wallet.publicKey, isSigner: true, isWritable: false }, // admin
+                { pubkey: globalInfoPda, isSigner: false, isWritable: true }, // global_info
+            ],
+            data,
+        });
+    }
+    /**
+     * Admin: withdraw_tokens
+     *
+     * Withdraw from vault to the configured withdrawal_wallet's ATA.
+     * Caller must pass the recipient ATA (for withdrawal_wallet).
+     */
+    withdrawTokensIx(recipientTokenAccount, tokenMint, amount) {
+        const [globalInfoPda] = this.getGlobalInfoPDA();
+        const [vaultTokenAccountPda] = this.getVaultTokenAccountPDA();
+        const discriminator = this.getDiscriminator('withdraw_tokens');
+        const amountBig = typeof amount === 'bigint' ? amount : BigInt(amount);
+        const amountBuffer = Buffer.allocUnsafe(8);
+        amountBuffer.writeBigUInt64LE(amountBig, 0);
+        const data = Buffer.concat([discriminator, amountBuffer]);
+        return new web3.TransactionInstruction({
+            programId: this.programId,
+            keys: [
+                { pubkey: this.wallet.publicKey, isSigner: true, isWritable: false }, // admin
+                { pubkey: recipientTokenAccount, isSigner: false, isWritable: true }, // recipient_token_account
+                { pubkey: vaultTokenAccountPda, isSigner: false, isWritable: true }, // vault_token_account
+                { pubkey: tokenMint, isSigner: false, isWritable: true }, // mint
+                { pubkey: globalInfoPda, isSigner: false, isWritable: true }, // global_info
+                { pubkey: spl_token_1.TOKEN_2022_PROGRAM_ID, isSigner: false, isWritable: false }, // token_program
+                { pubkey: web3.SystemProgram.programId, isSigner: false, isWritable: false }, // system_program
+            ],
+            data,
+        });
+    }
+    /**
+     * Admin: start_withdrawal_vote
+     */
+    startWithdrawalVoteIx(proposedWithdrawalWallet) {
+        const [globalInfoPda] = this.getGlobalInfoPDA();
+        const [withdrawalVotePda] = this.getWithdrawalVotePDA();
+        const discriminator = this.getDiscriminator('start_withdrawal_vote');
+        const data = Buffer.concat([
+            discriminator,
+            proposedWithdrawalWallet.toBuffer(),
+        ]);
+        return new web3.TransactionInstruction({
+            programId: this.programId,
+            keys: [
+                { pubkey: this.wallet.publicKey, isSigner: true, isWritable: true }, // admin
+                { pubkey: globalInfoPda, isSigner: false, isWritable: true }, // global_info
+                { pubkey: withdrawalVotePda, isSigner: false, isWritable: true }, // withdrawal_vote
+                { pubkey: web3.SystemProgram.programId, isSigner: false, isWritable: false }, // system_program
+            ],
+            data,
+        });
+    }
+    /**
+     * Admin/Multisig member: vote_withdrawal_wallet
+     *
+     * Voter must be one of internal_multisig_wallets in GlobalInfo.
+     */
+    voteWithdrawalWalletIx(voter) {
+        const [globalInfoPda] = this.getGlobalInfoPDA();
+        const [withdrawalVotePda] = this.getWithdrawalVotePDA();
+        const discriminator = this.getDiscriminator('vote_withdrawal_wallet');
+        const data = discriminator;
+        return new web3.TransactionInstruction({
+            programId: this.programId,
+            keys: [
+                { pubkey: voter, isSigner: true, isWritable: false }, // voter
+                { pubkey: globalInfoPda, isSigner: false, isWritable: true }, // global_info
+                { pubkey: withdrawalVotePda, isSigner: false, isWritable: true }, // withdrawal_vote
+            ],
+            data,
+        });
+    }
+    ////////////////////////////////////////////////////////////////////////
+    // Read helpers
+    ////////////////////////////////////////////////////////////////////////
+    async getGlobalInfo(commitment) {
+        const [globalInfoPda] = this.getGlobalInfoPDA();
+        const accountInfo = await this.connection.getAccountInfo(globalInfoPda, commitment || 'processed');
+        if (!accountInfo) {
+            return null;
+        }
+        const coder = new anchor_1.BorshAccountsCoder(this.idl);
+        const globalInfo = coder.decode('GlobalInfo', accountInfo.data);
+        return globalInfo;
+    }
+    async getWithdrawalVote(commitment) {
+        const [votePda] = this.getWithdrawalVotePDA();
+        const accountInfo = await this.connection.getAccountInfo(votePda, commitment || 'processed');
+        if (!accountInfo) {
+            return null;
+        }
+        const coder = new anchor_1.BorshAccountsCoder(this.idl);
+        const vote = coder.decode('WithdrawalVote', accountInfo.data);
+        return vote;
+    }
+    ////////////////////////////////////////////////////////////////////////
+    // Getters
+    ////////////////////////////////////////////////////////////////////////
+    getConnection() {
+        return this.connection;
+    }
+    getWallet() {
+        return this.wallet;
+    }
+    getProgramId() {
+        return this.programId;
+    }
+}
+exports.LfxRewardBackClient = LfxRewardBackClient;