@cityofzion/bs-neo3 0.3.2 → 0.4.1

package/bs-neo3.build.error.log

@@ -0,0 +1,84 @@
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:140:0 - warning BlockchainDataService is referenced by BDSNeo3 but not included in the documentation.
+
+140    export interface BlockchainDataService {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:137:0 - warning BDSClaimable is referenced by BDSNeo3 but not included in the documentation.
+
+137    export interface BDSClaimable {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:60:0 - warning BlockchainService is referenced by BSNeo3 but not included in the documentation.
+
+60    export interface BlockchainService<BSCustomName extends string = string> {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:30:0 - warning Claimable is referenced by BSNeo3 but not included in the documentation.
+
+30    export interface Claimable {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:41:0 - warning NeoNameService is referenced by BSNeo3 but not included in the documentation.
+
+41    export interface NeoNameService {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:11:0 - warning TokenInfo is referenced by gasInfoNeo3 but not included in the documentation.
+
+11    export type TokenInfo = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:126:0 - warning BlockchainNetwork is referenced by BDSNeo3.network but not included in the documentation.
+
+126    export type BlockchainNetwork = "mainnet" | "testnet" | "privatenet";
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:156:0 - warning Exchange is referenced by BSNeo3.exchange but not included in the documentation.
+
+156    export interface Exchange {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:46:0 - warning Token is referenced by BSNeo3.tokens but not included in the documentation.
+
+46    export type Token = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:84:0 - warning TransactionResponse is referenced by BDSNeo3.findTransactionByTxid.findTransactionByTxid but not included in the documentation.
+
+84    export type TransactionResponse = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:118:0 - warning ConsensusNodeResponse is referenced by BDSNeo3.getAllNodes.getAllNodes but not included in the documentation.
+
+118    export type ConsensusNodeResponse = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:127:0 - warning BalanceResponse is referenced by BDSNeo3.getBalance.getBalance but not included in the documentation.
+
+127    export type BalanceResponse = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:113:0 - warning ContractResponse is referenced by BDSNeo3.getContract.getContract but not included in the documentation.
+
+113    export type ContractResponse = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:105:0 - warning TransactionHistoryResponse is referenced by BDSNeo3.getHistoryTransactions.getHistoryTransactions but not included in the documentation.
+
+105    export type TransactionHistoryResponse = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:122:0 - warning TokenInfoResponse is referenced by BDSNeo3.getTokenInfo.getTokenInfo but not included in the documentation.
+
+122    export type TokenInfoResponse = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:133:0 - warning UnclaimedResponse is referenced by BDSNeo3.getUnclaimed.getUnclaimed but not included in the documentation.
+
+133    export type UnclaimedResponse = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:56:0 - warning CalculateTransferFeeResponse is referenced by BSNeo3.calculateTransferFee.calculateTransferFee but not included in the documentation.
+
+56    export type CalculateTransferFeeResponse = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:52:0 - warning Account is referenced by BSNeo3.decryptKey.decryptKey but not included in the documentation.
+
+52    export type Account = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:6:0 - warning IntentTransactionParam is referenced by BSNeo3.buildTransfer.buildTransfer.transactionIntents but not included in the documentation.
+
+6    export type IntentTransactionParam = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:1:0 - warning SendTransactionParam is referenced by BSNeo3.calculateTransferFee.calculateTransferFee.param but not included in the documentation.
+
+1    export type SendTransactionParam = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:35:0 - warning NNSRecordTypes is referenced by BSNeo3.getNNSRecord.getNNSRecord.type but not included in the documentation.
+
+35    export declare enum NNSRecordTypes {
+

package/bs-neo3.build.log

@@ -1,2 +1,87 @@
-Invoking: tsc && typedoc src/index.ts 
+Invoking: tsc && typedoc 
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:140:0 - warning BlockchainDataService is referenced by BDSNeo3 but not included in the documentation.
+
+140    export interface BlockchainDataService {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:137:0 - warning BDSClaimable is referenced by BDSNeo3 but not included in the documentation.
+
+137    export interface BDSClaimable {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:60:0 - warning BlockchainService is referenced by BSNeo3 but not included in the documentation.
+
+60    export interface BlockchainService<BSCustomName extends string = string> {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:30:0 - warning Claimable is referenced by BSNeo3 but not included in the documentation.
+
+30    export interface Claimable {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:41:0 - warning NeoNameService is referenced by BSNeo3 but not included in the documentation.
+
+41    export interface NeoNameService {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:11:0 - warning TokenInfo is referenced by gasInfoNeo3 but not included in the documentation.
+
+11    export type TokenInfo = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:126:0 - warning BlockchainNetwork is referenced by BDSNeo3.network but not included in the documentation.
+
+126    export type BlockchainNetwork = "mainnet" | "testnet" | "privatenet";
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:156:0 - warning Exchange is referenced by BSNeo3.exchange but not included in the documentation.
+
+156    export interface Exchange {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:46:0 - warning Token is referenced by BSNeo3.tokens but not included in the documentation.
+
+46    export type Token = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:84:0 - warning TransactionResponse is referenced by BDSNeo3.findTransactionByTxid.findTransactionByTxid but not included in the documentation.
+
+84    export type TransactionResponse = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:118:0 - warning ConsensusNodeResponse is referenced by BDSNeo3.getAllNodes.getAllNodes but not included in the documentation.
+
+118    export type ConsensusNodeResponse = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:127:0 - warning BalanceResponse is referenced by BDSNeo3.getBalance.getBalance but not included in the documentation.
+
+127    export type BalanceResponse = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:113:0 - warning ContractResponse is referenced by BDSNeo3.getContract.getContract but not included in the documentation.
+
+113    export type ContractResponse = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:105:0 - warning TransactionHistoryResponse is referenced by BDSNeo3.getHistoryTransactions.getHistoryTransactions but not included in the documentation.
+
+105    export type TransactionHistoryResponse = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:122:0 - warning TokenInfoResponse is referenced by BDSNeo3.getTokenInfo.getTokenInfo but not included in the documentation.
+
+122    export type TokenInfoResponse = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:133:0 - warning UnclaimedResponse is referenced by BDSNeo3.getUnclaimed.getUnclaimed but not included in the documentation.
+
+133    export type UnclaimedResponse = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:56:0 - warning CalculateTransferFeeResponse is referenced by BSNeo3.calculateTransferFee.calculateTransferFee but not included in the documentation.
+
+56    export type CalculateTransferFeeResponse = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:52:0 - warning Account is referenced by BSNeo3.decryptKey.decryptKey but not included in the documentation.
+
+52    export type Account = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:6:0 - warning IntentTransactionParam is referenced by BSNeo3.buildTransfer.buildTransfer.transactionIntents but not included in the documentation.
+
+6    export type IntentTransactionParam = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:1:0 - warning SendTransactionParam is referenced by BSNeo3.calculateTransferFee.calculateTransferFee.param but not included in the documentation.
+
+1    export type SendTransactionParam = {
+
+C:/Workspace/blockchain-services/packages/blockchain-service/dist/interfaces.d.ts:35:0 - warning NNSRecordTypes is referenced by BSNeo3.getNNSRecord.getNNSRecord.type but not included in the documentation.
+
+35    export declare enum NNSRecordTypes {
+
 Documentation generated at ./docs

package/dist/BSNeo3.d.ts

@@ -1,34 +1,23 @@
-import { BlockchainDataService, BlockchainService, SendTransactionParam, Claimable, Account, Exchange, BDSClaimable, Token, NeoNameService, NNSRecordTypes, CalculateTransferFeeResponse } from '@cityofzion/blockchain-service';
+import { BlockchainDataService, BlockchainService, SendTransactionParam, TokenInfo, Claimable, Account, Exchange, BDSClaimable, Token, NeoNameService, NNSRecordTypes, CalculateTransferFeeResponse } from '@cityofzion/blockchain-service';
 export declare class BSNeo3<BSCustomName extends string = string> implements BlockchainService, Claimable, NeoNameService {
     blockchainName: BSCustomName;
     dataService: BlockchainDataService & BDSClaimable;
-    derivationPath: string;
-    feeToken: {
-        hash: string;
-        symbol: string;
-        decimals: number;
-    };
+    feeToken: TokenInfo;
     exchange: Exchange;
-    tokenClaim: {
-        hash: string;
-        symbol: string;
-        decimals: number;
-    };
+    tokenClaim: TokenInfo;
     tokens: Token[];
-    private keychain;
+    private derivationPath;
     constructor(blockchainName: BSCustomName);
-    sendTransaction(param: SendTransactionParam): Promise<string>;
-    private buildTransfer;
-    private signTransfer;
-    generateMnemonic(): string;
-    generateWif(mnemonic: string, index: number): string;
-    generateAccount(mnemonic: string, index: number): Account;
-    generateAccountFromWif(wif: string): string;
-    decryptKey(encryptedKey: string, password: string): Promise<Account>;
     validateAddress(address: string): boolean;
     validateEncryptedKey(encryptedKey: string): boolean;
     validateWif(wif: string): boolean;
+    validateNNSFormat(domainName: string): boolean;
+    generateMnemonic(): string[];
+    generateAccount(mnemonic: string[], index: number): Account;
+    generateAccountFromWif(wif: string): Account;
+    decryptKey(encryptedKey: string, password: string): Promise<Account>;
     calculateTransferFee(param: SendTransactionParam): Promise<CalculateTransferFeeResponse>;
+    sendTransaction(param: SendTransactionParam): Promise<string>;
     claim(account: Account): Promise<{
         txid: string;
         symbol: string;
@@ -36,5 +25,6 @@ export declare class BSNeo3<BSCustomName extends string = string> implements Blo
     }>;
     getNNSRecord(domainName: string, type: NNSRecordTypes): Promise<any>;
     getOwnerOfNNS(domainName: string): Promise<any>;
-    validateNNSFormat(domainName: string): boolean;
+    private buildTransfer;
+    private signTransfer;
 }

package/dist/BSNeo3.js

@@ -1,27 +1,4 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 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) {
@@ -38,7 +15,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BSNeo3 = void 0;
 const blockchain_service_1 = require("@cityofzion/blockchain-service");
 const neon_js_1 = require("@cityofzion/neon-js");
-const AsteroidSDK = __importStar(require("@moonlight-io/asteroid-sdk-js"));
 const constants_1 = require("./constants");
 const exceptions_1 = require("./exceptions");
 const explorer_1 = require("./explorer");
@@ -50,72 +26,43 @@ const NEO_NS_HASH = "0x50ac1c37690cc2cfc594472833cf57505d5f46de";
 class BSNeo3 {
     constructor(blockchainName) {
         this.dataService = explorer_1.explorerOptions.dora;
-        this.derivationPath = "m/44'/888'/0'/0/?";
         this.feeToken = constants_1.gasInfoNeo3;
         this.exchange = blockchain_service_1.exchangeOptions.flamingo;
         this.tokenClaim = constants_1.neoInfoNeo3;
         this.tokens = tokens_json_1.default;
-        this.keychain = new AsteroidSDK.Keychain();
+        this.derivationPath = "m/44'/888'/0'/0/?";
         this.blockchainName = blockchainName;
     }
-    sendTransaction(param) {
-        return __awaiter(this, void 0, void 0, function* () {
-            try {
-                const { senderAccount, transactionIntents } = param;
-                const node = yield this.dataService.getHigherNode();
-                const facade = yield neon_js_1.api.NetworkFacade.fromConfig({ node: node.url });
-                const intents = this.buildTransfer(transactionIntents, senderAccount);
-                const signing = this.signTransfer(senderAccount);
-                const result = yield facade.transferToken(intents, signing);
-                return result;
-            }
-            catch (error) {
-                throw error;
-            }
-        });
+    validateAddress(address) {
+        return neon_js_1.wallet.isAddress(address);
     }
-    buildTransfer(transactionIntents, account) {
-        const intents = [];
-        const neoAccount = new neon_js_1.wallet.Account(account.wif);
-        for (const transactionIntent of transactionIntents) {
-            const { amount, receiverAddress, tokenHash } = transactionIntent;
-            intents.push({
-                to: receiverAddress,
-                contractHash: tokenHash,
-                from: neoAccount,
-                decimalAmt: amount,
-            });
-        }
-        return intents;
+    validateEncryptedKey(encryptedKey) {
+        return neon_js_1.wallet.isNEP2(encryptedKey);
     }
-    signTransfer(account) {
-        const neoAccount = new neon_js_1.wallet.Account(account.address);
-        const result = {
-            signingCallback: neon_js_1.api.signWithAccount(neoAccount)
-        };
-        return result;
+    validateWif(wif) {
+        return neon_js_1.wallet.isWIF(wif);
+    }
+    validateNNSFormat(domainName) {
+        if (!domainName.endsWith('.neo'))
+            return false;
+        return true;
     }
     generateMnemonic() {
-        var _a;
-        this.keychain.generateMnemonic(128);
-        const list = (_a = this.keychain.mnemonic) === null || _a === void 0 ? void 0 : _a.toString();
-        if (!list)
+        blockchain_service_1.keychain.generateMnemonic(128);
+        if (!blockchain_service_1.keychain.mnemonic)
             throw new Error("Failed to generate mnemonic");
-        return list;
-    }
-    generateWif(mnemonic, index) {
-        this.keychain.importMnemonic(mnemonic);
-        const childKey = this.keychain.generateChildKey('neo', this.derivationPath.replace('?', index.toString()));
-        return childKey.getWIF();
+        return blockchain_service_1.keychain.mnemonic.toString().split(' ');
     }
     generateAccount(mnemonic, index) {
-        const wif = this.generateWif(mnemonic, index);
+        blockchain_service_1.keychain.importMnemonic(mnemonic.join(' '));
+        const childKey = blockchain_service_1.keychain.generateChildKey("neo", this.derivationPath.replace('?', index.toString()));
+        const wif = childKey.getWIF();
         const { address } = new neon_js_1.wallet.Account(wif);
         return { address, wif };
     }
     generateAccountFromWif(wif) {
         const { address } = new neon_js_1.wallet.Account(wif);
-        return address;
+        return { address, wif };
     }
     decryptKey(encryptedKey, password) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -124,15 +71,6 @@ class BSNeo3 {
             return { address, wif };
         });
     }
-    validateAddress(address) {
-        return neon_js_1.wallet.isAddress(address);
-    }
-    validateEncryptedKey(encryptedKey) {
-        return neon_js_1.wallet.isNEP2(encryptedKey);
-    }
-    validateWif(wif) {
-        return neon_js_1.wallet.isWIF(wif);
-    }
     calculateTransferFee(param) {
         return __awaiter(this, void 0, void 0, function* () {
             const node = yield this.dataService.getHigherNode();
@@ -169,6 +107,22 @@ class BSNeo3 {
             return result;
         });
     }
+    sendTransaction(param) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const { senderAccount, transactionIntents } = param;
+                const node = yield this.dataService.getHigherNode();
+                const facade = yield neon_js_1.api.NetworkFacade.fromConfig({ node: node.url });
+                const intents = this.buildTransfer(transactionIntents, senderAccount);
+                const signing = this.signTransfer(senderAccount);
+                const result = yield facade.transferToken(intents, signing);
+                return result;
+            }
+            catch (error) {
+                throw error;
+            }
+        });
+    }
     //Claimable interface implementation
     claim(account) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -241,10 +195,26 @@ class BSNeo3 {
             return address;
         });
     }
-    validateNNSFormat(domainName) {
-        if (!domainName.endsWith('.neo'))
-            return false;
-        return true;
+    buildTransfer(transactionIntents, account) {
+        const intents = [];
+        const neoAccount = new neon_js_1.wallet.Account(account.wif);
+        for (const transactionIntent of transactionIntents) {
+            const { amount, receiverAddress, tokenHash } = transactionIntent;
+            intents.push({
+                to: receiverAddress,
+                contractHash: tokenHash,
+                from: neoAccount,
+                decimalAmt: amount,
+            });
+        }
+        return intents;
+    }
+    signTransfer(account) {
+        const neoAccount = new neon_js_1.wallet.Account(account.address);
+        const result = {
+            signingCallback: neon_js_1.api.signWithAccount(neoAccount)
+        };
+        return result;
     }
 }
 exports.BSNeo3 = BSNeo3;

package/dist/constants.d.ts

@@ -1,10 +1,3 @@
-export declare const gasInfoNeo3: {
-    hash: string;
-    symbol: string;
-    decimals: number;
-};
-export declare const neoInfoNeo3: {
-    hash: string;
-    symbol: string;
-    decimals: number;
-};
+import { TokenInfo } from '@cityofzion/blockchain-service';
+export declare const gasInfoNeo3: TokenInfo;
+export declare const neoInfoNeo3: TokenInfo;