@cityofzion/bs-neox 1.1.0 → 1.1.1

package/dist/constants/BSNeoXConstants.js

@@ -16,13 +16,13 @@ BSNeoXConstants.TESTNET_NETWORK_IDS = ['12227332'];
 BSNeoXConstants.ALL_NETWORK_IDS = [..._a.MAINNET_NETWORK_IDS, ..._a.TESTNET_NETWORK_IDS];
 BSNeoXConstants.MAINNET_NETWORK = {
     id: '47763',
-    name: 'NeoX Testnet',
+    name: 'NeoX Mainnet',
     url: _a.RPC_LIST_BY_NETWORK_ID['47763'][0],
 };
 BSNeoXConstants.TESTNET_NETWORK = {
     id: '12227332',
-    name: 'NeoX Mainnet',
+    name: 'NeoX Testnet',
     url: _a.RPC_LIST_BY_NETWORK_ID['12227332'][0],
 };
-BSNeoXConstants.ALL_NETWORK = [_a.TESTNET_NETWORK, _a.MAINNET_NETWORK];
+BSNeoXConstants.ALL_NETWORK = [_a.MAINNET_NETWORK, _a.TESTNET_NETWORK];
 BSNeoXConstants.DEFAULT_NETWORK = _a.MAINNET_NETWORK;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cityofzion/bs-neox",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": "https://github.com/CityOfZion/blockchain-services",
@@ -16,8 +16,8 @@
     "axios": "1.8.2",
     "ethers": "5.7.2",
     "date-fns": "~4.1.0",
-    "@cityofzion/bs-ethereum": "2.12.0",
-    "@cityofzion/blockchain-service": "1.18.0"
+    "@cityofzion/blockchain-service": "1.18.0",
+    "@cityofzion/bs-ethereum": "2.12.0"
   },
   "devDependencies": {
     "@ledgerhq/hw-transport-node-hid": "~6.28.5",

package/dist/services/extended/BridgeNeoXService.d.ts

@@ -1,34 +0,0 @@
-import { Account, BalanceResponse, Token } from '@cityofzion/blockchain-service';
-import { BSNeoX } from '../../BSNeoX';
-export type TValidateBridgeToNeo3Param<BSName extends string> = {
-    account: Account<BSName>;
-    neo3Address: string;
-    amount: string;
-    token: Token;
-    balances: BalanceResponse[];
-};
-export type TValidateBridgeToNeo3 = {
-    amount: string;
-    receiveAmount: string;
-    token: Token;
-    isGasToken?: boolean;
-    isNeoToken?: boolean;
-};
-export type TBridgeToNeo3Param<BSName extends string> = {
-    account: Account<BSName>;
-    neo3Address: string;
-    validateResult: TValidateBridgeToNeo3;
-};
-export type TCalculateMaxAmountToBridgeToNeo3Param<BSName extends string> = {
-    account: Account<BSName>;
-    neo3Address: string;
-    token: Token;
-    balances: BalanceResponse[];
-};
-export declare class BridgeNeoXService<BSName extends string> {
-    #private;
-    constructor(service: BSNeoX<BSName>);
-    calculateBridgeToNeo3Fee(params: TBridgeToNeo3Param<BSName>): Promise<string>;
-    validateBridgeToNeo3({ amount, balances, token, account, neo3Address, }: TValidateBridgeToNeo3Param<BSName>): Promise<TValidateBridgeToNeo3>;
-    calculateMaxAmountToBridgeToNeoX({ account, balances, neo3Address, token, }: TCalculateMaxAmountToBridgeToNeo3Param<BSName>): Promise<any>;
-}

package/dist/services/extended/BridgeNeoXService.js

@@ -1,177 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _BridgeNeoXService_instances, _BridgeNeoXService_service, _BridgeNeoXService_buildBridgeParams;
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BridgeNeoXService = void 0;
-const blockchain_service_1 = require("@cityofzion/blockchain-service");
-const BSNeoXConstants_1 = require("../../constants/BSNeoXConstants");
-const ethers_1 = require("ethers");
-const neon_js_1 = require("@cityofzion/neon-js");
-const bridge_1 = require("../../assets/abis/bridge");
-const bs_ethereum_1 = require("@cityofzion/bs-ethereum");
-class BridgeNeoXService {
-    constructor(service) {
-        _BridgeNeoXService_instances.add(this);
-        _BridgeNeoXService_service.set(this, void 0);
-        __classPrivateFieldSet(this, _BridgeNeoXService_service, service, "f");
-    }
-    calculateBridgeToNeo3Fee(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                const signer = yield __classPrivateFieldGet(this, _BridgeNeoXService_service, "f").generateSigner(params.account);
-                const { gasPrice, approveTransactionParams, bridgeTransactionParam } = yield __classPrivateFieldGet(this, _BridgeNeoXService_instances, "m", _BridgeNeoXService_buildBridgeParams).call(this, params);
-                let fee = ethers_1.ethers.utils.parseEther('0');
-                if (params.validateResult.isGasToken) {
-                    const estimated = yield signer.estimateGas(bridgeTransactionParam);
-                    fee = gasPrice.mul(estimated);
-                }
-                else {
-                    let approvedEstimated = ethers_1.ethers.utils.parseEther('0');
-                    if (approveTransactionParams) {
-                        approvedEstimated = yield signer.estimateGas(approveTransactionParams);
-                    }
-                    // We can't estimate the gas for the bridge transaction because it requires the approve transaction to be done first
-                    // if not the gas estimation of bridge transaction will fail so we add a fixed value
-                    const neoBridgeFee = ethers_1.ethers.utils.parseUnits(BSNeoXConstants_1.BSNeoXConstants.BRIDGE_NEO_BRIDGE_TRANSACTION_FEE.toString(), BSNeoXConstants_1.BSNeoXConstants.NATIVE_ASSET.decimals);
-                    fee = gasPrice.mul(approvedEstimated).add(neoBridgeFee);
-                }
-                return ethers_1.ethers.utils.formatEther(fee);
-            }
-            catch (error) {
-                throw new blockchain_service_1.BSError(error.message, 'FEE_CALCULATION_ERROR');
-            }
-        });
-    }
-    validateBridgeToNeo3({ amount, balances, token, account, neo3Address, }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const normalizedSelectedToken = blockchain_service_1.BSTokenHelper.normalizeToken(token);
-            const isGasToken = normalizedSelectedToken.hash === BSNeoXConstants_1.BSNeoXConstants.NATIVE_ASSET.hash;
-            const isNeoToken = normalizedSelectedToken.hash === BSNeoXConstants_1.BSNeoXConstants.NEO_TOKEN.hash;
-            if (!isGasToken && !isNeoToken) {
-                throw new blockchain_service_1.BSError('Only GAS and NEO tokens are supported for bridging', 'UNSUPPORTED_TOKEN');
-            }
-            const gasBalance = balances.find(balance => blockchain_service_1.BSTokenHelper.normalizeHash(balance.token.hash) === BSNeoXConstants_1.BSNeoXConstants.NATIVE_ASSET.hash);
-            if (!gasBalance) {
-                throw new blockchain_service_1.BSError('GAS is necessary to bridge', 'GAS_BALANCE_NOT_FOUND');
-            }
-            const amountNumber = blockchain_service_1.BSBigNumberHelper.fromNumber(amount);
-            const gasBalanceNumber = blockchain_service_1.BSBigNumberHelper.fromNumber(gasBalance.amount);
-            if (isGasToken) {
-                const receiveAmount = amountNumber.minus(BSNeoXConstants_1.BSNeoXConstants.BRIDGE_GAS_FEE).toString();
-                if (amountNumber.isLessThan(BSNeoXConstants_1.BSNeoXConstants.BRIDGE_MIN_AMOUNT + BSNeoXConstants_1.BSNeoXConstants.BRIDGE_GAS_FEE)) {
-                    throw new blockchain_service_1.BSError('Amount is less than the minimum amount plus bridge fee', 'AMOUNT_TOO_LOW');
-                }
-                if (amountNumber.isGreaterThan(gasBalanceNumber)) {
-                    throw new blockchain_service_1.BSError('Amount is greater than your balance', 'INSUFFICIENT_GAS_BALANCE');
-                }
-                const validateResult = { receiveAmount, token, isGasToken, isNeoToken, amount };
-                const fee = yield this.calculateBridgeToNeo3Fee({
-                    account,
-                    neo3Address,
-                    validateResult,
-                });
-                if (amountNumber.plus(fee).isGreaterThan(gasBalanceNumber)) {
-                    throw new blockchain_service_1.BSError('Amount is greater than your balance plus fee', 'INSUFFICIENT_GAS_BALANCE_FEE');
-                }
-                return validateResult;
-            }
-            const neoBalance = balances.find(balance => blockchain_service_1.BSTokenHelper.normalizeHash(balance.token.hash) === BSNeoXConstants_1.BSNeoXConstants.NEO_TOKEN.hash);
-            if (!neoBalance) {
-                throw new blockchain_service_1.BSError('NEO balance not found', 'NEO_BALANCE_NOT_FOUND');
-            }
-            if (amountNumber.isLessThan(BSNeoXConstants_1.BSNeoXConstants.BRIDGE_MIN_AMOUNT)) {
-                throw new blockchain_service_1.BSError('Amount is less than the minimum amount', 'AMOUNT_TOO_LOW');
-            }
-            if (amountNumber.isGreaterThan(neoBalance.amount)) {
-                throw new blockchain_service_1.BSError('Amount is greater than your balance', 'INSUFFICIENT_NEO_BALANCE');
-            }
-            const minGasBalanceNumber = blockchain_service_1.BSBigNumberHelper.fromNumber(BSNeoXConstants_1.BSNeoXConstants.BRIDGE_GAS_FEE);
-            if (gasBalanceNumber.isLessThan(minGasBalanceNumber)) {
-                throw new blockchain_service_1.BSError('GAS balance is less than bridge fee', 'INSUFFICIENT_GAS_BALANCE_BRIDGE_FEE');
-            }
-            const receiveAmount = amount;
-            const validateResult = { receiveAmount, token, isNeoToken, amount };
-            const fee = yield this.calculateBridgeToNeo3Fee({
-                account,
-                neo3Address,
-                validateResult,
-            });
-            if (minGasBalanceNumber.plus(blockchain_service_1.BSBigNumberHelper.fromNumber(fee)).isGreaterThan(gasBalanceNumber)) {
-                throw new blockchain_service_1.BSError('GAS balance is less than fees', 'INSUFFICIENT_GAS_BALANCE_FEES');
-            }
-            return validateResult;
-        });
-    }
-    calculateMaxAmountToBridgeToNeoX({ account, balances, neo3Address, token, }) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const normalizedSelectedToken = blockchain_service_1.BSTokenHelper.normalizeToken(token);
-            const selectedTokenBalance = balances.find(balance => blockchain_service_1.BSTokenHelper.normalizeHash(balance.token.hash) === normalizedSelectedToken.hash);
-            if (!selectedTokenBalance) {
-                throw new blockchain_service_1.BSError('Token balance not found', 'TOKEN_BALANCE_NOT_FOUND');
-            }
-            const selectedTokenBalanceNumber = blockchain_service_1.BSBigNumberHelper.fromNumber(selectedTokenBalance.amount);
-            const amount = blockchain_service_1.BSBigNumberHelper.fromNumber(BSNeoXConstants_1.BSNeoXConstants.BRIDGE_MIN_AMOUNT).toString();
-            const receiveAmount = selectedTokenBalanceNumber.minus(amount).toString();
-            const isGasToken = normalizedSelectedToken.hash === BSNeoXConstants_1.BSNeoXConstants.NATIVE_ASSET.hash;
-            const isNeoToken = normalizedSelectedToken.hash === BSNeoXConstants_1.BSNeoXConstants.NEO_TOKEN.hash;
-            const fee = yield this.calculateBridgeToNeo3Fee({
-                account,
-                neo3Address,
-                validateResult: { receiveAmount, token, isGasToken, isNeoToken, amount },
-            });
-            const maxAmount = selectedTokenBalanceNumber.minus(blockchain_service_1.BSBigNumberHelper.fromNumber(fee)).toString();
-            return maxAmount;
-        });
-    }
-}
-exports.BridgeNeoXService = BridgeNeoXService;
-_BridgeNeoXService_service = new WeakMap(), _BridgeNeoXService_instances = new WeakSet(), _BridgeNeoXService_buildBridgeParams = function _BridgeNeoXService_buildBridgeParams(params) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const { validateResult } = params;
-        const provider = new ethers_1.ethers.providers.JsonRpcProvider(__classPrivateFieldGet(this, _BridgeNeoXService_service, "f").network.url);
-        const gasPrice = yield provider.getGasPrice();
-        let bridgeTransactionParam;
-        let approveTransactionParams;
-        const to = '0x' + neon_js_1.wallet.getScriptHashFromAddress(params.neo3Address);
-        const bridgeContract = new ethers_1.ethers.Contract(BSNeoXConstants_1.BSNeoXConstants.BRIDGE_SCRIPT_HASH, bridge_1.BRIDGE_ABI);
-        const bridgeFee = ethers_1.ethers.utils.parseUnits(BSNeoXConstants_1.BSNeoXConstants.BRIDGE_GAS_FEE.toString(), BSNeoXConstants_1.BSNeoXConstants.NATIVE_ASSET.decimals);
-        if (validateResult.isGasToken) {
-            const populatedTransaction = yield bridgeContract.populateTransaction.withdrawNative(to, bridgeFee);
-            bridgeTransactionParam = Object.assign(Object.assign({}, populatedTransaction), { value: ethers_1.ethers.utils.parseUnits(validateResult.amount, params.validateResult.token.decimals), type: 2 });
-        }
-        else {
-            const amount = ethers_1.ethers.utils.parseUnits(blockchain_service_1.BSBigNumberHelper.format(params.validateResult.amount, 0), params.validateResult.token.decimals);
-            const erc20Contract = new ethers_1.ethers.Contract(BSNeoXConstants_1.BSNeoXConstants.NEO_TOKEN.hash, bs_ethereum_1.ERC20_ABI);
-            const populatedApproveTransaction = yield erc20Contract.populateTransaction.approve(BSNeoXConstants_1.BSNeoXConstants.BRIDGE_SCRIPT_HASH, amount);
-            approveTransactionParams = Object.assign(Object.assign({}, populatedApproveTransaction), { type: 2 });
-            const populatedTransaction = yield bridgeContract.populateTransaction.withdrawToken(validateResult.token.hash, to, 
-            // We are using 0 as the decimals because the NEO token in Neo3 has 0 decimals
-            amount);
-            bridgeTransactionParam = Object.assign(Object.assign({}, populatedTransaction), { type: 2, value: bridgeFee });
-        }
-        return {
-            bridgeTransactionParam,
-            approveTransactionParams,
-            gasPrice,
-        };
-    });
-};