@zebec-network/solana-payroll-sdk 1.2.2 → 2.1.0

package/dist/instructions.d.ts

@@ -28,7 +28,7 @@ export declare function createCreatePayrollInstruction(program: Program<ZebecPay
     isPausable: number;
     rateUpdatable: number;
     startNow: number;
-    payrollName: number[];
+    payrollRunId: number[];
     initialBufferAmount: BN;
     autoTopupDelegate: number;
     senderId: number[];
@@ -98,3 +98,36 @@ export declare function createTransferFeesInstruction(program: Program<ZebecPayr
     decimals: number;
     feeAmount: BN;
 }): Promise<TransactionInstruction>;
+export declare function createInitYieldConfigInstruction(program: Program<ZebecPayrollIdl>, accounts: {
+    admin: PublicKey;
+    yieldConfig: PublicKey;
+    vault: PublicKey;
+    vaultUsdtAta: PublicKey;
+    usdtMint: PublicKey;
+    usxMint: PublicKey;
+}, data: {
+    minUnlockAmount: BN;
+    unlockCooldown: BN;
+}): Promise<TransactionInstruction>;
+export declare function createYieldDepositInstruction(program: Program<ZebecPayrollIdl>, accounts: {
+    company: PublicKey;
+    companyDeposit: PublicKey;
+    yieldConfig: PublicKey;
+    vault: PublicKey;
+    vaultUsdtAta: PublicKey;
+    companyUsdtAta: PublicKey;
+    usdtMint: PublicKey;
+}, data: {
+    amount: BN;
+}): Promise<TransactionInstruction>;
+export declare function createUnlockNowInstruction(program: Program<ZebecPayrollIdl>, accounts: {
+    admin: PublicKey;
+    feePayer: PublicKey;
+    company: PublicKey;
+    companyDeposit: PublicKey;
+    yieldConfig: PublicKey;
+    vault: PublicKey;
+    vaultUsdtAta: PublicKey;
+    companyUsdtAta: PublicKey;
+    usdtMint: PublicKey;
+}): Promise<TransactionInstruction>;

package/dist/instructions.js

@@ -15,7 +15,7 @@ export async function createCreatePayrollInstruction(program, accounts, data) {
         isPausable: data.isPausable,
         rateUpdatable: data.rateUpdatable,
         startNow: data.startNow,
-        streamName: data.payrollName,
+        payrollRunId: data.payrollRunId,
         initialBufferAmount: data.initialBufferAmount,
         autoTopupDelegate: data.autoTopupDelegate,
         senderId: data.senderId,
@@ -131,3 +131,49 @@ export async function createTransferFeesInstruction(program, accounts, data) {
     })
         .instruction();
 }
+export async function createInitYieldConfigInstruction(program, accounts, data) {
+    return program.methods
+        .initYieldConfig({
+        minUnlockAmount: data.minUnlockAmount,
+        unlockCooldown: data.unlockCooldown,
+    })
+        .accountsPartial({
+        admin: accounts.admin,
+        yieldConfig: accounts.yieldConfig,
+        vault: accounts.vault,
+        vaultUsdtAta: accounts.vaultUsdtAta,
+        usdtMint: accounts.usdtMint,
+        usxMint: accounts.usxMint,
+    })
+        .instruction();
+}
+export async function createYieldDepositInstruction(program, accounts, data) {
+    return program.methods
+        .yieldDeposit(data.amount)
+        .accountsPartial({
+        company: accounts.company,
+        companyDeposit: accounts.companyDeposit,
+        yieldConfig: accounts.yieldConfig,
+        vault: accounts.vault,
+        vaultUsdtAta: accounts.vaultUsdtAta,
+        companyUsdtAta: accounts.companyUsdtAta,
+        usdtMint: accounts.usdtMint,
+    })
+        .instruction();
+}
+export async function createUnlockNowInstruction(program, accounts) {
+    return program.methods
+        .unlockNow()
+        .accountsPartial({
+        admin: accounts.admin,
+        feePayer: accounts.feePayer,
+        company: accounts.company,
+        companyDeposit: accounts.companyDeposit,
+        yieldConfig: accounts.yieldConfig,
+        vault: accounts.vault,
+        vaultUsdtAta: accounts.vaultUsdtAta,
+        companyUsdtAta: accounts.companyUsdtAta,
+        usdtMint: accounts.usdtMint,
+    })
+        .instruction();
+}

package/dist/pda.d.ts

@@ -2,3 +2,6 @@ import { type Address } from "@coral-xyz/anchor";
 import { PublicKey } from "@solana/web3.js";
 export declare function derivePayrollConfigPda(configName: string, configProgramId: Address): [PublicKey, number];
 export declare function derivePayrollVaultPda(metatadata: Address, payrollProgramId: Address): [PublicKey, number];
+export declare function deriveYieldConfigPda(payrollProgramId: Address): [PublicKey, number];
+export declare function deriveYieldVaultPda(payrollProgramId: Address): [PublicKey, number];
+export declare function deriveCompanyDepositPda(company: Address, payrollProgramId: Address): [PublicKey, number];

package/dist/pda.js

@@ -6,9 +6,23 @@ import { PublicKey } from "@solana/web3.js";
 const PAYROLL_CONFIG_SEEDS = {
     PAYROLL_CONFIG: utils.bytes.utf8.encode("payroll_config"),
 };
+const YIELD_SEEDS = {
+    YIELD_CONFIG: utils.bytes.utf8.encode("yield_config"),
+    YIELD_VAULT: utils.bytes.utf8.encode("yield_vault"),
+    COMPANY_DEPOSIT: utils.bytes.utf8.encode("Yield"),
+};
 export function derivePayrollConfigPda(configName, configProgramId) {
     return PublicKey.findProgramAddressSync([PAYROLL_CONFIG_SEEDS.PAYROLL_CONFIG, utils.bytes.utf8.encode(configName)], translateAddress(configProgramId));
 }
 export function derivePayrollVaultPda(metatadata, payrollProgramId) {
     return PublicKey.findProgramAddressSync([translateAddress(metatadata).toBuffer()], translateAddress(payrollProgramId));
 }
+export function deriveYieldConfigPda(payrollProgramId) {
+    return PublicKey.findProgramAddressSync([YIELD_SEEDS.YIELD_CONFIG], translateAddress(payrollProgramId));
+}
+export function deriveYieldVaultPda(payrollProgramId) {
+    return PublicKey.findProgramAddressSync([YIELD_SEEDS.YIELD_VAULT], translateAddress(payrollProgramId));
+}
+export function deriveCompanyDepositPda(company, payrollProgramId) {
+    return PublicKey.findProgramAddressSync([translateAddress(company).toBuffer(), YIELD_SEEDS.COMPANY_DEPOSIT], translateAddress(payrollProgramId));
+}

package/dist/services.d.ts

@@ -1,9 +1,9 @@
 import { type Address, type Program } from "@coral-xyz/anchor";
-import { type Commitment } from "@solana/web3.js";
+import { type Commitment, PublicKey } 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 { CancelPayrollParams, ChangePayrollReceiverParams, CreateMultiplePayrollParams, CreatePayrollParams, PayrollConfigInfo, PayrollMetadataInfo, SetTopupDelegateParams, TokenMetadata, TopupPayrollParams, WithdrawPayrollParams } from "./types.js";
+import type { CancelPayrollParams, ChangePayrollReceiverParams, CreateMultiplePayrollParams, CreatePayrollParams, InitYieldConfigParams, PayrollConfigInfo, PayrollMetadataInfo, SetTopupDelegateParams, TokenMetadata, TopupPayrollParams, UnlockNowParams, 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>;
@@ -17,3 +17,19 @@ export declare function withdrawPayroll(payrollProgram: Program<ZebecPayrollIdl>
 export declare function changePayrollReceiver(program: Program<ZebecPayrollIdl>, params: ChangePayrollReceiverParams): Promise<TransactionPayload>;
 export declare function setTopupDelegate(payrollProgram: Program<ZebecPayrollIdl>, configProgram: Program<ZebecConfigsIdl>, params: SetTopupDelegateParams): Promise<TransactionPayload>;
 export declare function topupPayroll(payrollProgram: Program<ZebecPayrollIdl>, configProgram: Program<ZebecConfigsIdl>, params: TopupPayrollParams): Promise<TransactionPayload>;
+export declare function initYieldConfig(payrollProgram: Program<ZebecPayrollIdl>, params: InitYieldConfigParams): Promise<TransactionPayload>;
+export declare function yieldDeposit(payrollProgram: Program<ZebecPayrollIdl>, params: YieldDepositParams): Promise<TransactionPayload>;
+export declare function unlockNow(payrollProgram: Program<ZebecPayrollIdl>, params: UnlockNowParams): Promise<TransactionPayload>;
+export declare function getCompanyDeposit(payrollProgram: Program<ZebecPayrollIdl>, company: Address): Promise<{
+    company: PublicKey;
+    depositedAmount: import("bn.js");
+    rewardsReceived: import("bn.js");
+    depositTime: import("bn.js");
+    hasDeposited: boolean;
+    pendingUnlock: {
+        usdtAmount: import("bn.js");
+        usxAmount: import("bn.js");
+        requestTime: import("bn.js");
+    } | null;
+    bump: number;
+}>;

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 } from "./constants.js";
-import { createCancelPayrollInstruction, createChangeRecipientInstruction, createCreatePayrollInstruction, createPauseResumePayrollInstruction, createSetTopupDelegateInstruction, createTopupPayrollInstruction, createTransferFeesInstruction, createWithdrawPayrollInstruction, } from "./instructions.js";
-import { derivePayrollConfigPda, derivePayrollVaultPda } from "./pda.js";
+import { createCancelPayrollInstruction, createChangeRecipientInstruction, createCreatePayrollInstruction, createInitYieldConfigInstruction, createPauseResumePayrollInstruction, createSetTopupDelegateInstruction, createTopupPayrollInstruction, createTransferFeesInstruction, createUnlockNowInstruction, createWithdrawPayrollInstruction, createYieldDepositInstruction, } from "./instructions.js";
+import { deriveCompanyDepositPda, derivePayrollConfigPda, derivePayrollVaultPda, deriveYieldConfigPda, deriveYieldVaultPda, } from "./pda.js";
 import { getFeeInfoForPayroll } from "./utils.js";
 export async function getPayrollConfig(configProgram, configName) {
     const [payrollConfigPda] = derivePayrollConfigPda(configName, configProgram.programId);
@@ -165,7 +165,7 @@ export async function getPayrollMetadataInfo(program, payrollMetadata, commitmen
             isPausable: Boolean(metadataInfo.permissions.isPausable),
             rateUpdatable: Boolean(metadataInfo.permissions.rateUpdatable),
         },
-        payrollName: utils.bytes.utf8.decode(Uint8Array.from(metadataInfo.streamName).filter((byte) => byte !== 0)), // Remove padding zeros
+        payrollRunId: utils.bytes.utf8.decode(Uint8Array.from(metadataInfo.payrollRunId).filter((byte) => byte !== 0)), // Remove padding zeros
     };
 }
 async function createPayload(program, payerKey, instructions, signers, addressLookupTableAccounts) {
@@ -214,8 +214,8 @@ export async function createPayroll(payrollProgram, configProgram, params, payro
         .times(TEN_BIGNUM.pow(payrollTokenDecimals))
         .toFixed(0);
     const cliffPercentage = new BN(percentToBps(params.cliffPercentage));
-    const payrollName = new Uint8Array(PAYROLL_NAME_BUFFER_SIZE);
-    payrollName.set(utils.bytes.utf8.encode(params.payrollName));
+    const payrollRunId = new Uint8Array(PAYROLL_NAME_BUFFER_SIZE);
+    payrollRunId.set(utils.bytes.utf8.encode(params.payrollRunId));
     const feeInfo = await getFeeInfoForPayroll(payrollFeeBaseUrl, payrollToken, amount);
     const feeTokenDecimals = await getMintDecimals(payrollProgram.provider.connection, payrollConfigAccount.feeToken);
     const parsedFeeAmount = feeInfo.feeAmountRaw;
@@ -269,7 +269,7 @@ export async function createPayroll(payrollProgram, configProgram, params, payro
         startNow: Number(params.startNow),
         startTime: new BN(params.startTime),
         autoWithdrawFrequency: new BN(params.autoWithdrawFrequency),
-        payrollName: Array.from(payrollName),
+        payrollRunId: Array.from(payrollRunId),
         transferableByRecipient: Number(params.transferableByRecipient),
         transferableBySender: Number(params.transferableBySender),
         receiverId: Array.from(params.receiverId),
@@ -309,8 +309,8 @@ export async function createMultiplePayroll(payrollProgram, configProgram, param
             .times(TEN_BIGNUM.pow(payrollTokenDecimals))
             .toFixed(0);
         const cliffPercentage = new BN(percentToBps(payroll.cliffPercentage));
-        const payrollName = new Uint8Array(PAYROLL_NAME_BUFFER_SIZE);
-        payrollName.set(utils.bytes.utf8.encode(payroll.payrollName));
+        const payrollRunId = new Uint8Array(PAYROLL_NAME_BUFFER_SIZE);
+        payrollRunId.set(utils.bytes.utf8.encode(payroll.payrollRunId));
         const feeInfo = await getFeeInfoForPayroll(payrollFeeBaseUrl, payrollToken, amount);
         const feeTokenDecimals = await getMintDecimals(payrollProgram.provider.connection, payrollConfigAccount.feeToken);
         const parsedFeeAmount = feeInfo.feeAmountRaw;
@@ -364,7 +364,7 @@ export async function createMultiplePayroll(payrollProgram, configProgram, param
             startNow: Number(payroll.startNow),
             startTime: new BN(payroll.startTime),
             autoWithdrawFrequency: new BN(payroll.autoWithdrawFrequency),
-            payrollName: Array.from(payrollName),
+            payrollRunId: Array.from(payrollRunId),
             transferableByRecipient: Number(payroll.transferableByRecipient),
             transferableBySender: Number(payroll.transferableBySender),
             receiverId: Array.from(payroll.receiverId),
@@ -526,3 +526,75 @@ export async function topupPayroll(payrollProgram, configProgram, params) {
     });
     return createPayload(payrollProgram, caller, [ix]);
 }
+export async function initYieldConfig(payrollProgram, params) {
+    const admin = translateAddress(params.admin);
+    const usdtMint = translateAddress(params.usdtMint);
+    const usxMint = translateAddress(params.usxMint);
+    const [yieldConfig] = deriveYieldConfigPda(payrollProgram.programId);
+    const [vault] = deriveYieldVaultPda(payrollProgram.programId);
+    const vaultUsdtAta = getAssociatedTokenAddressSync(usdtMint, vault, true);
+    const usdtDecimals = await getMintDecimals(payrollProgram.provider.connection, usdtMint);
+    const minUnlockAmount = new BN(BigNumber(params.minUnlockAmount)
+        .times(TEN_BIGNUM.pow(usdtDecimals))
+        .toFixed(0));
+    const ix = await createInitYieldConfigInstruction(payrollProgram, {
+        admin,
+        yieldConfig,
+        vault,
+        vaultUsdtAta,
+        usdtMint,
+        usxMint,
+    }, {
+        minUnlockAmount,
+        unlockCooldown: new BN(params.unlockCooldown),
+    });
+    return createPayload(payrollProgram, admin, [ix]);
+}
+export async function yieldDeposit(payrollProgram, params) {
+    const company = translateAddress(params.company);
+    const usdtMint = translateAddress(params.usdtMint);
+    const [companyDeposit] = deriveCompanyDepositPda(company, payrollProgram.programId);
+    const [yieldConfig] = deriveYieldConfigPda(payrollProgram.programId);
+    const [vault] = deriveYieldVaultPda(payrollProgram.programId);
+    const vaultUsdtAta = getAssociatedTokenAddressSync(usdtMint, vault, true);
+    const companyUsdtAta = getAssociatedTokenAddressSync(usdtMint, company, true);
+    const usdtDecimals = await getMintDecimals(payrollProgram.provider.connection, usdtMint);
+    const amount = new BN(BigNumber(params.amount).times(TEN_BIGNUM.pow(usdtDecimals)).toFixed(0));
+    const ix = await createYieldDepositInstruction(payrollProgram, {
+        company,
+        companyDeposit,
+        yieldConfig,
+        vault,
+        vaultUsdtAta,
+        companyUsdtAta,
+        usdtMint,
+    }, { amount });
+    return createPayload(payrollProgram, company, [ix]);
+}
+export async function unlockNow(payrollProgram, params) {
+    const admin = translateAddress(params.admin);
+    const company = translateAddress(params.company);
+    const usdtMint = translateAddress(params.usdtMint);
+    const feePayer = params.feePayer ? translateAddress(params.feePayer) : admin;
+    const [companyDeposit] = deriveCompanyDepositPda(company, payrollProgram.programId);
+    const [yieldConfig] = deriveYieldConfigPda(payrollProgram.programId);
+    const [vault] = deriveYieldVaultPda(payrollProgram.programId);
+    const vaultUsdtAta = getAssociatedTokenAddressSync(usdtMint, vault, true);
+    const companyUsdtAta = getAssociatedTokenAddressSync(usdtMint, company, true);
+    const ix = await createUnlockNowInstruction(payrollProgram, {
+        admin,
+        feePayer,
+        company,
+        companyDeposit,
+        yieldConfig,
+        vault,
+        vaultUsdtAta,
+        companyUsdtAta,
+        usdtMint,
+    });
+    return createPayload(payrollProgram, feePayer, [ix]);
+}
+export async function getCompanyDeposit(payrollProgram, company) {
+    const account = await payrollProgram.account.companyDeposit.fetch(translateAddress(company));
+    return account;
+}

package/dist/types.d.ts

@@ -55,7 +55,7 @@ export type PayrollMetadataInfo = {
         initialBufferAmount: string;
         topupCount: number;
     };
-    payrollName: string;
+    payrollRunId: string;
 };
 export type TokenMetadata = {
     mint: PublicKey;
@@ -88,7 +88,7 @@ export type CreatePayrollParams = {
     startNow: boolean;
     startTime: number;
     autoWithdrawFrequency: number;
-    payrollName: string;
+    payrollRunId: string;
     transferableByRecipient: boolean;
     transferableBySender: boolean;
     canTopup: boolean;
@@ -117,7 +117,7 @@ export type CreateMultiplePayrollParams = {
         startNow: boolean;
         startTime: number;
         autoWithdrawFrequency: number;
-        payrollName: string;
+        payrollRunId: string;
         transferableByRecipient: boolean;
         transferableBySender: boolean;
         canTopup: boolean;
@@ -166,6 +166,24 @@ export type SetTopupDelegateParams = {
     payrollMetadata: Address;
     amount: Numeric;
 };
+export type InitYieldConfigParams = {
+    admin: Address;
+    usdtMint: Address;
+    usxMint: Address;
+    minUnlockAmount: Numeric;
+    unlockCooldown: number;
+};
+export type YieldDepositParams = {
+    company: Address;
+    usdtMint: Address;
+    amount: Numeric;
+};
+export type UnlockNowParams = {
+    admin: Address;
+    feePayer?: Address;
+    company: Address;
+    usdtMint: Address;
+};
 export type PayrollFeeInfo = {
     symbol: string;
     chain: string;

package/package.json

@@ -11,7 +11,7 @@
 		"@zebec-network/core-utils": "^1.2.0",
 		"@zebec-network/solana-common": "^2.6.0",
 		"@zebec-network/zebec_configs": "^1.1.1",
-		"@zebec-network/zebec_payroll": "^1.3.1",
+		"@zebec-network/zebec_payroll": "^1.4.0",
 		"bignumber.js": "^11.0.0"
 	},
 	"devDependencies": {
@@ -43,5 +43,5 @@
 	},
 	"type": "module",
 	"types": "dist/index.d.ts",
-	"version": "1.2.2"
+	"version": "2.1.0"
 }