@zebec-network/solana-payroll-sdk 2.8.0 → 2.9.1

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/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, InstantDisbursementParams, PauseResumeMultiplePayrollParams, PauseResumePayrollParams, PayrollConfigInfo, PayrollMetadataInfo, RequestUnlockParams, SetMultipleTopupDelegateParams, SetTopupDelegateParams, SwapAndCreateCardParams, TokenMetadata, TopupMultiplePayrollParams, TopupPayrollParams, UserPurchaseRecordInfo, WithdrawMultiplePayrollParams, WithdrawPayrollParams, WithdrawRewardsParams, YieldDepositParams } from "./types.js";
+import type { CancelMultiplePayrollParams, CancelPayrollParams, CancelUnlockParams, CardPurchaseInfo, ChangePayrollReceiverParams, CompanyDepositInfo, CompanyNonceInfo, CompleteUnlockParams, CreateCardParams, CreateMultiplePayrollParams, CreatePayrollParams, DistributeRewardsParams, InstantDisbursementParams, PauseResumeMultiplePayrollParams, PauseResumePayrollParams, PayrollConfigInfo, PayrollMetadataInfo, RequestUnlockParams, SetMultipleTopupDelegateParams, SetTopupDelegateParams, SwapAndCreateCardParams, TokenMetadata, TopupMultiplePayrollParams, TopupPayrollParams, UserPurchaseRecordInfo, WithdrawMultiplePayrollParams, WithdrawPayrollAndYieldDepositParams, 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>;
@@ -38,3 +38,4 @@ export declare function getNextCardIndex(payrollProgram: Program<ZebecPayrollIdl
 export declare function getUserPurchaseRecordInfo(payrollProgram: Program<ZebecPayrollIdl>, entCardConfigName: string, user: Address, commitment?: Commitment): Promise<UserPurchaseRecordInfo | null>;
 export declare function getCardPurchaseInfo(payrollProgram: Program<ZebecPayrollIdl>, entCardConfigName: string, user: Address, cardIndex: bigint, commitment?: Commitment): Promise<CardPurchaseInfo | null>;
 export declare function instantDisbursement(payrollProgram: Program<ZebecPayrollIdl>, params: InstantDisbursementParams): Promise<MultiTransactionPayload>;
+export declare function withdrawPayrollAndYieldDeposit(payrollProgram: Program<ZebecPayrollIdl>, configsProgram: Program<ZebecConfigsIdl>, params: WithdrawPayrollAndYieldDepositParams): Promise<TransactionPayload>;

package/dist/services.js

@@ -11,7 +11,7 @@ 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, createWithdrawRewardsInstruction, createYieldDepositInstruction, } from "./instructions.js";
 import { deriveCheckAccountPda, deriveCompanyDepositPda, deriveCompanyNoncePda, deriveEnterpriseCardConfigPda, deriveEnterpriseCardIndexPda, deriveEnterpriseCardPurchasePda, deriveEnterpriseUserPurchaseRecordPda, derivePayrollConfigPda, derivePayrollVaultPda, deriveYieldConfigPda, } from "./pda.js";
-import { deductFeeFromAmount, getConnectionFromProgram, 
+import { calculateTotalWithdrawableAmount, deductFeeFromAmount, getConnectionFromProgram, 
 // getFeeInfoForPayroll,
 getFeeRateForMint, isAmountWithInProviderCardPurchaseRange, isAmountWithinDailyCardLimit, } from "./utils.js";
 export async function getPayrollConfig(configProgram, configName) {
@@ -694,7 +694,7 @@ export async function getCompanyNonceInfo(payrollProgram, companyIdBuffer, commi
 export async function yieldDeposit(payrollProgram, configsProgram, params, commitment) {
     commitment = commitment ?? payrollProgram.provider.connection.commitment;
     const company = translateAddress(params.company);
-    const depositMint = translateAddress(params.depoistMint);
+    const depositMint = translateAddress(params.depositMint);
     const [yieldConfig] = deriveYieldConfigPda(configsProgram.programId);
     const configData = await configsProgram.account.yieldConfig.fetchNullable(yieldConfig, commitment);
     if (!configData) {
@@ -1229,3 +1229,81 @@ export async function instantDisbursement(payrollProgram, params) {
     }));
     return createMultiTransactionPayload(payrollProgram, feePayer, transactionData);
 }
+export async function withdrawPayrollAndYieldDeposit(payrollProgram, configsProgram, params) {
+    const connection = getConnectionFromProgram(payrollProgram);
+    const [payrollConfig] = derivePayrollConfigPda(params.payrollConfigName, configsProgram.programId);
+    const receiver = translateAddress(params.company);
+    const withdrawer = params.withdrawer
+        ? translateAddress(params.withdrawer)
+        : receiver;
+    const feePayer = params.feePayer
+        ? translateAddress(params.feePayer)
+        : params.withdrawer
+            ? withdrawer
+            : receiver;
+    const payrollMetadata = translateAddress(params.payrollMetadata);
+    const payrollMetadataAccount = await payrollProgram.account.paymentStream.fetch(payrollMetadata);
+    const payrollToken = payrollMetadataAccount.financials.streamToken;
+    const receiverAta = getAssociatedTokenAddressSync(payrollToken, receiver, true);
+    const [payrollVault] = derivePayrollVaultPda(payrollMetadata, payrollProgram.programId);
+    const payrollVaultAta = getAssociatedTokenAddressSync(payrollToken, payrollVault, true);
+    const payrollTokenDecimals = await getMintDecimals(connection, payrollToken);
+    const withdrawPayrollIx = await createWithdrawPayrollInstruction(payrollProgram, {
+        receiver,
+        receiverAta,
+        payrollConfig,
+        payrollMetadata,
+        payrollToken,
+        payrollVault,
+        payrollVaultAta,
+        withdrawer,
+        feePayer,
+    });
+    const company = translateAddress(params.company);
+    const [yieldConfig] = deriveYieldConfigPda(configsProgram.programId);
+    const configData = await configsProgram.account.yieldConfig.fetchNullable(yieldConfig, connection.commitment);
+    if (!configData) {
+        throw new Error("Yield config is not initialized in Zebec Configs Program");
+    }
+    const centralVault = configData.centralVault;
+    const [companyNonce] = deriveCompanyNoncePda(Buffer.from(params.companyId), payrollProgram.programId);
+    const [companyDeposit] = deriveCompanyDepositPda(Buffer.from(params.companyId), params.nonce, payrollProgram.programId);
+    const centralVaultTokenAta = getAssociatedTokenAddressSync(payrollToken, centralVault, true);
+    const companyTokenAta = getAssociatedTokenAddressSync(payrollToken, company, true);
+    const amount = new BN(BigNumber(params.depositAmount).shiftedBy(payrollTokenDecimals).toFixed(0));
+    const createYieldDepositIx = await createYieldDepositInstruction(payrollProgram, {
+        company,
+        companyDeposit,
+        yieldConfig,
+        centralVault,
+        centralVaultTokenAta,
+        companyNonce,
+        companyTokenAta,
+        depositMint: payrollToken,
+    }, {
+        amount,
+        companyId: Array.from(params.companyId),
+        nonce: new BN(params.nonce),
+    });
+    let effectiveTime = BigNumber(0);
+    if (payrollMetadataAccount.schedule.pausedTimestamp.gtn(0)) {
+        effectiveTime = BigNumber(payrollMetadataAccount.schedule.pausedTimestamp.toString());
+    }
+    else {
+        const slot = await connection.getSlot(connection.commitment);
+        effectiveTime = BigNumber(await connection.getBlockTime(slot).then((blocktime) => {
+            if (!blocktime) {
+                throw new Error("Could not fetch block time");
+            }
+            return blocktime;
+        }));
+    }
+    const withdrawableAmount = calculateTotalWithdrawableAmount(BigNumber(payrollMetadataAccount.schedule.startTime.toString()), BigNumber(payrollMetadataAccount.financials.fullAmount.toString()), BigNumber(payrollMetadataAccount.financials.withdrawnAmount.toString()), BigNumber(payrollMetadataAccount.schedule.duration.toString()), effectiveTime, BigNumber(payrollMetadataAccount.schedule.pausedInterval.toString())).shiftedBy(payrollTokenDecimals * -1);
+    if (withdrawableAmount.lt(params.depositAmount)) {
+        throw new Error("Withdrawable payroll amount is less than asked Yield deposit amount");
+    }
+    return createTransactionPayload(payrollProgram, withdrawer, [
+        withdrawPayrollIx,
+        createYieldDepositIx,
+    ]);
+}

package/dist/types.d.ts

@@ -210,7 +210,7 @@ export type YieldDepositParams = {
     companyId: Buffer | Uint8Array;
     company: Address;
     nonce: bigint;
-    depoistMint: Address;
+    depositMint: Address;
     amount: Numeric;
 };
 export type RequestUnlockParams = {
@@ -380,3 +380,13 @@ export type UserPurchaseRecordInfo = {
     lastCardBoughtPerDay: Numeric;
     lastCardBoughtTimestamp: number;
 };
+export type WithdrawPayrollAndYieldDepositParams = {
+    payrollConfigName: string;
+    payrollMetadata: Address;
+    withdrawer?: Address;
+    feePayer?: Address;
+    company: Address;
+    companyId: Buffer | Uint8Array;
+    nonce: bigint;
+    depositAmount: Numeric;
+};

package/dist/utils.d.ts

@@ -14,3 +14,4 @@ export type ParsedTokenFeeItem = {
 };
 export declare function getFeeRateForMint(feeRateList: ParsedTokenFeeItem[], mint: PublicKey): number;
 export declare function deductFeeFromAmount(rawAmount: BigNumber.Value, feeRateInBps: BigNumber.Value): string;
+export declare function calculateTotalWithdrawableAmount(startTime: BigNumber, fullAmount: BigNumber, withdrawnAmount: BigNumber, duration: BigNumber, now: BigNumber, pausedInterval: BigNumber): BigNumber;

package/dist/utils.js

@@ -99,3 +99,16 @@ export function deductFeeFromAmount(rawAmount, feeRateInBps) {
     const fee = amount.times(feeRateInBps).div(BPS_DENOMINATOR);
     return amount.minus(fee).toFixed(0, BigNumber.ROUND_FLOOR);
 }
+export function calculateTotalWithdrawableAmount(startTime, fullAmount, withdrawnAmount, duration, now, pausedInterval) {
+    if (now.lte(startTime)) {
+        return BigNumber(0);
+    }
+    const elapsed = BigNumber.max(0, now.minus(startTime).minus(pausedInterval));
+    const totalDuration = BigNumber.max(1, duration);
+    const totalStreamed = BigNumber.min(elapsed
+        .times(fullAmount)
+        .div(totalDuration)
+        .decimalPlaces(0, BigNumber.ROUND_FLOOR), fullAmount);
+    const withdrawable = totalStreamed.minus(withdrawnAmount);
+    return withdrawable.isNegative() ? BigNumber(0) : withdrawable;
+}

package/package.json

@@ -45,5 +45,5 @@
 	},
 	"type": "module",
 	"types": "dist/index.d.ts",
-	"version": "2.8.0"
+	"version": "2.9.1"
 }