@zebec-network/exchange-card-sdk 1.5.0 → 1.6.1

package/README.md

@@ -22,7 +22,7 @@ Example:
 
 For EVM compatible networks:
 
-```typescript
+````typescript
 For Bittensor Network:
 
 ```typescript
@@ -40,7 +40,7 @@ const service = new ZebecCardTAOService(
         sandbox: true, // Set to true for development or testing
     },
 );
-```
+````
 
 ### Fetch Quote
 

package/dist/constants.d.ts

@@ -1,3 +1,4 @@
+import { BobaChainId } from "./types";
 export declare const CARD_API_URL: Record<"Production" | "Sandbox", string>;
 export declare const NEAR_RPC_URL: Record<"Production" | "Sandbox", string>;
 export declare const XRPL_RPC_URL: Record<"Production" | "Sandbox", string>;
@@ -15,6 +16,7 @@ export declare const BITCOIN_ENDPOINTS: {
     readonly Sandbox: "https://mempool.space/testnet/api";
     readonly Production: "https://mempool.space/api";
 };
+export declare const BOBA_CHAIN_ID: Record<"mainnet" | "testnet", BobaChainId>;
 export declare const DEFAULT_EVM_GAS_LIMIT = 3000000;
 export declare const COUNTRIES_WITH_CCA3: readonly [{
     readonly name: {

package/dist/constants.js

@@ -31,6 +31,10 @@ export const BITCOIN_ENDPOINTS = {
     Sandbox: "https://mempool.space/testnet/api",
     Production: "https://mempool.space/api",
 };
+export const BOBA_CHAIN_ID = {
+    mainnet: 288,
+    testnet: 28882,
+};
 export const DEFAULT_EVM_GAS_LIMIT = 3000000;
 export const COUNTRIES_WITH_CCA3 = [
     {

package/dist/services/bobaService.d.ts

@@ -0,0 +1,40 @@
+import { ethers } from "ethers";
+import { APIConfig } from "../helpers/apiHelpers";
+import { BobaChainId, Quote } from "../types";
+export type TransferBobaParams = {
+    amount: string | number;
+    overrides?: Omit<ethers.Overrides, "from" | "value" | "chainId">;
+};
+export type TransferTokenParams = {
+    amount: string | number;
+    tokenAddress: string;
+    symbol: string;
+    overrides?: Omit<ethers.Overrides, "from" | "value" | "chainId">;
+};
+export declare class BobaService {
+    readonly signer: ethers.Signer;
+    readonly apiConfig: APIConfig;
+    readonly network: "mainnet" | "testnet";
+    readonly chainId: BobaChainId;
+    private readonly apiService;
+    constructor(signer: ethers.Signer, apiConfig: APIConfig, sdkOptions?: {
+        sandbox?: boolean;
+    });
+    /**
+     * Fetches a quote for Bitcoin transfer.
+     *
+     * @returns {Promise<Quote>} A promise that resolves to a Quote object.
+     */
+    fetchQuote(symbol: string): Promise<Quote>;
+    /**
+     * Fetches the Bitcoin vault address.
+     *
+     * @returns {Promise<{ address: string }>} A promise that resolves to the vault address.
+     */
+    fetchVault(symbol: string): Promise<{
+        address: string;
+        tag?: string;
+    }>;
+    transferBobaEth(params: TransferBobaParams): Promise<ethers.TransactionReceipt | null>;
+    transferToken(params: TransferTokenParams): Promise<ethers.TransactionReceipt | null>;
+}

package/dist/services/bobaService.js

@@ -0,0 +1,83 @@
+import { ethers } from "ethers";
+import { ERC20__factory } from "../artifacts";
+import { BOBA_CHAIN_ID, DEFAULT_EVM_GAS_LIMIT } from "../constants";
+import { ZebecCardAPIService } from "../helpers/apiHelpers";
+export class BobaService {
+    signer;
+    apiConfig;
+    network;
+    chainId;
+    apiService;
+    constructor(signer, apiConfig, sdkOptions) {
+        this.signer = signer;
+        this.apiConfig = apiConfig;
+        this.network = sdkOptions?.sandbox ? "testnet" : "mainnet";
+        this.chainId = BOBA_CHAIN_ID[this.network];
+        this.apiService = new ZebecCardAPIService(apiConfig, sdkOptions?.sandbox || false);
+    }
+    /**
+     * Fetches a quote for Bitcoin transfer.
+     *
+     * @returns {Promise<Quote>} A promise that resolves to a Quote object.
+     */
+    async fetchQuote(symbol) {
+        const res = await this.apiService.fetchQuote(symbol);
+        return res;
+    }
+    /**
+     * Fetches the Bitcoin vault address.
+     *
+     * @returns {Promise<{ address: string }>} A promise that resolves to the vault address.
+     */
+    async fetchVault(symbol) {
+        const data = await this.apiService.fetchVault(symbol);
+        return data;
+    }
+    async transferBobaEth(params) {
+        const parsedAmount = ethers.parseEther(params.amount.toString());
+        const provider = this.signer.provider;
+        const vault = await this.fetchVault("BOBA-ETH");
+        const recipientAddress = vault.address;
+        if (!provider) {
+            throw new Error("There is no provider in signer instance.");
+        }
+        const senderBalance = await provider.getBalance(this.signer);
+        if (senderBalance < parsedAmount) {
+            throw new Error("Insufficient balance for transaction.");
+        }
+        const overides = {
+            gasLimit: DEFAULT_EVM_GAS_LIMIT,
+            ...params.overrides,
+        };
+        const response = await this.signer.sendTransaction({
+            ...overides,
+            to: recipientAddress,
+            value: parsedAmount,
+            from: this.signer,
+            chainId: this.chainId,
+        });
+        console.debug("Boba Transaction Hash:", response.hash);
+        const receipt = await response.wait();
+        return receipt;
+    }
+    async transferToken(params) {
+        const tokenContract = ERC20__factory.connect(params.tokenAddress, this.signer);
+        const tokenDecimals = await tokenContract.decimals();
+        const parsedAmount = ethers.parseUnits(params.amount.toString(), tokenDecimals);
+        const vault = await this.fetchVault(params.symbol);
+        const recipientAddress = vault.address;
+        const senderBalance = await tokenContract.balanceOf(this.signer);
+        if (senderBalance < parsedAmount) {
+            throw new Error("Insufficient balance for transaction.");
+        }
+        const overides = {
+            gasLimit: DEFAULT_EVM_GAS_LIMIT,
+            ...params.overrides,
+            chainId: this.chainId,
+        };
+        const response = await tokenContract.transfer(recipientAddress, parsedAmount, overides);
+        console.debug("Boba Transaction Hash:", response.hash);
+        const receipt = await response.wait();
+        return receipt;
+    }
+}

package/dist/services/index.d.ts

@@ -4,3 +4,4 @@ export * from "./nearService";
 export * from "./algorandService";
 export * from "./xdbService";
 export * from "./octaService";
+export * from "./bobaService";

package/dist/services/index.js

@@ -5,3 +5,4 @@ export * from "./nearService";
 export * from "./algorandService";
 export * from "./xdbService";
 export * from "./octaService";
+export * from "./bobaService";

package/dist/services/octaService.js

@@ -41,8 +41,8 @@ export class OctaService {
             throw new Error("Insufficient balance for transaction.");
         }
         const overides = {
-            ...params.overrides,
             gasLimit: DEFAULT_EVM_GAS_LIMIT,
+            ...params.overrides,
         };
         const response = await this.signer.sendTransaction({
             ...overides,

package/dist/types.d.ts

@@ -3,3 +3,4 @@ export type Quote = {
     fluctuationPercentage: number;
     token: string;
 };
+export type BobaChainId = 288 | 28882;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zebec-network/exchange-card-sdk",
-	"version": "1.5.0",
+	"version": "1.6.1",
 	"description": "An sdk for purchasing silver card in zebec",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -21,7 +21,6 @@
 		"@near-js/keystores": "^2.3.0",
 		"@near-js/signers": "^2.3.0",
 		"@typechain/ethers-v6": "^0.5.1",
-		"@types/jsonwebtoken": "^9.0.7",
 		"@types/mocha": "^10.0.10",
 		"@types/node": "^24.3.1",
 		"dotenv": "^17.2.2",