@zebec-network/solana-payroll-sdk 2.6.0-dev.2 → 2.7.0

package/LICENSE

@@ -1,9 +1,9 @@
-# The MIT License (MIT)
-
-Copyright © 2025 Zebec Network
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# The MIT License (MIT)
+
+Copyright © 2025 Zebec Network
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/instructions.d.ts

@@ -141,9 +141,6 @@ export declare function createCompleteUnlockInstruction(program: Program<ZebecPa
     companyTokenAta: PublicKey;
     depositMint: PublicKey;
     centralVault: PublicKey;
-    centralVaultUsxAta: PublicKey;
-    usxMint: PublicKey;
-    companyUsxAta: PublicKey;
 }, data: {
     companyId: number[];
     nonce: BN;
@@ -160,6 +157,19 @@ export declare function createDistributeRewardsInstruction(program: Program<Zebe
     }[];
     checkId: number[];
 }, remainingAccounts: AccountMeta[]): Promise<TransactionInstruction>;
+export declare function createWithdrawRewardsInstruction(program: Program<ZebecPayrollIdl>, accounts: {
+    admin: PublicKey;
+    centralVault: PublicKey;
+    company: PublicKey;
+    companyDeposit: PublicKey;
+    yieldConfig: PublicKey;
+    centralVaultUsxAta: PublicKey;
+    companyUsxAta: PublicKey;
+    usxMint: PublicKey;
+}, data: {
+    companyId: number[];
+    nonce: BN;
+}): Promise<TransactionInstruction>;
 export declare function createCreateCardInstruction(payrollProgram: Program<ZebecPayrollIdl>, accounts: {
     cardPurchasePda: PublicKey;
     cardVault: PublicKey;

package/dist/instructions.js

@@ -184,9 +184,6 @@ export async function createCompleteUnlockInstruction(program, accounts, data) {
         companyTokenAta: accounts.companyTokenAta,
         depositMint: accounts.depositMint,
         centralVault: accounts.centralVault,
-        centralVaultUsxAta: accounts.centralVaultUsxAta,
-        usxMint: accounts.usxMint,
-        companyUsxAta: accounts.companyUsxAta,
     })
         .instruction();
 }
@@ -201,6 +198,21 @@ export async function createDistributeRewardsInstruction(program, accounts, data
         .remainingAccounts(remainingAccounts)
         .instruction();
 }
+export async function createWithdrawRewardsInstruction(program, accounts, data) {
+    return program.methods
+        .withdrawRewards(data.companyId, data.nonce)
+        .accountsPartial({
+        admin: accounts.admin,
+        centralVault: accounts.centralVault,
+        company: accounts.company,
+        companyDeposit: accounts.companyDeposit,
+        yieldConfig: accounts.yieldConfig,
+        centralVaultUsxAta: accounts.centralVaultUsxAta,
+        companyUsxAta: accounts.companyUsxAta,
+        usxMint: accounts.usxMint,
+    })
+        .instruction();
+}
 export async function createCreateCardInstruction(payrollProgram, accounts, data) {
     return payrollProgram.methods
         .enterpriseCreateCard({

package/dist/services.d.ts

@@ -3,7 +3,7 @@ import { type Commitment } from "@solana/web3.js";
 import { MultiTransactionPayload, TransactionPayload } from "@zebec-network/solana-common";
 import type { ZebecConfigs as ZebecConfigsIdl } from "@zebec-network/zebec_configs";
 import type { ZebecPayroll as ZebecPayrollIdl } from "@zebec-network/zebec_payroll";
-import type { CancelMultiplePayrollParams, CancelPayrollParams, CancelUnlockParams, CardPurchaseInfo, ChangePayrollReceiverParams, CompanyDepositInfo, CompanyNonceInfo, CompleteUnlockParams, CreateCardParams, CreateMultiplePayrollParams, CreatePayrollParams, DistributeRewardsParams, PauseResumeMultiplePayrollParams, PauseResumePayrollParams, PayrollConfigInfo, PayrollMetadataInfo, RequestUnlockParams, SetMultipleTopupDelegateParams, SetTopupDelegateParams, SwapAndCreateCardParams, TokenMetadata, TopupMultiplePayrollParams, TopupPayrollParams, UserPurchaseRecordInfo, WithdrawMultiplePayrollParams, WithdrawPayrollParams, YieldDepositParams } from "./types.js";
+import type { CancelMultiplePayrollParams, CancelPayrollParams, CancelUnlockParams, CardPurchaseInfo, ChangePayrollReceiverParams, CompanyDepositInfo, CompanyNonceInfo, CompleteUnlockParams, CreateCardParams, CreateMultiplePayrollParams, CreatePayrollParams, DistributeRewardsParams, PauseResumeMultiplePayrollParams, PauseResumePayrollParams, PayrollConfigInfo, PayrollMetadataInfo, RequestUnlockParams, SetMultipleTopupDelegateParams, SetTopupDelegateParams, SwapAndCreateCardParams, TokenMetadata, TopupMultiplePayrollParams, TopupPayrollParams, UserPurchaseRecordInfo, WithdrawMultiplePayrollParams, WithdrawPayrollParams, WithdrawRewardsParams, YieldDepositParams } from "./types.js";
 export declare function getPayrollConfig(configProgram: Program<ZebecConfigsIdl>, configName: string): Promise<PayrollConfigInfo>;
 export declare function getWhitelistedTokens(configProgram: Program<ZebecConfigsIdl>, configName: string, commitment?: "processed" | "confirmed" | "finalized"): Promise<TokenMetadata[]>;
 export declare function getPayrollMetadataInfo(program: Program<ZebecPayrollIdl>, payrollMetadata: Address, commitment?: Commitment): Promise<PayrollMetadataInfo>;
@@ -26,6 +26,7 @@ export declare function requestUnlock(payrollProgram: Program<ZebecPayrollIdl>,
 export declare function cancelUnlock(payrollProgram: Program<ZebecPayrollIdl>, params: CancelUnlockParams): Promise<TransactionPayload>;
 export declare function completeUnlock(payrollProgram: Program<ZebecPayrollIdl>, configsProgram: Program<ZebecConfigsIdl>, params: CompleteUnlockParams, commitment?: Commitment): Promise<TransactionPayload>;
 export declare function distributeRewards(payrollProgram: Program<ZebecPayrollIdl>, configsProgram: Program<ZebecConfigsIdl>, params: DistributeRewardsParams): Promise<TransactionPayload>;
+export declare function withdrawRewards(payrollProgram: Program<ZebecPayrollIdl>, configsProgram: Program<ZebecConfigsIdl>, params: WithdrawRewardsParams, commitment?: Commitment): Promise<TransactionPayload>;
 export declare function getCompanyDeposit(payrollProgram: Program<ZebecPayrollIdl>, company: Address): Promise<CompanyDepositInfo | null>;
 export declare function createCard(payrollProgram: Program<ZebecPayrollIdl>, configsProgram: Program<ZebecConfigsIdl>, params: CreateCardParams): Promise<TransactionPayload>;
 export declare function swapAndCreateCard(payrollProgram: Program<ZebecPayrollIdl>, configsProgram: Program<ZebecConfigsIdl>, params: SwapAndCreateCardParams): Promise<TransactionPayload>;

package/dist/services.js

@@ -9,7 +9,7 @@ import { createAssociatedTokenAccountInstruction, getAssociatedTokenAddressSync,
 import { BigNumber } from "bignumber.js";
 import { BN } from "bn.js";
 import { CARD_LOOKUP_TABLE_ADDRESS, ED25519_SIGNATURE_SIZE, JUPITER_AGGREGATOR_PROGRAM_ID, JUPITER_SWAP_API, PAYROLL_NAME_BUFFER_SIZE, PAYROLL_TOKEN_PRICE_MESSAGE_SIZE, USX_DECIMALS, } from "./constants.js";
-import { createCancelPayrollInstruction, createCancelUnlockInstruction, createChangeRecipientInstruction, createCompleteUnlockInstruction, createCreateCardInstruction, createCreatePayrollInstruction, createDistributeRewardsInstruction, createPauseResumePayrollInstruction, createRequestUnlockInstruction, createSetTopupDelegateInstruction, createSwapAndCreateCardInstruction, createTopupPayrollInstruction, createWithdrawPayrollInstruction, createYieldDepositInstruction, } from "./instructions.js";
+import { createCancelPayrollInstruction, createCancelUnlockInstruction, createChangeRecipientInstruction, createCompleteUnlockInstruction, createCreateCardInstruction, createCreatePayrollInstruction, createDistributeRewardsInstruction, createPauseResumePayrollInstruction, createRequestUnlockInstruction, createSetTopupDelegateInstruction, createSwapAndCreateCardInstruction, createTopupPayrollInstruction, createWithdrawPayrollInstruction, createWithdrawRewardsInstruction, createYieldDepositInstruction, } from "./instructions.js";
 import { deriveCheckAccountPda, deriveCompanyDepositPda, deriveCompanyNoncePda, deriveEnterpriseCardConfigPda, deriveEnterpriseCardIndexPda, deriveEnterpriseCardPurchasePda, deriveEnterpriseUserPurchaseRecordPda, derivePayrollConfigPda, derivePayrollVaultPda, deriveYieldConfigPda, } from "./pda.js";
 import { deductFeeFromAmount, getConnectionFromProgram, 
 // getFeeInfoForPayroll,
@@ -761,7 +761,6 @@ export async function completeUnlock(payrollProgram, configsProgram, params, com
     }
     const admin = configData.admin;
     const centralVault = configData.centralVault;
-    const usxMint = configData.usxMint;
     if (params.companyVaultKeypair &&
         !centralVault.equals(params.companyVaultKeypair.publicKey)) {
         throw new Error("Given keypair is not of companyVault");
@@ -773,9 +772,7 @@ export async function completeUnlock(payrollProgram, configsProgram, params, com
     }
     const depositMint = companyDepositData.depositMint;
     const centralVaultTokenAta = getAssociatedTokenAddressSync(depositMint, centralVault, true);
-    const centralVaultUsxAta = getAssociatedTokenAddressSync(usxMint, centralVault, true);
     const companyTokenAta = getAssociatedTokenAddressSync(depositMint, company, true);
-    const companyUsxAta = getAssociatedTokenAddressSync(usxMint, company, true);
     const ix = await createCompleteUnlockInstruction(payrollProgram, {
         admin,
         feePayer,
@@ -784,11 +781,8 @@ export async function completeUnlock(payrollProgram, configsProgram, params, com
         yieldConfig,
         centralVault,
         centralVaultTokenAta,
-        centralVaultUsxAta,
         companyTokenAta,
-        companyUsxAta,
         depositMint,
-        usxMint,
     }, {
         companyId: Array.from(params.companyId),
         nonce: new BN(params.nonce.toString()),
@@ -826,6 +820,42 @@ export async function distributeRewards(payrollProgram, configsProgram, params)
     }, remainingAccounts);
     return createTransactionPayload(payrollProgram, feePayer, [ix]);
 }
+export async function withdrawRewards(payrollProgram, configsProgram, params, commitment) {
+    commitment = commitment ?? payrollProgram.provider.connection.commitment;
+    const company = translateAddress(params.company);
+    const feePayer = params.feePayer
+        ? translateAddress(params.feePayer)
+        : company;
+    const [yieldConfig] = deriveYieldConfigPda(configsProgram.programId);
+    const configData = await configsProgram.account.yieldConfig.fetchNullable(yieldConfig, commitment);
+    if (!configData) {
+        throw new Error("Yield config is not initialized in Zebec Configs Program");
+    }
+    const admin = params.admin
+        ? translateAddress(params.admin)
+        : configData.admin;
+    const centralVault = params.centralVault
+        ? translateAddress(params.centralVault)
+        : configData.centralVault;
+    const usxMint = configData.usxMint;
+    const [companyDeposit] = deriveCompanyDepositPda(Buffer.from(params.companyId), params.nonce, payrollProgram.programId);
+    const centralVaultUsxAta = getAssociatedTokenAddressSync(usxMint, centralVault, true);
+    const companyUsxAta = getAssociatedTokenAddressSync(usxMint, company, true);
+    const ix = await createWithdrawRewardsInstruction(payrollProgram, {
+        admin,
+        centralVault,
+        company,
+        companyDeposit,
+        yieldConfig,
+        centralVaultUsxAta,
+        companyUsxAta,
+        usxMint,
+    }, {
+        companyId: Array.from(params.companyId),
+        nonce: new BN(params.nonce.toString()),
+    });
+    return createTransactionPayload(payrollProgram, feePayer, [ix]);
+}
 export async function getCompanyDeposit(payrollProgram, company) {
     const data = await payrollProgram.account.companyDeposit.fetch(translateAddress(company));
     if (!data) {

package/dist/types.d.ts

@@ -231,6 +231,14 @@ export type CompleteUnlockParams = {
     nonce: bigint;
     companyVaultKeypair?: Keypair;
 };
+export type WithdrawRewardsParams = {
+    company: Address;
+    companyId: Buffer | Uint8Array;
+    nonce: bigint;
+    feePayer?: Address;
+    admin?: Address;
+    centralVault?: Address;
+};
 export type DistributeRewardsParams = {
     admin: Address;
     feePayer: Address;

package/package.json

@@ -11,7 +11,7 @@
 		"@zebec-network/core-utils": "^1.3.1",
 		"@zebec-network/solana-common": "^2.6.1",
 		"@zebec-network/zebec_configs": "^1.2.6",
-		"@zebec-network/zebec_payroll": "^1.5.4",
+		"@zebec-network/zebec_payroll": "1.5.6",
 		"bignumber.js": "^11.1.1",
 		"bn.js": "^5.2.3"
 	},
@@ -45,5 +45,5 @@
 	},
 	"type": "module",
 	"types": "dist/index.d.ts",
-	"version": "2.6.0-dev.2"
+	"version": "2.7.0"
 }