@zebec-network/admin-sdk 1.0.0

package/dist/types.d.ts

@@ -0,0 +1,433 @@
+import type { Address, BN } from "@coral-xyz/anchor";
+import type { Transaction } from "@mysten/sui/transactions";
+import type { PublicKey } from "@solana/web3.js";
+export type RpcNetwork = "mainnet-beta" | "devnet";
+export type Numeric = string | number;
+export type StreamConfigInfo = {
+    address: PublicKey;
+    admin: PublicKey;
+    configName: string;
+    withdrawerAccount: PublicKey;
+    whitelistedTokens: PublicKey[];
+    platformFee: number;
+    baseFee: number;
+    frequencies: number[];
+    feeTiers: StreamFeeTier[];
+    feeVault: PublicKey;
+};
+export type TokenMetadata = {
+    mint: PublicKey;
+    decimals: number;
+    freezeAuthority: PublicKey | null;
+    supply: string;
+    isInitialized: boolean;
+    mintAuthority: PublicKey | null;
+    metadata: {
+        address: PublicKey;
+        updateAuthority: PublicKey;
+        name: string;
+        symbol: string;
+        uri: string;
+    } | null;
+};
+export type InitializeStreamConfigParams = {
+    admin?: Address;
+    config: {
+        baseFeePercent: Numeric;
+        frequencies: number[];
+        platformFeePercent: Numeric;
+        withdrawAccount: Address;
+        feeTiers: StreamFeeTier[];
+        feeVault: Address;
+    };
+};
+export type StreamFeeTier = {
+    minThreshold: Numeric;
+    maxThreshold: Numeric;
+    feeRateInPercent: Numeric;
+};
+export type UpdateStreamConfigParams = {
+    admin?: Address;
+    config: {
+        baseFeePercent: Numeric;
+        frequencies: number[];
+        platformFeePercent: Numeric;
+        withdrawAccount: Address;
+        feeTiers: StreamFeeTier[];
+        feeVault: Address;
+    };
+};
+export type WhiteListTokensParams = {
+    admin: Address;
+    tokens: Address[];
+};
+export type StreamMetadataInfo = {
+    address: PublicKey;
+    parties: {
+        sender: PublicKey;
+        receiver: PublicKey;
+    };
+    financials: {
+        streamToken: PublicKey;
+        cliffPercentage: number;
+        depositedAmount: string;
+        withdrawnAmount: string;
+    };
+    schedule: {
+        startTime: number;
+        endTime: number;
+        lastWithdrawTime: number;
+        frequency: number;
+        duration: number;
+        pausedTimestamp: number;
+        pausedInterval: number;
+        canceledTimestamp: number;
+    };
+    permissions: {
+        cancelableBySender: boolean;
+        cancelableByRecipient: boolean;
+        automaticWithdrawal: boolean;
+        transferableBySender: boolean;
+        transferableByRecipient: boolean;
+        canTopup: boolean;
+        isPausable: boolean;
+        rateUpdatable: boolean;
+    };
+    streamName: string;
+};
+export type ProxyConfigInfo = {
+    address: PublicKey;
+    fee: string;
+    minAmount: string;
+    proxyAdmin: PublicKey;
+    mintableTokens: PublicKey[];
+    feeVault: PublicKey;
+    emergencyPaused: boolean;
+    chainId: string;
+};
+export type InitLockupInstructionData = {
+    rewardSchemes: ParsedRewardScheme[];
+    fee: BN;
+    feeVault: PublicKey;
+    name: string;
+    minimumStake: BN;
+};
+export type UpdateLockupInstructionData = {
+    rewardSchemes: ParsedRewardScheme[];
+    fee: BN;
+    feeVault: PublicKey;
+    minimumStake: BN;
+};
+export type DeletePartnerCustomFeesInstructionData = {
+    tokenList: PublicKey[];
+    partnershipName: string;
+};
+export type ParsedRewardScheme = {
+    duration: BN;
+    reward: BN;
+};
+export type RewardScheme = {
+    duration: number;
+    rewardRate: Numeric;
+};
+export type LockupInfo = {
+    address: Address;
+    feeInfo: {
+        fee: string;
+        feeVault: Address;
+    };
+    rewardToken: {
+        tokenAddress: Address;
+    };
+    stakeToken: {
+        tokenAddress: Address;
+        totalStaked: string;
+    };
+    stakeInfo: {
+        name: string;
+        creator: Address;
+        rewardSchemes: RewardScheme[];
+        minimumStake: string;
+    };
+};
+export type StakeInfo = {
+    address: Address;
+    nonce: bigint;
+    createdTime: number;
+    stakedAmount: string;
+    rewardAmount: string;
+    stakeClaimed: boolean;
+    lockPeriod: number;
+    staker: string;
+    lockup: string;
+};
+export type InitCardConfigInstructionData = {
+    cardVault: PublicKey;
+    revenueVault: PublicKey;
+    commissionVault: PublicKey;
+    revenueFee: BN;
+    nativeFee: BN;
+    carbonFee: BN;
+    nonNativeFee: BN;
+    maxCardAmount: BN;
+    minCardAmount: BN;
+    dailyCardPurchaseLimit: BN;
+    feeTiers: ParsedCardFeeTier[];
+};
+export type SetCardConfigInstructionData = {
+    newZicOwner: PublicKey;
+    cardVault: PublicKey;
+    revenueVault: PublicKey;
+    commissionVault: PublicKey;
+    revenueFee: BN;
+    carbonFee: BN;
+    nativeFee: BN;
+    nonNativeFee: BN;
+    maxCardAmount: BN;
+    minCardAmount: BN;
+    dailyCardPurchaseLimit: BN;
+    feeTiers: ParsedCardFeeTier[];
+};
+export type InitPartnerCardConfigInstructionData = {
+    cardVault: PublicKey;
+    revenueVault: PublicKey;
+    carbonFee: BN;
+    maxCardAmount: BN;
+    minCardAmount: BN;
+    dailyCardPurchaseLimit: BN;
+    feeTiers: ParsedCardFeeTier[];
+    partnershipName: string;
+};
+export type SetPartnerCardConfigInstructionData = {
+    newZicOwner: PublicKey;
+    cardVault: PublicKey;
+    revenueVault: PublicKey;
+    carbonFee: BN;
+    maxCardAmount: BN;
+    minCardAmount: BN;
+    dailyCardPurchaseLimit: BN;
+    feeTiers: ParsedCardFeeTier[];
+    partnershipName: string;
+};
+export type ParsedCardFeeTier = {
+    minAmount: BN;
+    maxAmount: BN;
+    fee: BN;
+};
+export type ParsedCardConfigInfo = {
+    index: BN;
+    zicOwner: PublicKey;
+    nativeFee: BN;
+    nonNativeFee: BN;
+    revenueFee: BN;
+    usdcMint: PublicKey;
+    revenueVault: PublicKey;
+    commissionVault: PublicKey;
+    cardVault: PublicKey;
+    totalBought: BN;
+    dailyCardBuyLimit: BN;
+    providerConfig: ParsedProviderConfig;
+};
+export type ParsedProviderConfig = {
+    minCardAmount: BN;
+    maxCardAmount: BN;
+    feeTiers: {
+        tiers: ParsedCardFeeTier[];
+    };
+};
+export type ParsedTokenFeeRecord = {
+    tokenAddress: PublicKey;
+    fee: BN;
+};
+export type CardFeeTier = {
+    minAmount: Numeric;
+    maxAmount: Numeric;
+    feePercent: Numeric;
+};
+export type InitCardConfigParams = {
+    zicOwnerAddress?: Address;
+    cardVaultAddress: Address;
+    revenueVaultAddress: Address;
+    commissionVaultAddress: Address;
+    usdcAddress: Address;
+    revenueFeePercent: Numeric;
+    nativeFeePercent: Numeric;
+    nonNativeFeePercent: Numeric;
+    carbonFeePercent: Numeric;
+    minCardAmount: Numeric;
+    maxCardAmount: Numeric;
+    dailyCardPurchaseLimit: Numeric;
+    feeTiers: CardFeeTier[];
+};
+export type InitPartnerCardConfigParams = {
+    zicOwnerAddress?: Address;
+    cardVaultAddress: Address;
+    revenueVaultAddress: Address;
+    usdcAddress: Address;
+    carbonFeePercent: Numeric;
+    minCardAmount: Numeric;
+    maxCardAmount: Numeric;
+    dailyCardPurchaseLimit: Numeric;
+    feeTiers: CardFeeTier[];
+};
+export type SetCardConfigParams = {
+    zicOwnerAddress?: Address;
+    newZicOwnerAddress: Address;
+    cardVaultAddress: Address;
+    revenueVaultAddress: Address;
+    commissionVaultAddress: Address;
+    revenueFeePercent: Numeric;
+    nativeFeePercent: Numeric;
+    nonNativeFeePercent: Numeric;
+    carbonFeePercent: Numeric;
+    minCardAmount: Numeric;
+    maxCardAmount: Numeric;
+    dailyCardPurchaseLimit: Numeric;
+    feeTiers: CardFeeTier[];
+};
+export type SetPartnerCardConfigParams = {
+    zicOwnerAddress?: Address;
+    newZicOwnerAddress: Address;
+    cardVaultAddress: Address;
+    revenueVaultAddress: Address;
+    carbonFeePercent: Numeric;
+    minCardAmount: Numeric;
+    maxCardAmount: Numeric;
+    dailyCardPurchaseLimit: Numeric;
+    feeTiers: CardFeeTier[];
+};
+export type SetPartnerCustomFeesParams = {
+    zicOwnerAddress?: Address;
+    tokenFeeList: TokenFeeRecord[];
+};
+export type DeletePartnerCustomFeesParams = {
+    zicOwnerAddress?: Address;
+    tokenAddressList: Address[];
+    partnershipName: string;
+};
+export type SetCustomFeesParams = {
+    zicOwnerAddress?: Address;
+    tokenFeeList: TokenFeeRecord[];
+};
+export type TokenFeeRecord = {
+    tokenAddress: Address;
+    fee: Numeric;
+};
+export type DeleteCustomFeesParams = {
+    zicOwnerAddress?: Address;
+    tokenAddressList: Address[];
+};
+export type CardPurchaseInfo = {
+    address: Address;
+    index: bigint;
+    buyerAddress: Address;
+    amount: Numeric;
+    purchaseAt: number;
+};
+export type UserPurchaseRecordInfo = {
+    address: Address;
+    owner: Address;
+    lastCardBoughtTimestamp: number;
+    totalCardBoughtPerDay: Numeric;
+};
+export type PartnerCardConfigInfo = {
+    address: Address;
+    partnerName: string;
+    index: bigint;
+    zicOwner: Address;
+    carbonFeePercent: Numeric;
+    usdcMint: Address;
+    revenueVault: Address;
+    cardVault: Address;
+    totalCardSold: Numeric;
+    providerConfig: ProviderConfig;
+    dailyCardPurchaseLimit: Numeric;
+};
+export type CardConfigInfo = {
+    address: Address;
+    index: bigint;
+    zicOwner: Address;
+    nativeFeePercent: Numeric;
+    nonNativeFeePercent: Numeric;
+    revenueFeePercent: Numeric;
+    carbonFeePercent: Numeric;
+    usdcMint: Address;
+    revenueVault: Address;
+    commissionVault: Address;
+    cardVault: Address;
+    totalCardSold: Numeric;
+    providerConfig: ProviderConfig;
+    dailyCardPurchaseLimit: Numeric;
+};
+export type ProviderConfig = {
+    minCardAmount: Numeric;
+    maxCardAmount: Numeric;
+    feeTiers: CardFeeTier[];
+};
+export type CardPurchaseOfDay = {
+    totalCardPurchased: string;
+    cardPurchasedTimestamp: number;
+};
+export type EvmCardConfig = {
+    nativeFeePercent: string;
+    nonNativeFeePercent: string;
+    revenueFeePercent: string;
+    totalCardSold: bigint;
+    cardVault: string;
+    revenueVault: string;
+    commissionVault: string;
+    usdcAddress: string;
+    minCardAmount: string;
+    maxCardAmount: string;
+    dailyCardPurchaseLimit: string;
+};
+export type SuiNetwork = "mainnet" | "devnet" | "testnet";
+export type SuiCardConfig = {
+    id: string;
+    admin: string;
+    cardVault: string;
+    dailyCardBuyLimit: string;
+    maxCardAmount: string;
+    minCardAmount: string;
+    nativeFee: string;
+    nonNativeFee: string;
+    revenueFee: string;
+    revenueVault: string;
+    version: string;
+    usdcAddress: string;
+};
+export type SuiFeeTier = {
+    minAmount: string;
+    maxAmount: string;
+    fee: string;
+};
+export type SuiFeeTierList = {
+    id: string;
+    tiers: SuiFeeTier[];
+    version: string;
+};
+export type SuiSwapFee = {
+    tokenType: string;
+    fee: string;
+};
+export type SuiSwapFeeList = {
+    id: string;
+    version: string;
+    swapFees: SuiSwapFee[];
+};
+export type DecimalString = string;
+export type NumberString = string;
+export type SuiAddress = string;
+export type Percent = number;
+export interface SuiSignTransactionInput {
+    transaction: Transaction | string;
+}
+export interface SuiSignTransactionOutput {
+    bytes: string;
+    signature: string;
+}
+export type SuiSignTransactionMethod = (transactionInput: SuiSignTransactionInput) => Promise<SuiSignTransactionOutput>;
+export interface WalletInterface {
+    address: string;
+    signTransaction?: SuiSignTransactionMethod;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/utils.d.ts

@@ -0,0 +1,5 @@
+import type { ClientWithCoreApi } from "@mysten/sui/client";
+import type { Signer } from "@mysten/sui/cryptography";
+import type { SuiSignTransactionInput, SuiSignTransactionOutput } from "./types.js";
+export declare function createSuiSignTransactionMethodFromSigner(signer: Signer, suiClient?: ClientWithCoreApi): (transactionInput: SuiSignTransactionInput) => Promise<SuiSignTransactionOutput>;
+export declare function getCoinDecimals(client: ClientWithCoreApi, coinType: string): Promise<number>;

package/dist/utils.js

@@ -0,0 +1,39 @@
+import { Transaction } from "@mysten/sui/transactions";
+import { SUI_USDC_COIN_TYPE } from "./constants.js";
+export function createSuiSignTransactionMethodFromSigner(signer, suiClient) {
+    return async (transactionInput) => {
+        let transaction;
+        if (typeof transactionInput.transaction === "string") {
+            transaction = Transaction.from(transactionInput.transaction);
+        }
+        else {
+            transaction = transactionInput.transaction;
+        }
+        const signatureWithBytes = await transaction.sign({
+            signer: signer,
+            client: suiClient,
+        });
+        return {
+            signature: signatureWithBytes.signature,
+            bytes: signatureWithBytes.bytes,
+        };
+    };
+}
+const coinTypeToDecimalMap = new Map([
+    [SUI_USDC_COIN_TYPE.devnet, 6],
+    [SUI_USDC_COIN_TYPE.mainnet, 6],
+    // [SUI_USDC_COIN_TYPE.Testnet, 6],
+]);
+export async function getCoinDecimals(client, coinType) {
+    if (coinTypeToDecimalMap.has(coinType)) {
+        // biome-ignore lint/style/noNonNullAssertion: we check for existence of the key before calling get, so it won't be null
+        return coinTypeToDecimalMap.get(coinType);
+    }
+    const metadata = await client.core.getCoinMetadata({ coinType });
+    if (!metadata.coinMetadata) {
+        throw new Error("Could not find metadata for given coin type.");
+    }
+    // console.log("coin metadata:", metadata.coinMetadata);
+    coinTypeToDecimalMap.set(coinType, metadata.coinMetadata.decimals);
+    return metadata.coinMetadata.decimals;
+}

package/package.json

@@ -0,0 +1,57 @@
+{
+	"author": "Zebec Network",
+	"dependencies": {
+		"@coral-xyz/anchor": "^0.31.1",
+		"@metaplex-foundation/mpl-token-metadata": "^3.4.0",
+		"@metaplex-foundation/umi": "^1.5.1",
+		"@metaplex-foundation/umi-bundle-defaults": "^1.5.1",
+		"@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.1.1",
+		"@zebec-network/solana-common": "^2.3.1",
+		"bignumber.js": "^10.0.2",
+		"bn.js": "^5.2.3",
+		"buffer": "^6.0.3",
+		"ethers": "^6.16.0"
+	},
+	"description": "An SDK for performing admin operation in zebec smart contract in multiple chains",
+	"devDependencies": {
+		"@mysten/bcs": "^2.0.2",
+		"@mysten/sui": "^2.7.0",
+		"@typechain/ethers-v6": "^0.5.1",
+		"@types/bn.js": "^5.2.0",
+		"@types/mocha": "^10.0.10",
+		"@types/node": "^25.3.0",
+		"dotenv": "^17.3.1",
+		"mocha": "^11.7.5",
+		"rimraf": "^6.1.3",
+		"ts-mocha": "^11.1.0",
+		"ts-node": "^10.9.2",
+		"typechain": "^8.3.2",
+		"typescript": "^5.9.3"
+	},
+	"files": [
+		"dist"
+	],
+	"license": "MIT",
+	"main": "dist/index.js",
+	"name": "@zebec-network/admin-sdk",
+	"peerDependencies": {
+		"@coral-xyz/anchor": "^0.31.1",
+		"@mysten/bcs": "^2.0.2",
+		"@mysten/sui": "^2.7.0",
+		"ethers": "^6.16.0"
+	},
+	"scripts": {
+		"build": "npm run clean && tsc",
+		"clean": "rimraf ./dist",
+		"format": "npx @biomejs/biome format --write",
+		"gen:typechain": "typechain --target ethers-v6 --out-dir \"src/artifacts/typechain-types\" \"src/artifacts/abi/*.json\"",
+		"start": "ts-node src/index.ts",
+		"test": "ts-mocha -p ./tsconfig.json -b -t 1000000000 test/**/*.test.ts",
+		"test:single": "ts-mocha -p ./tsconfig.json -b -t 1000000000"
+	},
+	"type": "module",
+	"version": "1.0.0"
+}