carbon-js-sdk 0.11.71 → 0.11.72

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "carbon-js-sdk",
-  "version": "0.11.71",
+  "version": "0.11.72",
   "description": "TypeScript SDK for Carbon blockchain",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -17,7 +17,7 @@
     "test": "tsc && node lib/test.js",
     "format": "prettier --write \"src/**/*.ts\"",
     "lint": "eslint . --ext .ts",
-    "prepare": "yarn run build",
+    "prepare": "rm -rf ./lib && yarn run build",
     "prepublishOnly": "yarn run lint",
     "preversion": "yarn run lint",
     "version": "yarn run format && git add -A src",

package/lib/clients/N3Client.d.ts

@@ -1,73 +0,0 @@
-import CarbonSDK from "../CarbonSDK";
-import { NetworkConfigProvider } from "../constant";
-import { NeoLedgerAccount } from "../provider/account";
-import { O3Wallet } from "../provider/o3";
-import { Blockchain } from "../util/blockchain";
-import { TokensWithExternalBalance } from "../util/external";
-import { SimpleMap } from "../util/type";
-import { tx, u } from "@cityofzion/neon-core-next";
-import BigNumber from "bignumber.js";
-export interface N3ClientOpts {
-    configProvider: NetworkConfigProvider;
-    blockchain?: Blockchain;
-}
-export interface LockLedgerDepositParams {
-    token: TokensWithExternalBalance;
-    toAddressHex: string;
-    feeAmount: BigNumber;
-    amount: BigNumber;
-    signCompleteCallback?: () => void;
-    ledger: NeoLedgerAccount;
-}
-export interface LockO3DepositParams {
-    token: TokensWithExternalBalance;
-    toAddressHex: string;
-    feeAmount: BigNumber;
-    amount: BigNumber;
-    signCompleteCallback?: () => void;
-    o3Wallet: O3Wallet;
-}
-export interface NeoDapiInvokeArgs {
-    scriptHash: string;
-    args?: any[];
-    operation: string;
-    fee?: string;
-    signers: any[];
-}
-export interface NeoDapiInvokeOutput {
-    txid: string;
-    nodeUrl: string;
-}
-export interface N3Signer {
-    scriptHash: string;
-    sign: (txn: tx.Transaction, networkMagic?: number, k?: string | number) => Promise<tx.Transaction>;
-}
-export declare class N3Client {
-    readonly configProvider: NetworkConfigProvider;
-    readonly blockchain: Blockchain;
-    static SUPPORTED_BLOCKCHAINS: Blockchain[];
-    static BLOCKCHAIN_KEY: {
-        neo3: string;
-    };
-    private rpcClient;
-    private constructor();
-    static signerFromPrivateKey(privateKey: string): N3Signer;
-    static signerFromLedger(ledger: NeoLedgerAccount): N3Signer;
-    static instance(opts: N3ClientOpts): N3Client;
-    getExternalBalances(sdk: CarbonSDK, address: string, whitelistDenoms?: string[]): Promise<TokensWithExternalBalance[]>;
-    getAllN3Balances(address: string): Promise<SimpleMap<string>>;
-    lock(lockProxyScriptHash: string, tokenScriptHash: string, fromAddressHex: string, toAddressHex: string, amount: BigNumber, feeAmount: BigNumber, signer: N3Signer): Promise<string | false>;
-    lockDeposit(token: TokensWithExternalBalance, feeAmountInput: string, swthAddress: string, neoPrivateKey: string): Promise<string | false>;
-    lockO3Deposit(params: LockO3DepositParams): Promise<string>;
-    lockLedgerDeposit(params: LockLedgerDepositParams): Promise<string | false>;
-    getNetworkFee(txn: tx.Transaction, networkFee: number): Promise<u.BigInteger>;
-    getSystemFee(txn: tx.Transaction, systemFee: number, signers?: (tx.Signer | tx.SignerJson)[]): Promise<u.BigInteger>;
-    formatWithdrawalAddress(address: string): string;
-    retrieveNEP17Info(address: string): Promise<{
-        name: string;
-        symbol: string;
-        address: string;
-        decimals: number;
-    }>;
-}
-export default N3Client;

package/lib/clients/N3Client.js

@@ -1,285 +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 __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.N3Client = void 0;
-const o3_1 = require("../provider/o3");
-const address_1 = require("../util/address");
-const blockchain_1 = require("../util/blockchain");
-const neon_core_next_1 = require("@cityofzion/neon-core-next");
-const bignumber_js_1 = __importDefault(require("bignumber.js"));
-class N3Client {
-    constructor(configProvider, blockchain) {
-        var _a;
-        this.configProvider = configProvider;
-        this.blockchain = blockchain;
-        const config = configProvider.getConfig();
-        const isValidNeoRpcUrl = ((_a = config.n3.rpcURL) === null || _a === void 0 ? void 0 : _a.length) > 0;
-        this.rpcClient = isValidNeoRpcUrl ? new neon_core_next_1.rpc.RPCClient(config.n3.rpcURL) : null;
-    }
-    static signerFromPrivateKey(privateKey) {
-        const account = new neon_core_next_1.wallet.Account(privateKey);
-        return {
-            scriptHash: account.scriptHash,
-            sign: (txn, networkMagic = neon_core_next_1.CONST.MAGIC_NUMBER.MainNet, k) => __awaiter(this, void 0, void 0, function* () {
-                yield txn.sign(account, networkMagic, k);
-                return txn;
-            }),
-        };
-    }
-    static signerFromLedger(ledger) {
-        return {
-            scriptHash: ledger.scriptHash,
-            sign: (txn, networkMagic = neon_core_next_1.CONST.MAGIC_NUMBER.MainNet) => __awaiter(this, void 0, void 0, function* () {
-                const signature = yield ledger.sign(txn.serialize(false), networkMagic);
-                const encodedPublicKey = neon_core_next_1.wallet.getPublicKeyEncoded(ledger.publicKey);
-                txn.addWitness(neon_core_next_1.tx.Witness.fromSignature(signature, encodedPublicKey));
-                return txn;
-            }),
-        };
-    }
-    static instance(opts) {
-        const { configProvider, blockchain = blockchain_1.Blockchain.Neo3 } = opts;
-        if (!N3Client.SUPPORTED_BLOCKCHAINS.includes(blockchain))
-            throw new Error(`unsupported blockchain - ${blockchain}`);
-        return new N3Client(configProvider, blockchain);
-    }
-    getExternalBalances(sdk, address, whitelistDenoms) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const tokens = yield sdk.token.getAllTokens();
-            const balances = yield this.getAllN3Balances(address);
-            const tokensWithBalance = [];
-            for (const token of tokens) {
-                if (!token.tokenAddress.match(/^[0-9a-f]+$/i))
-                    continue;
-                if (whitelistDenoms && !whitelistDenoms.includes(token.denom))
-                    continue;
-                const tokenScriptHash = neon_core_next_1.u.reverseHex(token.tokenAddress);
-                if (!balances[tokenScriptHash])
-                    continue;
-                tokensWithBalance.push(Object.assign(Object.assign({}, token), { externalBalance: balances[tokenScriptHash] }));
-            }
-            return tokensWithBalance;
-        });
-    }
-    getAllN3Balances(address) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.rpcClient.execute(new neon_core_next_1.rpc.Query({
-                method: "getnep17balances",
-                params: [address],
-            }));
-            const balances = {};
-            for (const balanceResult of (_a = response === null || response === void 0 ? void 0 : response.balance) !== null && _a !== void 0 ? _a : []) {
-                balances[balanceResult.assethash.replace(/^0x/i, "")] = balanceResult.amount;
-            }
-            return balances;
-        });
-    }
-    lock(lockProxyScriptHash, tokenScriptHash, fromAddressHex, toAddressHex, amount, feeAmount, signer) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const nonce = Math.floor(Math.random() * 1000000);
-            const networkConfig = this.configProvider.getConfig();
-            const args = [
-                neon_core_next_1.sc.ContractParam.hash160(tokenScriptHash),
-                neon_core_next_1.sc.ContractParam.hash160(fromAddressHex),
-                neon_core_next_1.sc.ContractParam.byteArray(neon_core_next_1.u.HexString.fromHex(toAddressHex, true)),
-                neon_core_next_1.sc.ContractParam.integer(amount.toString(10)),
-                neon_core_next_1.sc.ContractParam.integer(feeAmount.toString(10)),
-                neon_core_next_1.sc.ContractParam.byteArray(neon_core_next_1.u.HexString.fromHex(feeAmount.isZero() ? "" : networkConfig.feeAddress, true)),
-                neon_core_next_1.sc.ContractParam.integer(nonce),
-            ];
-            const script = neon_core_next_1.sc.createScript({
-                scriptHash: lockProxyScriptHash,
-                operation: "lock",
-                args,
-            });
-            const currentHeight = yield this.rpcClient.getBlockCount();
-            const txn = new neon_core_next_1.tx.Transaction({
-                script,
-                validUntilBlock: currentHeight + 100,
-                signers: [
-                    {
-                        account: signer.scriptHash,
-                        scopes: neon_core_next_1.tx.WitnessScope.Global,
-                    },
-                ],
-            });
-            const networkFee = yield this.getNetworkFee(txn, 0);
-            txn.networkFee = networkFee;
-            const systemFee = yield this.getSystemFee(txn, 0, [
-                {
-                    account: signer.scriptHash,
-                    scopes: neon_core_next_1.tx.WitnessScope.Global.toString(),
-                },
-            ]);
-            txn.systemFee = systemFee;
-            if (amount.lt(feeAmount)) {
-                return false;
-            }
-            const config = this.configProvider.getConfig();
-            yield signer.sign(txn, config.n3.networkMagic);
-            const txHash = yield this.rpcClient.sendRawTransaction(neon_core_next_1.u.HexString.fromHex(txn.serialize(true)));
-            return txHash;
-        });
-    }
-    lockDeposit(token, feeAmountInput, swthAddress, neoPrivateKey) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const networkConfig = this.configProvider.getConfig();
-            const scriptHash = neon_core_next_1.u.reverseHex(token.bridgeAddress);
-            const tokenScriptHash = neon_core_next_1.u.reverseHex(token.tokenAddress);
-            const addressBytes = address_1.SWTHAddress.getAddressBytes(swthAddress, networkConfig.network);
-            const toAddress = Buffer.from(addressBytes).toString("hex");
-            const amount = new bignumber_js_1.default(token.externalBalance);
-            const feeAmount = new bignumber_js_1.default(feeAmountInput !== null && feeAmountInput !== void 0 ? feeAmountInput : "100000000");
-            const n3Signer = N3Client.signerFromPrivateKey(neoPrivateKey);
-            const fromAddress = address_1.N3Address.privateKeyToAddress(neoPrivateKey);
-            return yield this.lock(scriptHash, tokenScriptHash, fromAddress, toAddress, amount, feeAmount, n3Signer);
-        });
-    }
-    lockO3Deposit(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { feeAmount, toAddressHex, amount, token, o3Wallet } = params;
-            if (!o3Wallet.isConnected()) {
-                throw new Error("O3 wallet not connected. Please reconnect and try again.");
-            }
-            const nonce = Math.floor(Math.random() * 1000000);
-            const networkConfig = this.configProvider.getConfig();
-            const lockProxyScriptHash = neon_core_next_1.u.reverseHex(token.bridgeAddress);
-            const tokenScriptHash = neon_core_next_1.u.reverseHex(token.tokenAddress);
-            const fromAddressHex = o3Wallet.address;
-            const publicKeyOutput = (yield o3Wallet.getPublicKeyOutput());
-            const accountScriptHash = address_1.N3Address.publicKeyToScriptHash(publicKeyOutput.publicKey);
-            const feeAddress = feeAmount.isZero() ? "" : neon_core_next_1.u.HexString.fromHex(networkConfig.feeAddress).toBase64();
-            const args = [
-                { type: o3_1.O3Types.ArgTypes.Hash160, value: tokenScriptHash },
-                { type: o3_1.O3Types.ArgTypes.Hash160, value: fromAddressHex },
-                { type: o3_1.O3Types.ArgTypes.ByteArray, value: neon_core_next_1.u.HexString.fromHex(toAddressHex).toBase64() },
-                { type: o3_1.O3Types.ArgTypes.Integer, value: amount.toString(10) },
-                { type: o3_1.O3Types.ArgTypes.Integer, value: feeAmount.toString(10) },
-                { type: o3_1.O3Types.ArgTypes.ByteArray, value: feeAddress },
-                { type: o3_1.O3Types.ArgTypes.Integer, value: nonce.toString() },
-            ];
-            const result = yield o3Wallet.getDAPI().invoke({
-                operation: "lock",
-                scriptHash: lockProxyScriptHash,
-                args,
-                network: o3Wallet.neoNetwork,
-                signers: [
-                    {
-                        account: accountScriptHash,
-                        scopes: neon_core_next_1.tx.WitnessScope.Global,
-                    },
-                ],
-            });
-            return result.txid;
-        });
-    }
-    lockLedgerDeposit(params) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { feeAmount, toAddressHex, amount, token, ledger } = params;
-            const scriptHash = neon_core_next_1.u.reverseHex(token.bridgeAddress);
-            const tokenScriptHash = neon_core_next_1.u.reverseHex(token.tokenAddress);
-            const fromAddressHex = ledger.displayAddress;
-            const n3Signer = N3Client.signerFromLedger(ledger);
-            return yield this.lock(scriptHash, tokenScriptHash, fromAddressHex, toAddressHex, amount, feeAmount, n3Signer);
-        });
-    }
-    getNetworkFee(txn, networkFee) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const feePerByteInvokeResponse = yield this.rpcClient.invokeFunction(neon_core_next_1.CONST.NATIVE_CONTRACT_HASH.PolicyContract, "getFeePerByte");
-            if (feePerByteInvokeResponse.state !== "HALT") {
-                if (networkFee === 0) {
-                    throw new Error("Unable to retrieve data to calculate network fee.");
-                }
-                else {
-                    txn.networkFee = neon_core_next_1.u.BigInteger.fromNumber(networkFee);
-                }
-            }
-            const feePerByte = new bignumber_js_1.default(feePerByteInvokeResponse.stack[0].value);
-            // Account for witness size
-            const transactionByteSize = txn.serialize().length / 2 + 109;
-            // Hardcoded. Running a witness is always the same cost for the basic account.
-            const witnessProcessingFee = new bignumber_js_1.default(1000390);
-            const networkFeeEstimate = feePerByte.times(transactionByteSize).plus(witnessProcessingFee);
-            if (networkFee && networkFee >= networkFeeEstimate.toNumber()) {
-                return neon_core_next_1.u.BigInteger.fromNumber(networkFee);
-            }
-            else {
-                return neon_core_next_1.u.BigInteger.fromNumber(networkFeeEstimate.toString(10));
-            }
-        });
-    }
-    getSystemFee(txn, systemFee, signers) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const invokeFunctionResponse = yield this.rpcClient.invokeScript(neon_core_next_1.u.HexString.fromHex(txn.script), signers);
-            if (invokeFunctionResponse.state !== "HALT") {
-                throw new Error(`Simulation errored out: ${invokeFunctionResponse.exception}`);
-            }
-            const requiredSystemFee = new bignumber_js_1.default(invokeFunctionResponse.gasconsumed).toNumber();
-            if (systemFee && systemFee >= requiredSystemFee) {
-                return neon_core_next_1.u.BigInteger.fromNumber(systemFee);
-            }
-            else {
-                return neon_core_next_1.u.BigInteger.fromNumber(requiredSystemFee);
-            }
-        });
-    }
-    formatWithdrawalAddress(address) {
-        const isValidAddress = neon_core_next_1.wallet.isAddress(address);
-        if (!isValidAddress) {
-            throw new Error("invalid address");
-        }
-        const scriptHash = neon_core_next_1.wallet.getScriptHashFromAddress(address);
-        // return the little endian version of the address
-        return neon_core_next_1.u.reverseHex(scriptHash);
-    }
-    retrieveNEP17Info(address) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const result = yield this.rpcClient.executeAll([
-                new neon_core_next_1.rpc.Query({
-                    method: "invokefunction",
-                    params: [address, "decimals"],
-                }),
-                new neon_core_next_1.rpc.Query({
-                    method: "invokefunction",
-                    params: [address, "symbol"],
-                }),
-                new neon_core_next_1.rpc.Query({
-                    method: "getcontractstate",
-                    params: [address],
-                }),
-            ]);
-            const [decimalRaw, symbolRaw, nameRaw] = result;
-            let decimals = 0;
-            let symbol = "";
-            let name = "";
-            if (typeof decimalRaw.stack[0].value === "string") {
-                decimals = Number(decimalRaw.stack[0].value);
-            }
-            if (typeof symbolRaw.stack[0].value === "string") {
-                symbol = Buffer.from(symbolRaw.stack[0].value, "base64").toString("ascii");
-            }
-            if (typeof nameRaw.manifest.name === "string") {
-                name = nameRaw.manifest.name;
-            }
-            return { name, symbol, address, decimals };
-        });
-    }
-}
-exports.N3Client = N3Client;
-N3Client.SUPPORTED_BLOCKCHAINS = [blockchain_1.Blockchain.Neo3];
-N3Client.BLOCKCHAIN_KEY = {
-    [blockchain_1.Blockchain.Neo3]: "Neo3",
-};
-exports.default = N3Client;

package/lib/clients/NEOClient.d.ts

@@ -1,57 +0,0 @@
-import CarbonSDK from "../CarbonSDK";
-import { NeoNetworkConfig, NetworkConfig, NetworkConfigProvider } from "../constant";
-import { Carbon } from "../CarbonSDK";
-import { NeoLedgerAccount } from "../provider/account";
-import { O3Wallet } from "../provider/o3";
-import { Blockchain } from "../util/blockchain";
-import { TokenInitInfo, TokensWithExternalBalance } from "../util/external";
-import BigNumber from "bignumber.js";
-export interface NEOClientOpts {
-    configProvider: NetworkConfigProvider;
-    blockchain?: Blockchain;
-}
-export interface LockLedgerDepositParams {
-    feeAmount: BigNumber;
-    amount: BigNumber;
-    address: Uint8Array;
-    token: TokensWithExternalBalance;
-    ledger: NeoLedgerAccount;
-    signCompleteCallback?: () => void;
-}
-export interface LockO3DepositParams {
-    feeAmount: BigNumber;
-    amount: BigNumber;
-    address: Uint8Array;
-    token: TokensWithExternalBalance;
-    o3Wallet: O3Wallet;
-    signCompleteCallback?: () => void;
-}
-export declare class NEOClient {
-    readonly configProvider: NetworkConfigProvider;
-    readonly blockchain: Blockchain;
-    static SUPPORTED_BLOCKCHAINS: Blockchain[];
-    static BLOCKCHAIN_KEY: {
-        neo: string;
-    };
-    private constructor();
-    static instance(opts: NEOClientOpts): CarbonSDK.NEOClient;
-    static parseHexNum(hex: string, exp?: number): string;
-    getExternalBalances(sdk: CarbonSDK, address: string, url: string, whitelistDenoms?: string[], version?: string): Promise<TokensWithExternalBalance[]>;
-    lockDeposit(token: TokensWithExternalBalance, feeAmountInput: string, swthAddress: string, neoPrivateKey: string): Promise<false | import("@cityofzion/neon-api/lib/funcs/types").DoInvokeConfig>;
-    lockO3Deposit(params: LockO3DepositParams): Promise<any>;
-    lockLedgerDeposit(params: LockLedgerDepositParams): Promise<any>;
-    retrieveNEP5Info(scriptHash: string): Promise<TokenInitInfo>;
-    wrapNeoToNneo(neoAmount: BigNumber, neoPrivateKey: string): Promise<import("@cityofzion/neon-api/lib/funcs/types").DoInvokeConfig>;
-    formatWithdrawalAddress(address: string): string;
-    /**
-     * TargetProxyHash is a hash of token originator address that is used
-     * for lockproxy asset registration and identification
-     *
-     * @param token
-     */
-    getTargetProxyHash(token: Carbon.Coin.Token): string;
-    getNetworkConfig(): NetworkConfig;
-    getConfig(): NeoNetworkConfig;
-    getProviderUrl(): string;
-}
-export default NEOClient;