@zebec-network/solana-payroll-sdk 2.3.0 → 2.4.0

package/dist/instructions.d.ts

@@ -112,19 +112,6 @@ export declare function createYieldDepositInstruction(program: Program<ZebecPayr
     nonce: BN;
     companyId: number[];
 }): Promise<TransactionInstruction>;
-export declare function createUnlockNowInstruction(program: Program<ZebecPayrollIdl>, accounts: {
-    feePayer: PublicKey;
-    company: PublicKey;
-    companyDeposit: PublicKey;
-    yieldConfig: PublicKey;
-    admin: PublicKey;
-    centralVaultTokenAta: PublicKey;
-    companyTokenAta: PublicKey;
-    depositMint: PublicKey;
-}, data: {
-    nonce: BN;
-    companyId: number[];
-}): Promise<TransactionInstruction>;
 export declare function createRequestUnlockInstruction(program: Program<ZebecPayrollIdl>, accounts: {
     company: PublicKey;
     companyDeposit: PublicKey;
@@ -133,13 +120,6 @@ export declare function createRequestUnlockInstruction(program: Program<ZebecPay
     companyId: number[];
     nonce: BN;
 }): Promise<TransactionInstruction>;
-export declare function createCancelUnlockInstruction(program: Program<ZebecPayrollIdl>, accounts: {
-    company: PublicKey;
-    companyDeposit: PublicKey;
-}, data: {
-    companyId: number[];
-    nonce: BN;
-}): Promise<TransactionInstruction>;
 export declare function createCompleteUnlockInstruction(program: Program<ZebecPayrollIdl>, accounts: {
     admin: PublicKey;
     feePayer: PublicKey;
@@ -149,6 +129,10 @@ export declare function createCompleteUnlockInstruction(program: Program<ZebecPa
     centralVaultTokenAta: PublicKey;
     companyTokenAta: PublicKey;
     depositMint: PublicKey;
+    centralVault: PublicKey;
+    centralVaultUsxAta: PublicKey;
+    usxMint: PublicKey;
+    companyUsxAta: PublicKey;
 }, data: {
     companyId: number[];
     nonce: BN;
@@ -156,10 +140,12 @@ export declare function createCompleteUnlockInstruction(program: Program<ZebecPa
 export declare function createDistributeRewardsInstruction(program: Program<ZebecPayrollIdl>, accounts: {
     admin: PublicKey;
     yieldConfig: PublicKey;
+    checkAccount: PublicKey;
 }, data: {
     distributions: {
         companyId: number[];
         nonce: BN;
         amount: BN;
     }[];
+    checkId: number[];
 }, remainingAccounts: AccountMeta[]): Promise<TransactionInstruction>;

package/dist/instructions.js

@@ -146,21 +146,6 @@ export async function createYieldDepositInstruction(program, accounts, data) {
     })
         .instruction();
 }
-export async function createUnlockNowInstruction(program, accounts, data) {
-    return program.methods
-        .unlockNow(data.companyId, data.nonce)
-        .accountsPartial({
-        feePayer: accounts.feePayer,
-        company: accounts.company,
-        companyDeposit: accounts.companyDeposit,
-        yieldConfig: accounts.yieldConfig,
-        admin: accounts.admin,
-        centralVaultTokenAta: accounts.centralVaultTokenAta,
-        companyTokenAta: accounts.companyTokenAta,
-        depositMint: accounts.depositMint,
-    })
-        .instruction();
-}
 export async function createRequestUnlockInstruction(program, accounts, data) {
     return program.methods
         .requestUnlock(data.companyId, data.nonce)
@@ -171,15 +156,6 @@ export async function createRequestUnlockInstruction(program, accounts, data) {
     })
         .instruction();
 }
-export async function createCancelUnlockInstruction(program, accounts, data) {
-    return program.methods
-        .cancelUnlock(data.companyId, data.nonce)
-        .accountsPartial({
-        company: accounts.company,
-        companyDeposit: accounts.companyDeposit,
-    })
-        .instruction();
-}
 export async function createCompleteUnlockInstruction(program, accounts, data) {
     return program.methods
         .completeUnlock(data.companyId, data.nonce)
@@ -192,15 +168,20 @@ export async function createCompleteUnlockInstruction(program, accounts, data) {
         centralVaultTokenAta: accounts.centralVaultTokenAta,
         companyTokenAta: accounts.companyTokenAta,
         depositMint: accounts.depositMint,
+        centralVault: accounts.centralVault,
+        centralVaultUsxAta: accounts.centralVaultUsxAta,
+        usxMint: accounts.usxMint,
+        companyUsxAta: accounts.companyUsxAta,
     })
         .instruction();
 }
 export async function createDistributeRewardsInstruction(program, accounts, data, remainingAccounts) {
     return program.methods
-        .distributeRewards(data.distributions)
+        .distributeRewards(data.checkId, data.distributions)
         .accountsPartial({
         admin: accounts.admin,
         yieldConfig: accounts.yieldConfig,
+        checkAccount: accounts.checkAccount,
     })
         .remainingAccounts(remainingAccounts)
         .instruction();

package/dist/pda.d.ts

@@ -5,3 +5,4 @@ export declare function derivePayrollVaultPda(metatadata: Address, payrollProgra
 export declare function deriveYieldConfigPda(configProgramId: Address): [PublicKey, number];
 export declare function deriveCompanyDepositPda(companyId: Buffer, nonce: bigint, payrollProgramId: Address): [PublicKey, number];
 export declare function deriveCompanyNoncePda(companyId: Buffer, payrollProgramId: Address): [PublicKey, number];
+export declare function deriveCheckAccountPda(checkId: Buffer | Uint8Array, payrollProgramId: Address): [PublicKey, number];

package/dist/pda.js

@@ -30,3 +30,6 @@ export function deriveCompanyDepositPda(companyId, nonce, payrollProgramId) {
 export function deriveCompanyNoncePda(companyId, payrollProgramId) {
     return PublicKey.findProgramAddressSync([companyId], translateAddress(payrollProgramId));
 }
+export function deriveCheckAccountPda(checkId, payrollProgramId) {
+    return PublicKey.findProgramAddressSync([checkId], translateAddress(payrollProgramId));
+}

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, ChangePayrollReceiverParams, CompanyDepositInfo, CompanyNonceInfo, CompleteUnlockParams, CreateMultiplePayrollParams, CreatePayrollParams, DistributeRewardsParams, PauseResumeMultiplePayrollParams, PauseResumePayrollParams, PayrollConfigInfo, PayrollMetadataInfo, RequestUnlockParams, SetMultipleTopupDelegateParams, SetTopupDelegateParams, TokenMetadata, TopupMultiplePayrollParams, TopupPayrollParams, UnlockNowParams, WithdrawMultiplePayrollParams, WithdrawPayrollParams, YieldDepositParams } from "./types.js";
+import type { CancelMultiplePayrollParams, CancelPayrollParams, ChangePayrollReceiverParams, CompanyDepositInfo, CompanyNonceInfo, CompleteUnlockParams, CreateMultiplePayrollParams, CreatePayrollParams, DistributeRewardsParams, PauseResumeMultiplePayrollParams, PauseResumePayrollParams, PayrollConfigInfo, PayrollMetadataInfo, RequestUnlockParams, SetMultipleTopupDelegateParams, SetTopupDelegateParams, TokenMetadata, TopupMultiplePayrollParams, TopupPayrollParams, WithdrawMultiplePayrollParams, WithdrawPayrollParams, 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>;
@@ -22,9 +22,7 @@ export declare function topupPayroll(payrollProgram: Program<ZebecPayrollIdl>, c
 export declare function topupMultiplePayroll(payrollProgram: Program<ZebecPayrollIdl>, configProgram: Program<ZebecConfigsIdl>, params: TopupMultiplePayrollParams): Promise<MultiTransactionPayload>;
 export declare function getCompanyNonceInfo(payrollProgram: Program<ZebecPayrollIdl>, companyIdBuffer: Buffer, commitment?: Commitment): Promise<CompanyNonceInfo | null>;
 export declare function yieldDeposit(payrollProgram: Program<ZebecPayrollIdl>, configsProgram: Program<ZebecConfigsIdl>, params: YieldDepositParams, commitment?: Commitment): Promise<TransactionPayload>;
-export declare function unlockNow(payrollProgram: Program<ZebecPayrollIdl>, configsProgram: Program<ZebecConfigsIdl>, params: UnlockNowParams, commitment?: Commitment): Promise<TransactionPayload>;
 export declare function requestUnlock(payrollProgram: Program<ZebecPayrollIdl>, configsProgram: Program<ZebecConfigsIdl>, params: RequestUnlockParams): Promise<TransactionPayload>;
-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 getCompanyDeposit(payrollProgram: Program<ZebecPayrollIdl>, company: Address): Promise<CompanyDepositInfo | null>;

package/dist/services.js

@@ -8,8 +8,8 @@ import { createAssociatedTokenAccountInstruction, getAssociatedTokenAddressSync,
 import { BigNumber } from "bignumber.js";
 import { BN } from "bn.js";
 import { PAYROLL_NAME_BUFFER_SIZE, USX_DECIMALS } from "./constants.js";
-import { createCancelPayrollInstruction, createCancelUnlockInstruction, createChangeRecipientInstruction, createCompleteUnlockInstruction, createCreatePayrollInstruction, createDistributeRewardsInstruction, createPauseResumePayrollInstruction, createRequestUnlockInstruction, createSetTopupDelegateInstruction, createTopupPayrollInstruction, createTransferFeesInstruction, createUnlockNowInstruction, createWithdrawPayrollInstruction, createYieldDepositInstruction, } from "./instructions.js";
-import { deriveCompanyDepositPda, deriveCompanyNoncePda, derivePayrollConfigPda, derivePayrollVaultPda, deriveYieldConfigPda, } from "./pda.js";
+import { createCancelPayrollInstruction, createChangeRecipientInstruction, createCompleteUnlockInstruction, createCreatePayrollInstruction, createDistributeRewardsInstruction, createPauseResumePayrollInstruction, createRequestUnlockInstruction, createSetTopupDelegateInstruction, createTopupPayrollInstruction, createTransferFeesInstruction, createWithdrawPayrollInstruction, createYieldDepositInstruction, } from "./instructions.js";
+import { deriveCheckAccountPda, deriveCompanyDepositPda, deriveCompanyNoncePda, derivePayrollConfigPda, derivePayrollVaultPda, deriveYieldConfigPda, } from "./pda.js";
 import { getFeeInfoForPayroll } from "./utils.js";
 export async function getPayrollConfig(configProgram, configName) {
     const [payrollConfigPda] = derivePayrollConfigPda(configName, configProgram.programId);
@@ -734,40 +734,6 @@ export async function yieldDeposit(payrollProgram, configsProgram, params, commi
     });
     return createTransactionPayload(payrollProgram, company, [ix]);
 }
-export async function unlockNow(payrollProgram, configsProgram, params, commitment) {
-    commitment = commitment ?? payrollProgram.provider.connection.commitment;
-    const company = translateAddress(params.company);
-    const feePayer = translateAddress(params.feePayer);
-    const [yieldConfig] = deriveYieldConfigPda(configsProgram.programId);
-    const configData = await configsProgram.account.yieldConfig.fetchNullable(yieldConfig, commitment);
-    if (!configData) {
-        throw new Error("YieldConfigNotFound: Yield config is not initialized in Zebec Configs Program");
-    }
-    // central vault is also the admin
-    const admin = configData.centralVault;
-    const [companyDeposit] = deriveCompanyDepositPda(Buffer.from(params.companyId), params.nonce, payrollProgram.programId);
-    const companyDepositData = await payrollProgram.account.companyDeposit.fetchNullable(companyDeposit, commitment);
-    if (!companyDepositData) {
-        throw new Error(`CompanyDepositNotFound: Company Deposit does not exists for nonce: ${params.nonce.toString()}n and companyId: [${Array.from(params.companyId).toString()}]`);
-    }
-    const depositMint = companyDepositData.depositMint;
-    const adminTokenAta = getAssociatedTokenAddressSync(depositMint, admin, true);
-    const companyTokenAta = getAssociatedTokenAddressSync(depositMint, company, true);
-    const ix = await createUnlockNowInstruction(payrollProgram, {
-        feePayer,
-        company,
-        companyDeposit,
-        yieldConfig,
-        admin,
-        centralVaultTokenAta: adminTokenAta,
-        companyTokenAta,
-        depositMint,
-    }, {
-        companyId: Array.from(params.companyId),
-        nonce: new BN(params.nonce),
-    });
-    return createTransactionPayload(payrollProgram, feePayer, [ix]);
-}
 export async function requestUnlock(payrollProgram, configsProgram, params) {
     const company = translateAddress(params.company);
     const feePayer = translateAddress(params.feePayer);
@@ -783,19 +749,6 @@ export async function requestUnlock(payrollProgram, configsProgram, params) {
     });
     return createTransactionPayload(payrollProgram, feePayer, [ix]);
 }
-export async function cancelUnlock(payrollProgram, params) {
-    const company = translateAddress(params.company);
-    const feePayer = translateAddress(params.feePayer);
-    const [companyDeposit] = deriveCompanyDepositPda(Buffer.from(params.companyId), params.nonce, payrollProgram.programId);
-    const ix = await createCancelUnlockInstruction(payrollProgram, {
-        company,
-        companyDeposit,
-    }, {
-        companyId: Array.from(params.companyId),
-        nonce: new BN(params.nonce.toString()),
-    });
-    return createTransactionPayload(payrollProgram, feePayer, [ix]);
-}
 export async function completeUnlock(payrollProgram, configsProgram, params, commitment) {
     commitment = commitment ?? payrollProgram.provider.connection.commitment;
     const company = translateAddress(params.company);
@@ -805,35 +758,51 @@ export async function completeUnlock(payrollProgram, configsProgram, params, com
     if (!configData) {
         throw new Error("YieldConfigNotFound: Yield config is not initialized in Zebec Configs Program");
     }
-    // central vault is also the admin
-    const admin = configData.centralVault;
+    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");
+    }
     const [companyDeposit] = deriveCompanyDepositPda(Buffer.from(params.companyId), params.nonce, payrollProgram.programId);
     const companyDepositData = await payrollProgram.account.companyDeposit.fetchNullable(companyDeposit, commitment);
     if (!companyDepositData) {
         throw new Error(`CompanyDepositNotFound: Company Deposit does not exists for nonce: ${params.nonce.toString()}n and companyId: [${Array.from(params.companyId).toString()}]`);
     }
     const depositMint = companyDepositData.depositMint;
-    const centralVaultTokenAta = getAssociatedTokenAddressSync(depositMint, admin, true);
+    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,
         company,
         companyDeposit,
         yieldConfig,
+        centralVault,
         centralVaultTokenAta,
+        centralVaultUsxAta,
         companyTokenAta,
+        companyUsxAta,
         depositMint,
+        usxMint,
     }, {
         companyId: Array.from(params.companyId),
         nonce: new BN(params.nonce.toString()),
     });
-    return createTransactionPayload(payrollProgram, feePayer, [ix]);
+    const partialSigners = [];
+    if (params.companyVaultKeypair) {
+        partialSigners.push(params.companyVaultKeypair);
+    }
+    return createTransactionPayload(payrollProgram, feePayer, [ix], partialSigners);
 }
 export async function distributeRewards(payrollProgram, configsProgram, params) {
     const admin = translateAddress(params.admin);
     const feePayer = translateAddress(params.feePayer);
     const [yieldConfig] = deriveYieldConfigPda(configsProgram.programId);
+    const [checkAccount] = deriveCheckAccountPda(params.checkId, payrollProgram.programId);
     const distributions = params.distributions.map((d) => ({
         companyId: Array.from(d.companyId),
         nonce: new BN(d.nonce.toString()),
@@ -849,7 +818,11 @@ export async function distributeRewards(payrollProgram, configsProgram, params)
     const ix = await createDistributeRewardsInstruction(payrollProgram, {
         admin,
         yieldConfig,
-    }, { distributions }, remainingAccounts);
+        checkAccount,
+    }, {
+        distributions,
+        checkId: Array.from(params.checkId),
+    }, remainingAccounts);
     return createTransactionPayload(payrollProgram, feePayer, [ix]);
 }
 export async function getCompanyDeposit(payrollProgram, company) {

package/dist/types.d.ts

@@ -205,33 +205,24 @@ export type YieldDepositParams = {
     depoistMint: Address;
     amount: Numeric;
 };
-export type UnlockNowParams = {
-    feePayer: Address;
-    company: Address;
-    nonce: bigint;
-    companyId: Buffer | Uint8Array;
-};
 export type RequestUnlockParams = {
     feePayer: Address;
     company: Address;
     companyId: Buffer | Uint8Array;
     nonce: bigint;
 };
-export type CancelUnlockParams = {
-    feePayer: Address;
-    company: Address;
-    companyId: Buffer | Uint8Array;
-    nonce: bigint;
-};
 export type CompleteUnlockParams = {
     feePayer: Address;
     company: Address;
     companyId: Buffer | Uint8Array;
     nonce: bigint;
+    companyVaultKeypair?: Keypair;
 };
 export type DistributeRewardsParams = {
     admin: Address;
     feePayer: Address;
+    /** Check id used to derive the check account that prevents duplicate distributions. */
+    checkId: Buffer | Uint8Array;
     distributions: {
         companyId: Buffer | Uint8Array;
         nonce: bigint;

package/package.json

@@ -8,11 +8,11 @@
 		"@metaplex-foundation/umi-web3js-adapters": "^1.5.1",
 		"@solana/spl-token": "^0.4.14",
 		"@solana/web3.js": "^1.98.2",
-		"@zebec-network/core-utils": "^1.2.0",
+		"@zebec-network/core-utils": "^1.3.1",
 		"@zebec-network/solana-common": "^2.6.0",
-		"@zebec-network/zebec_configs": "^1.2.2",
-		"@zebec-network/zebec_payroll": "^1.4.2",
-		"bignumber.js": "^11.0.0"
+		"@zebec-network/zebec_configs": "^1.2.3",
+		"@zebec-network/zebec_payroll": "^1.4.9",
+		"bignumber.js": "^11.1.1"
 	},
 	"devDependencies": {
 		"@types/bn.js": "^5.2.0",
@@ -43,5 +43,5 @@
 	},
 	"type": "module",
 	"types": "dist/index.d.ts",
-	"version": "2.3.0"
+	"version": "2.4.0"
 }