@zebec-network/exchange-card-sdk 1.5.0-beta.1 → 1.5.0-beta.3

package/README.md

@@ -23,28 +23,6 @@ Example:
 For EVM compatible networks:
 
 ```typescript
-import { ethers } from 'ethers';
-import { ZebecCardService, Recipient, CountryCode } from '@zebec-fintech/silver-card-sdk';
-
-const signer: ethers.Signer = ... ; // Signer instance from Wallet Extension
-
-const chainId = 11155111; // Sepolia testnet
-const apiKey = process.env.API_KEY!;
-const encryptionKey = process.env.ENCRYPTION_KEY!;
-
-const service = new ZebecCardService(
-    signer,
-    chainId,
-    {
-        apiKey,
-        encryptionKey,
-    },
-    {
-        sandbox: true, // Set to true for development or testing
-    },
-);
-```
-
 For Bittensor Network:
 
 ```typescript
@@ -76,264 +54,3 @@ Note: The `fetchQuote` method should be called regularly. Make sure to check it'
 const amount = "150.55"; // Amount in USD
 const quote = await service.fetchQuote(amount);
 ```
-
-#### Response
-
-The `fetchQuote` method returns a quote object with the following fields:
-
-- **id**: Unique quote identifier.
-- **token**: Name or symbol of the token used to purchase the card. (e.g., `"USDC"`, `"TAO"`)
-- **targetCurrency**: Currency code for the amount. (e.g., `"USD"`)
-- **amountRequested**: Amount of USD the card is being purchased for.
-- **pricePerUnitCurrency**: Price of the token per unit USD.
-- **totalPrice**: Total token amount needed for purchase.
-- **platformFee**: Any additional fees charged by the platform.
-- **expiresIn**: Time in milliseconds before the quote expires.
-- **timestamp**: Timestamp when the quote was generated.
-- **status**: Quote status.
-
-### Purchase Card
-
-The `purchaseCard` method initiates a virtual card purchase. It performs four main operations:
-
-1. Approves token spending to the ZebecCard smart contract. (ERC20 tokens only)
-2. Deposits tokens into the user's Zebec vault.
-3. Initiates the card purchase on-chain. (ERC20 tokens only)
-4. Posts transaction data, along with metadata, to the Zebec backend.
-
-The method returns a tuple with responses from each stage of the process.
-
-#### Code Example
-
-For EVM compatible networks:
-
-```typescript
-const participantId = "JohnChamling";
-const firstName = "John";
-const lastName = "Chamling";
-const emailAddress = "user@example.com";
-const mobilePhone = "+91 012345678";
-const language = "en-US";
-const city = "Bharatpur";
-const state = "Bagmati";
-const postalCode = "44200";
-const countryCode: CountryCode = "NPL";
-const address1 = "Shittal street, Bharatpur - 10, Chitwan";
-
-const recipient = Recipient.create(
-	participantId,
-	firstName,
-	lastName,
-	emailAddress,
-	mobilePhone,
-	language,
-	city,
-	state,
-	postalCode,
-	countryCode,
-	address1,
-);
-
-const amount = "150.55";
-const quote = await service.fetchQuote(amount);
-const [depositResponse, buyCardResponse, apiResponse] = await service.purchaseCard({
-	amount,
-	recipient,
-	quote,
-});
-
-console.log("Deposit Transaction Hash:", depositResponse.hash);
-console.log("Purchase Transaction Hash:", buyCardResponse.hash);
-console.log("Zebec Server Response:", apiResponse.data);
-```
-
-For Bittensor Network:
-
-```typescript
-const participantId = "JohnChamling";
-const firstName = "John";
-const lastName = "Chamling";
-const emailAddress = "user@example.com";
-const mobilePhone = "+91 012345678";
-const language = "en-US";
-const city = "Bharatpur";
-const state = "Bagmati";
-const postalCode = "44200";
-const countryCode: CountryCode = "NPL";
-const address1 = "Shittal street, Bharatpur - 10, Chitwan";
-
-const recipient = Recipient.create(
-	participantId,
-	firstName,
-	lastName,
-	emailAddress,
-	mobilePhone,
-	language,
-	city,
-	state,
-	postalCode,
-	countryCode,
-	address1,
-);
-
-const amount = "150.55"; // Amount in USD
-const quote = await service.fetchQuote(amount);
-const [depositResponse, apiResponse] = await service.purchaseCard({
-	walletAddress: signer.address || "<wallet_address>",
-	amount,
-	recipient,
-	quote,
-});
-
-console.log(
-	`Deposit response: \n BlockHash: ${depositResponse.blockHash} \n TransactionHash: ${depositResponse.txHash}`,
-);
-console.log("Zebec Server Response:", apiResponse.data);
-```
-
----
-
-## Configuration Parameters
-
-### ZebecCardService
-
-To create an instance of `ZebecCardService`, you need:
-
-- **signer**: An instance of `ethers.Signer`.
-- **chainId**: The ID of the blockchain (see list of supported chains below).
-- **apiConfig**: Object containing `apiKey` and `encryptionKey`.
-- **sdkConfig (optional)**: SDK-specific settings, such as:
-  - `sandbox`: Boolean, set to `true` for testnets.
-
-### ZebecCardTAOService
-
-To create an instance of `ZebecCardTAOService`, you need:
-
-- **signer**: An instance of `Keyring` or `Signer`.
-- **apiConfig**: Object containing `apiKey` and `encryptionKey`.
-- **sdkConfig (optional)**: SDK-specific settings, such as:
-  - `sandbox`: Boolean, set to `true` for testnets.
-
-### EVM Supported Chains
-
-| Chain               | Chain ID                        |
-| ------------------- | ------------------------------- |
-| Ethereum            | Mainnet (1), Sepolia (11155111) |
-| Binance Smart Chain | Mainnet (56), Testnet (97)      |
-| Base                | Mainnet (8453)                  |
-
----
-
-## Recipient Fields
-
-To create a valid `Recipient` instance, provide the following details:
-
-- **participantId** (alphanumeric string): Unique identifier for the buyer end user. 1-20 chars.
-- **firstName**, **lastName** (string): Participant's full name.
-- **emailAddress** (string): Contact email. 1-80 chars
-- **mobilePhone** (string): Mobile number with country code.
-- **language** (string): Language code (e.g., `"en-US"`).
-- **city**, **state**, **postalCode** (string): Location details.
-- **countryCode** (CountryCode enum): ISO 3166-1 alpha-3 country code.
-- **address1** (string): Street address. (max 50 chars)
-
----
-
-## Responses
-
-The `purchaseCard` method returns three responses:
-
-1. **depositResponse**: Transaction response for token deposit.
-2. **buyCardResponse**: Transaction response for card purchase. (EVM only)
-3. **apiResponse**: API response from Zebec's backend with additional transaction metadata.
-
----
-
-## Environment Variables
-
-- **API_KEY**: Your Zebec API Key.
-- **ENCRYPTION_KEY**: Your Zebec encryption key for secure data handling.
-
----
-
-## Supported Countries
-
-| Country                          | Code |
-| -------------------------------- | ---- |
-| Algeria                          | DZA  |
-| Angola                           | AGO  |
-| Argentina                        | ARG  |
-| Australia                        | AUS  |
-| Austria                          | AUT  |
-| Belgium                          | BEL  |
-| Bolivia (Plurinational State of) | BOL  |
-| Brazil                           | BRA  |
-| Cameroon                         | CMR  |
-| Canada                           | CAN  |
-| Chile                            | CHL  |
-| Costa Rica                       | CRI  |
-| Cyprus                           | CYP  |
-| Czechia                          | CZE  |
-| Denmark                          | DNK  |
-| Ecuador                          | ECU  |
-| Egypt                            | EGY  |
-| El Salvador                      | SLV  |
-| Estonia                          | EST  |
-| Finland                          | FIN  |
-| France                           | FRA  |
-| Georgia                          | GEO  |
-| Germany                          | DEU  |
-| Ghana                            | GHA  |
-| Greece                           | GRC  |
-| Guatemala                        | GTM  |
-| Honduras                         | HND  |
-| Hungary                          | HUN  |
-| Iceland                          | ISL  |
-| Ireland                          | IRL  |
-| Italy                            | ITA  |
-| Jamaica                          | JAM  |
-| Japan                            | JPN  |
-| Jordan                           | JOR  |
-| Kenya                            | KEN  |
-| Korea, Republic of Korea         | KOR  |
-| Kuwait                           | KWT  |
-| Lithuania                        | LTU  |
-| Luxembourg                       | LUX  |
-| Malawi                           | MWI  |
-| Malaysia                         | MYS  |
-| Malta                            | MLT  |
-| Mexico                           | MEX  |
-| Morocco                          | MAR  |
-| Mozambique                       | MOZ  |
-| Nepal                            | NPL  |
-| Netherlands                      | NLD  |
-| New Zealand                      | NZL  |
-| Nigeria                          | NGA  |
-| Norway                           | NOR  |
-| Oman                             | OMN  |
-| Pakistan                         | PAK  |
-| Papua New Guinea                 | PNG  |
-| Paraguay                         | PRY  |
-| Peru                             | PER  |
-| Philippines                      | PHL  |
-| Poland                           | POL  |
-| Portugal                         | PRT  |
-| Puerto Rico                      | PRI  |
-| Qatar                            | QAT  |
-| Romania                          | ROU  |
-| Saudi Arabia                     | SAU  |
-| Singapore                        | SGP  |
-| Slovakia                         | SVK  |
-| Slovenia                         | SVN  |
-| Spain                            | ESP  |
-| Sweden                           | SWE  |
-| Taiwan                           | TWN  |
-| Thailand                         | THA  |
-| Trinidad and Tobago              | TTO  |
-| Tunisia                          | TUN  |
-| Turkey                           | TUR  |
-| United Kingdom                   | GBR  |
-| United States                    | USA  |
-| Uruguay                          | URY  |
-| Vanuatu                          | VUT  |
-| Zambia                           | ZMB  |

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./artifacts";
+export * from "./helpers/apiHelpers";
 export * from "./constants";
 export * from "./services";
 export * from "./types";

package/dist/index.js

@@ -1,4 +1,5 @@
 export * from "./artifacts";
+export * from "./helpers/apiHelpers";
 export * from "./constants";
 export * from "./services";
 export * from "./types";

package/dist/services/index.d.ts

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

package/dist/services/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zebec-network/exchange-card-sdk",
-	"version": "1.5.0-beta.1",
+	"version": "1.5.0-beta.3",
 	"description": "An sdk for purchasing silver card in zebec",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",
@@ -37,11 +37,11 @@
 	"dependencies": {
 		"@algorandfoundation/algokit-utils": "^9.1.1",
 		"@mempool/mempool.js": "^3.0.0",
-		"@near-js/crypto": "^2.0.1",
-		"@near-js/providers": "^2.0.1",
-		"@near-js/transactions": "^2.0.1",
-		"@near-js/types": "^2.0.1",
-		"@near-js/utils": "^2.0.1",
+		"@near-js/crypto": "^2.2.5",
+		"@near-js/providers": "^2.2.5",
+		"@near-js/transactions": "^2.2.5",
+		"@near-js/types": "^2.2.5",
+		"@near-js/utils": "^2.2.5",
 		"@stellar/stellar-sdk": "^13.1.0",
 		"algosdk": "^3.3.1",
 		"axios": "^1.7.7",
@@ -64,4 +64,4 @@
 	"publishConfig": {
 		"access": "public"
 	}
-}
+}

package/dist/services/zanoService.d.ts

@@ -1,56 +0,0 @@
-import { APIAsset, BalanceInfo } from "zano_web3/server";
-import { APIConfig } from "../helpers/apiHelpers";
-import { Quote } from "../types";
-export interface ZanoServiceConfig {
-    walletUrl: string;
-    daemonUrl: string;
-    walletAuthToken: string;
-}
-export interface ZanoTransferParams {
-    assetId: string;
-    amount: string;
-    comment?: string;
-}
-export declare class ZanoService {
-    readonly apiConfig: APIConfig;
-    private readonly serverWallet;
-    private readonly apiService;
-    constructor(config: ZanoServiceConfig, 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;
-    }>;
-    /**
-     * Send a transfer
-     */
-    transferAssets(params: ZanoTransferParams): Promise<string>;
-    /**
-     * Get asset information
-     */
-    getAssetDetails(assetId: string): Promise<APIAsset>;
-    /**
-     * Validate if the amount is valid for the given asset
-     */
-    validateAmount(amount: string, decimalPoints: number): boolean;
-    /**
-     * Get wallet balances
-     */
-    getBalances(): Promise<BalanceInfo[]>;
-    /**
-     * Get balance for a specific asset
-     */
-    getAssetBalance(assetId: string): Promise<BalanceInfo | null>;
-}

package/dist/services/zanoService.js

@@ -1,107 +0,0 @@
-import { BigNumber } from "bignumber.js";
-import { ServerWallet } from "zano_web3/server";
-import { ZebecCardAPIService } from "../helpers/apiHelpers";
-export class ZanoService {
-    apiConfig;
-    serverWallet;
-    apiService;
-    // private readonly network: "mainnet" | "testnet";
-    constructor(config, apiConfig, sdkOptions) {
-        this.apiConfig = apiConfig;
-        // this.network = sdkOptions?.sandbox ? "testnet" : "mainnet";
-        this.apiService = new ZebecCardAPIService(apiConfig, sdkOptions?.sandbox || false);
-        this.serverWallet = new ServerWallet({
-            walletUrl: config.walletUrl,
-            daemonUrl: config.daemonUrl,
-            walletAuthToken: config.walletAuthToken,
-        });
-    }
-    /**
-     * Fetches a quote for Bitcoin transfer.
-     *
-     * @returns {Promise<Quote>} A promise that resolves to a Quote object.
-     */
-    async fetchQuote(symbol = "ZANO") {
-        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 = "ZANO") {
-        const data = await this.apiService.fetchVault(symbol);
-        return data;
-    }
-    /**
-     * Send a transfer
-     */
-    async transferAssets(params) {
-        // Check if we have sufficient balance
-        const balances = await this.serverWallet.getBalances();
-        const assetBalance = balances.find((balance) => balance.asset_info.asset_id === params.assetId);
-        if (assetBalance) {
-            const availableBalance = BigNumber(assetBalance.unlocked);
-            const fee = BigNumber(0.1);
-            const transferAmount = BigNumber(params.amount).plus(fee);
-            if (transferAmount.isGreaterThan(availableBalance)) {
-                throw new Error(`Insufficient balance. Available: ${assetBalance.unlocked} ${assetBalance.ticker || "tokens"}`);
-            }
-        }
-        else {
-            throw new Error(`Sender does not have ${params.assetId} balance.`);
-        }
-        const vault = await this.fetchVault("ZANO");
-        const receiver = vault.address;
-        // Send the transfer
-        const result = await this.serverWallet.sendTransfer(params.assetId, receiver, params.amount);
-        console.debug("result:", result);
-        return result.tx_hash;
-    }
-    /**
-     * Get asset information
-     */
-    async getAssetDetails(assetId) {
-        try {
-            return await this.serverWallet.getAssetDetails(assetId);
-        }
-        catch (error) {
-            console.error(`Error getting asset info for ${assetId}:`, error);
-            throw error;
-        }
-    }
-    /**
-     * Validate if the amount is valid for the given asset
-     */
-    validateAmount(amount, decimalPoints) {
-        const decimals = BigNumber(amount).decimalPlaces();
-        return Boolean(decimals) && decimals == decimalPoints;
-    }
-    /**
-     * Get wallet balances
-     */
-    async getBalances() {
-        try {
-            const balances = await this.serverWallet.getBalances();
-            return balances;
-        }
-        catch (error) {
-            console.error("Error getting balances:", error);
-            throw error;
-        }
-    }
-    /**
-     * Get balance for a specific asset
-     */
-    async getAssetBalance(assetId) {
-        try {
-            const balances = await this.getBalances();
-            return balances.find((balance) => balance.asset_info.asset_id === assetId) || null;
-        }
-        catch (error) {
-            console.error(`Error getting balance for asset ${assetId}:`, error);
-            return null;
-        }
-    }
-}