@zebec-network/admin-sdk 1.0.0

package/dist/services/evmCardService.js

@@ -0,0 +1,322 @@
+import { bpsToPercent, percentToBps } from "@zebec-network/core-utils";
+import { ethers } from "ethers";
+import { OdysseyZebecCard__factory, Token__factory, Weth__factory, ZebecCard__factory, } from "../artifacts/index.js";
+import { DEFAULT_GAS_LIMIT, ODYSSEY_CHAIN_IDS, parseSupportedChain, USDC_ADDRESS, WETH_ADDRESS, ZEBEC_EVM_CARD_ADDRESS, } from "../constants.js";
+export class ZebecCardService {
+    signer;
+    chainId;
+    zebecCard;
+    usdcToken;
+    weth;
+    /**
+     * Create instance of ZebecCardService.
+     * @param signer ethers signer
+     * @param chainId chain ID supported by sdk
+     */
+    constructor(signer, chainId) {
+        this.signer = signer;
+        this.chainId = chainId;
+        const chain = parseSupportedChain(chainId);
+        const zebecCardAddress = ZEBEC_EVM_CARD_ADDRESS[chain];
+        const usdcAddress = USDC_ADDRESS[chain];
+        const wethAddress = WETH_ADDRESS[chain];
+        this.zebecCard = ODYSSEY_CHAIN_IDS.includes(chainId)
+            ? OdysseyZebecCard__factory.connect(zebecCardAddress, signer)
+            : ZebecCard__factory.connect(zebecCardAddress, signer);
+        this.usdcToken = Token__factory.connect(usdcAddress, signer);
+        this.weth = Weth__factory.connect(wethAddress, signer);
+    }
+    /**
+     *	Sets Native Fee in card config.
+     *
+     *  Can only be invoked admin.
+     *
+     * @param params
+     * @returns
+     */
+    async setNativeFee(params) {
+        const feeInBps = BigInt(percentToBps(params.feeInPercent));
+        const overrides = {
+            ...params.overrides,
+            gasLimit: params.overrides?.gasLimit || DEFAULT_GAS_LIMIT, // Default
+        };
+        return this.zebecCard.setNativeFee(feeInBps, overrides);
+    }
+    /**
+     * Sets NonNative Fee in card config
+     *
+     * Can only be invoked admin.
+     *
+     * @param params
+     * @returns
+     */
+    async setNonNativeFee(params) {
+        const feeInBps = BigInt(percentToBps(params.feeInPercent));
+        const overrides = {
+            ...params.overrides,
+            gasLimit: params.overrides?.gasLimit || DEFAULT_GAS_LIMIT, // Default
+        };
+        return this.zebecCard.setNonNativeFee(feeInBps, overrides);
+    }
+    /**
+     * Sets Revenue Fee in card config
+     *
+     * Can only be invoked admin.
+     *
+     * @param params
+     * @returns
+     */
+    async setRevenueFee(params) {
+        const feeInBps = BigInt(percentToBps(params.feeInPercent));
+        const overrides = {
+            ...params.overrides,
+            gasLimit: params.overrides?.gasLimit || DEFAULT_GAS_LIMIT, // Default
+        };
+        return this.zebecCard.setRevenueFee(feeInBps, overrides);
+    }
+    /**
+     * Sets Revenue vault address in card config
+     *
+     * Can only be invoked admin.
+     *
+     * @param params
+     * @returns
+     */
+    async setRevenueVault(params) {
+        const overrides = {
+            ...params.overrides,
+            gasLimit: params.overrides?.gasLimit || DEFAULT_GAS_LIMIT, // Default
+        };
+        return this.zebecCard.setRevenueVault(params.vaultAddress, overrides);
+    }
+    /**
+     * Sets commission vault address in card config
+     *
+     * Can only be invoked admin.
+     *
+     * @param params
+     * @returns
+     */
+    async setCommissionVault(params) {
+        const overrides = {
+            ...params.overrides,
+            gasLimit: params.overrides?.gasLimit || DEFAULT_GAS_LIMIT,
+        };
+        return this.zebecCard.setComissionVault(params.vaultAddress, overrides);
+    }
+    /**
+     * Sets card vault address in card config
+     *
+     * Can only be invoked admin.
+     *
+     */
+    async setCardVault(params) {
+        const overrides = {
+            ...params.overrides,
+            gasLimit: params.overrides?.gasLimit || DEFAULT_GAS_LIMIT, // Default
+        };
+        return this.zebecCard.setCardVault(params.vaultAddress, overrides);
+    }
+    /**
+     * Sets usdc address in card config
+     * Can only be invoked by admin
+     */
+    async setUsdcAddress(params) {
+        const overrides = {
+            ...params.overrides,
+            gasLimit: params.overrides?.gasLimit || DEFAULT_GAS_LIMIT, // Default
+        };
+        return this.zebecCard.setUsdcAddress(params.tokenAddress, overrides);
+    }
+    /**
+     * Sets minimum card amount for purchasing card in card config
+     */
+    async setMinCardAmount(params) {
+        const decimals = await this.usdcToken.decimals();
+        const minCardAmount = ethers.parseUnits(params.minCardAmount, decimals);
+        const overrides = {
+            ...params.overrides,
+            gasLimit: params.overrides?.gasLimit || DEFAULT_GAS_LIMIT, // Default
+        };
+        return this.zebecCard.setMinCardAmount(minCardAmount, overrides);
+    }
+    /**
+     * Sets maximum card amount for purchasing card  in card config
+     */
+    async setMaxCardAmount(params) {
+        const decimals = await this.usdcToken.decimals();
+        const maxCardAmount = ethers.parseUnits(params.maxCardAmount, decimals);
+        const overrides = {
+            ...params.overrides,
+            gasLimit: params.overrides?.gasLimit || DEFAULT_GAS_LIMIT, // Default
+        };
+        return this.zebecCard.setMaxCardAmount(maxCardAmount, overrides);
+    }
+    /**
+     * Sets daily card purchase limit in card config
+     */
+    async setDailyCardPurchaseLimit(params) {
+        const decimals = await this.usdcToken.decimals();
+        const dailyCardPurchaseLimit = ethers.parseUnits(params.dailyCardPurchaseLimit, decimals);
+        const overrides = {
+            ...params.overrides,
+            gasLimit: params.overrides?.gasLimit || DEFAULT_GAS_LIMIT, // Default
+        };
+        return this.zebecCard.setDailyCardBuyLimit(dailyCardPurchaseLimit, overrides);
+    }
+    /**
+     * Updates fee for given min - max (range) amount and inserts if range in not found.
+     */
+    async setFee(params) {
+        const decimals = await this.usdcToken.decimals();
+        const minAmount = ethers.parseUnits(params.minAmount, decimals);
+        const maxAmount = ethers.parseUnits(params.maxAmount, decimals);
+        const fee = percentToBps(params.feePercent);
+        const overrides = {
+            ...params.overrides,
+            gasLimit: params.overrides?.gasLimit || DEFAULT_GAS_LIMIT, // Default
+        };
+        return this.zebecCard.setFee(minAmount, maxAmount, fee, overrides);
+    }
+    /**
+     * Sets fee tiers only be invoked by admin
+     */
+    async setFeeTiers(params) {
+        const parsedFeeTiers = await this._parseFeeTiers(params.feeTiers);
+        const overrides = {
+            ...params.overrides,
+            gasLimit: params.overrides?.gasLimit || DEFAULT_GAS_LIMIT, // Default
+        };
+        return this.zebecCard.setFeeArray(parsedFeeTiers, overrides);
+    }
+    async _parseFeeTiers(feeTiers) {
+        const decimals = await this.usdcToken.decimals();
+        return feeTiers.map((feeTier) => {
+            return {
+                fee: percentToBps(feeTier.feePercent),
+                minAmount: ethers.parseUnits(feeTier.minAmount.toString(), decimals),
+                maxAmount: ethers.parseUnits(feeTier.maxAmount.toString(), decimals),
+            };
+        });
+    }
+    async setCustomFee(params) {
+        const fee = percentToBps(params.fee.toString());
+        const overrides = {
+            ...params.overrides,
+            gasLimit: params.overrides?.gasLimit || DEFAULT_GAS_LIMIT, // Default
+        };
+        return this.zebecCard.setCustomTokenFee(params.tokenAddress, fee, overrides);
+    }
+    async getCustomFee(params) {
+        const fee = await this.zebecCard.getCustomTokenFee(params.tokenAddress);
+        return bpsToPercent(fee.toString());
+    }
+    async setReloadableFee(params) {
+        const fee = percentToBps(params.fee.toString());
+        const overrides = {
+            ...params.overrides,
+            gasLimit: params.overrides?.gasLimit || DEFAULT_GAS_LIMIT, // Default
+        };
+        return this.zebecCard.setReloadableFee(fee, overrides);
+    }
+    async getReloadableFee() {
+        const fee = await this.zebecCard.getReloadableFee();
+        return bpsToPercent(fee.toString());
+    }
+    /**
+     * Gets user's card purchase
+     * @param params
+     * @returns
+     */
+    async getCardPurhcaseOfDay(params) {
+        const decimals = await this.usdcToken.decimals();
+        const cardPurchase = await this.zebecCard.cardPurchases(params.userAddress);
+        const totalCardPurchased = ethers.formatUnits(cardPurchase.totalCardBoughtPerDay, decimals);
+        const cardPurchasedTimestamp = Number(cardPurchase.unixInRecord.toString());
+        return {
+            totalCardPurchased,
+            cardPurchasedTimestamp,
+        };
+    }
+    /**
+     * Gets Zebec Instant Card contract configs
+     * @returns
+     */
+    async getCardConfig() {
+        const cardConfig = await this.zebecCard.cardConfig();
+        const nativeFeePercent = bpsToPercent(cardConfig.nativeFee.toString());
+        const nonNativeFeePercent = bpsToPercent(cardConfig.nonNativeFee.toString());
+        const revenueFeePercent = bpsToPercent(cardConfig.revenueFee.toString());
+        const decimals = await this.usdcToken.decimals();
+        const minCardAmount = ethers.formatUnits(cardConfig.minCardAmount, decimals);
+        const maxCardAmount = ethers.formatUnits(cardConfig.maxCardAmount, decimals);
+        const dailyCardPurchaseLimit = ethers.formatUnits(cardConfig.dailyCardBuyLimit, decimals);
+        return {
+            cardVault: cardConfig.cardVault,
+            commissionVault: cardConfig.commissionVault,
+            revenueVault: cardConfig.revenueVault,
+            nativeFeePercent,
+            nonNativeFeePercent,
+            revenueFeePercent,
+            totalCardSold: cardConfig.counter,
+            usdcAddress: cardConfig.usdcAddress,
+            maxCardAmount,
+            minCardAmount,
+            dailyCardPurchaseLimit,
+        };
+    }
+    /**
+     * Gets fee tiers
+     * @returns Array of fee tier
+     */
+    async getFeeTiers() {
+        const decimals = await this.usdcToken.decimals();
+        const feeTiers = await this.zebecCard.getFeeTiers();
+        return feeTiers.map((feeTier) => {
+            return {
+                feePercent: bpsToPercent(feeTier.fee.toString()),
+                maxAmount: ethers.formatUnits(feeTier.maxAmount, decimals),
+                minAmount: ethers.formatUnits(feeTier.minAmount, decimals),
+            };
+        });
+    }
+    /**
+     * Gets admin adddress
+     * @returns
+     */
+    async getAdmin() {
+        return this.zebecCard.owner();
+    }
+    /**
+     * add allowance of given amount of given token to given spender
+     * @param params
+     * @returns
+     */
+    async approve(params) {
+        const token = Token__factory.connect(params.token, this.signer);
+        const decimals = await token.decimals();
+        const parsedAmount = ethers.parseUnits(params.amount, decimals);
+        const allowance = await token.allowance(this.signer, params.spender);
+        const overrides = {
+            ...params.overrides,
+            gasLimit: params.overrides?.gasLimit || DEFAULT_GAS_LIMIT, // Default
+        };
+        if (allowance < parsedAmount) {
+            return await token.approve(params.spender, parsedAmount, overrides);
+        }
+        return null;
+    }
+    /**
+     * Wrap ETH to Wrapped ETH
+     * @param param
+     * @returns
+     */
+    async wrapEth(params) {
+        const parsedAmount = ethers.parseEther(params.amount);
+        const overrides = {
+            ...params.overrides,
+            gasLimit: params.overrides?.gasLimit || DEFAULT_GAS_LIMIT, // Default
+        };
+        return this.weth.deposit({ value: parsedAmount, ...overrides });
+    }
+}

package/dist/services/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./evmCardService.js";
+export * from "./proxyStreamService.js";
+export * from "./solanaCardV2Service.js";
+export * from "./stakingService.js";
+export * from "./streamServices.js";
+export * from "./suiCardService.js";

package/dist/services/index.js

@@ -0,0 +1,6 @@
+export * from "./evmCardService.js";
+export * from "./proxyStreamService.js";
+export * from "./solanaCardV2Service.js";
+export * from "./stakingService.js";
+export * from "./streamServices.js";
+export * from "./suiCardService.js";

package/dist/services/proxyStreamService.d.ts

@@ -0,0 +1,72 @@
+import { type Address, Program, type Provider } from "@coral-xyz/anchor";
+import { Connection, Keypair, PublicKey, type TransactionInstruction } from "@solana/web3.js";
+import { TransactionPayload } from "@zebec-network/solana-common";
+import BN from "bn.js";
+import { type ZebecProxyStreamIdl, type ZebecStreamIdl } from "../artifacts/index.js";
+import type { ProxyConfigInfo, RpcNetwork } from "../types.js";
+export declare class ProxyStreamAdminService {
+    readonly provider: Provider;
+    readonly proxyStreamProgram: Program<ZebecProxyStreamIdl>;
+    readonly streamProgram: Program<ZebecStreamIdl>;
+    readonly network: RpcNetwork;
+    constructor(provider: Provider, proxyStreamProgram: Program<ZebecProxyStreamIdl>, streamProgram: Program<ZebecStreamIdl>, network: RpcNetwork);
+    static create(provider: Provider, network: RpcNetwork): ProxyStreamAdminService;
+    private _createTransactionPayload;
+    get proxyStreamProgramId(): PublicKey;
+    get streamProgramId(): PublicKey;
+    get connection(): Connection;
+    getInitProxyConfigInstruction(admin: PublicKey, feeVault: PublicKey, mintAuthority: PublicKey, proxyConfig: PublicKey, data: {
+        chainId: string;
+        fee: number;
+        minAmount: BN;
+    }): Promise<TransactionInstruction>;
+    initProxyConfig(params: {
+        admin: Address;
+        feeVault: Address;
+        chainId: string;
+        fee: number;
+        minAmount: number;
+    }): Promise<TransactionPayload>;
+    getUpdateProxyConfigInstruction(admin: PublicKey, proxyConfig: PublicKey, data: {
+        fee: number;
+        newAdmin: PublicKey;
+    }): Promise<TransactionInstruction>;
+    updateProxyConfig(params: {
+        admin: Address;
+        chainId: string;
+        fee: number;
+        newAdmin: Address;
+    }): Promise<TransactionPayload>;
+    getSetMintableTokensInstruction(admin: PublicKey, proxyConfig: PublicKey, data: {
+        tokens: PublicKey[];
+    }): Promise<TransactionInstruction>;
+    getWhitelistTokensInstruction(admin: PublicKey, streamConfig: PublicKey, data: {
+        tokens: PublicKey[];
+    }): Promise<TransactionInstruction>;
+    createToken(params: {
+        admin: Address;
+        chainId: string;
+        streamConfigName: string;
+        tokenInfo: {
+            tokenName: string;
+            symbol: string;
+            metadataUri: string;
+            decimals: number;
+            mintKeypair?: Keypair;
+        };
+    }): Promise<TransactionPayload>;
+    updateZTokenMetadata(params: {
+        admin: Address;
+        mint: Address;
+        tokenInfo: {
+            tokenName: string;
+            symbol: string;
+            metadataUri: string;
+        };
+    }): Promise<TransactionPayload>;
+    getEmergencyPauseInstruction(admin: PublicKey): Promise<TransactionInstruction>;
+    emergencyPause(params: {
+        admin: Address;
+    }): Promise<TransactionPayload>;
+    getProxyConfig(chainId: string): Promise<ProxyConfigInfo>;
+}