@cityofzion/bs-neo3 0.3.2 → 0.4.0

package/src/BSNeo3.ts

@@ -1,96 +1,65 @@
-import { BlockchainDataService, BlockchainService, CalculateTransferFeeDetails, SendTransactionParam, Claimable, Account, Exchange, BDSClaimable, exchangeOptions, Token, IntentTransactionParam, NeoNameService, NNSRecordTypes, CalculateTransferFeeResponse } from '@cityofzion/blockchain-service'
+import { BlockchainDataService, BlockchainService, CalculateTransferFeeDetails, SendTransactionParam, TokenInfo, Claimable, Account, Exchange, BDSClaimable, exchangeOptions, Token, IntentTransactionParam, NeoNameService, NNSRecordTypes, CalculateTransferFeeResponse } from '@cityofzion/blockchain-service'
 import { api, rpc, tx, u, wallet } from '@cityofzion/neon-js'
-import * as AsteroidSDK from '@moonlight-io/asteroid-sdk-js'
+import {BIP39Encoded} from '@cityofzion/wallet-sdk'
 import { gasInfoNeo3, neoInfoNeo3 } from './constants'
 import { claimGasExceptions } from './exceptions'
 import { explorerOptions } from './explorer'
 import tokens from './assets/tokens.json'
 import { NeonInvoker } from '@cityofzion/neon-invoker'
 import {NeonParser} from "@cityofzion/neon-parser"
-import { ABI_TYPES, HINT_TYPES } from '@cityofzion/neo3-parser'
+import { ABI_TYPES } from '@cityofzion/neo3-parser'
 
 const NEO_NS_HASH = "0x50ac1c37690cc2cfc594472833cf57505d5f46de";
 
 export class BSNeo3<BSCustomName extends string = string> implements BlockchainService, Claimable, NeoNameService {
     blockchainName: BSCustomName
     dataService: BlockchainDataService & BDSClaimable = explorerOptions.dora
-    derivationPath: string = "m/44'/888'/0'/0/?"
-    feeToken: { hash: string; symbol: string; decimals: number; } = gasInfoNeo3
+    feeToken: TokenInfo = gasInfoNeo3
     exchange: Exchange = exchangeOptions.flamingo
-    tokenClaim: { hash: string; symbol: string; decimals: number } = neoInfoNeo3
+    tokenClaim: TokenInfo = neoInfoNeo3
     tokens: Token[] = tokens
-    private keychain = new AsteroidSDK.Keychain()
+
+    private derivationPath: string = "m/44'/888'/0'/0/?"
+
     constructor(blockchainName: BSCustomName) {
         this.blockchainName = blockchainName
     }
-    async sendTransaction(param: SendTransactionParam): Promise<string> {
-        try {
-            const { senderAccount, transactionIntents } = param
-            const node = await this.dataService.getHigherNode()
-            const facade = await api.NetworkFacade.fromConfig({ node: node.url })
-            const intents = this.buildTransfer(transactionIntents, senderAccount)
-            const signing = this.signTransfer(senderAccount)
-            const result = await facade.transferToken(intents, signing)
-            return result;
-        } catch (error) {
-            throw error;
-        }
-    }
-    private buildTransfer(transactionIntents: IntentTransactionParam[], account: Account) {
-        const intents: api.Nep17TransferIntent[] = []
-        const neoAccount = new 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
+    validateAddress(address: string): boolean {
+        return wallet.isAddress(address)
     }
-    private signTransfer(account: Account) {
-        const neoAccount = new wallet.Account(account.address)
-        const result: api.signingConfig = {
-            signingCallback: api.signWithAccount(neoAccount)
-        }
-        return result
+    validateEncryptedKey(encryptedKey: string): boolean {
+        return wallet.isNEP2(encryptedKey)
     }
-    generateMnemonic(): string {
-        this.keychain.generateMnemonic(128)
-        const list = this.keychain.mnemonic?.toString()
-        if (!list) throw new Error("Failed to generate mnemonic");
-        return list
+    validateWif(wif: string): boolean {
+        return wallet.isWIF(wif)
     }
-    generateWif(mnemonic: string, index: number): string {
-        this.keychain.importMnemonic(mnemonic)
-        const childKey = this.keychain.generateChildKey('neo', this.derivationPath.replace('?', index.toString()))
-        return childKey.getWIF()
+    validateNNSFormat(domainName: string): boolean {
+        if (!domainName.endsWith('.neo')) return false
+        return true
     }
-    generateAccount(mnemonic: string, index: number): Account {
-        const wif = this.generateWif(mnemonic, index)
+    generateMnemonic(): string[] {
+        const bip39 = new BIP39Encoded()
+        const {phonetic} = bip39.generateMnemonic({length: 12})
+        if (!phonetic) throw new Error("Failed to generate mnemonic");
+        return phonetic
+    }
+    generateAccount(mnemonic: string[], index: number): Account {
+        const bip39 = new BIP39Encoded({ mnemonic })
+        const keychain = bip39.getKeychain('neo')
+        const childKey = keychain.generateChildKey(this.derivationPath.replace('?', index.toString()))
+        const wif =  childKey.getWIF()
         const { address } = new wallet.Account(wif)
         return { address, wif }
     }
-    generateAccountFromWif(wif: string): string {
+    generateAccountFromWif(wif: string): Account {
         const { address } = new wallet.Account(wif)
-        return address
+        return { address, wif }
     }
     async decryptKey(encryptedKey: string, password: string): Promise<Account> {
         const wif = await wallet.decrypt(encryptedKey, password)
         const { address } = new wallet.Account(wif)
         return { address, wif }
     }
-    validateAddress(address: string): boolean {
-        return wallet.isAddress(address)
-    }
-    validateEncryptedKey(encryptedKey: string): boolean {
-        return wallet.isNEP2(encryptedKey)
-    }
-    validateWif(wif: string): boolean {
-        return wallet.isWIF(wif)
-    }
     async calculateTransferFee(param: SendTransactionParam): Promise<CalculateTransferFeeResponse> {
         const node = await this.dataService.getHigherNode()
         const url = node.url
@@ -145,6 +114,19 @@ export class BSNeo3<BSCustomName extends string = string> implements BlockchainS
         }
         return result
     }
+    async sendTransaction(param: SendTransactionParam): Promise<string> {
+        try {
+            const { senderAccount, transactionIntents } = param
+            const node = await this.dataService.getHigherNode()
+            const facade = await api.NetworkFacade.fromConfig({ node: node.url })
+            const intents = this.buildTransfer(transactionIntents, senderAccount)
+            const signing = this.signTransfer(senderAccount)
+            const result = await facade.transferToken(intents, signing)
+            return result;
+        } catch (error) {
+            throw error;
+        }
+    }
     //Claimable interface implementation
     async claim(account: Account): Promise<{ txid: string; symbol: string; hash: string; }> {
         const balance = await this.dataService.getBalance(account.address)
@@ -220,9 +202,25 @@ export class BSNeo3<BSCustomName extends string = string> implements BlockchainS
         const address = parser.accountInputToAddress(parsed.replace("0x", ""))
         return address
     }
-    
-    validateNNSFormat(domainName: string): boolean {
-        if (!domainName.endsWith('.neo')) return false
-        return true
+    private buildTransfer(transactionIntents: IntentTransactionParam[], account: Account) {
+        const intents: api.Nep17TransferIntent[] = []
+        const neoAccount = new 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
+    }
+    private signTransfer(account: Account) {
+        const neoAccount = new wallet.Account(account.address)
+        const result: api.signingConfig = {
+            signingCallback: api.signWithAccount(neoAccount)
+        }
+        return result
     }
 }

package/src/constants.ts

@@ -1,10 +1,12 @@
-export const gasInfoNeo3 = {
+import { TokenInfo } from '@cityofzion/blockchain-service'
+
+export const gasInfoNeo3: TokenInfo = {
     hash: '0xd2a4cff31913016155e38e474a2c06d08be276cf',
     symbol: 'GAS',
     decimals: 8
 }
 
-export const neoInfoNeo3 = {
+export const neoInfoNeo3: TokenInfo = {
     hash: '0xef4073a0f2b305a38ec4050e4d3d28bc40ea63f5',
     symbol: 'NEO',
     decimals: 0

package/tsconfig.json

@@ -9,5 +9,10 @@
   ],
   "exclude": [
     "node_modules"
-  ]
+  ],
+  "typedocOptions": {
+    "entryPoints": ["./src/index.ts"],
+    "out": "docs",
+    "exclude": "**/node_modules/**"
+  }
 }

package/.rush/temp/package-deps_build.json

@@ -1,20 +0,0 @@
-{
-  "files": {
-    "packages/bs-neo3/package.json": "13ff208146fbc764d375e0da5ea67a544e028eba",
-    "packages/bs-neo3/src/BDSNeo3.ts": "6de6c505219ad5404357ba195b9b59b368fc574f",
-    "packages/bs-neo3/src/BSNeo3.ts": "39c473d9be67c3cd0ccf253fd037d1c9ea881027",
-    "packages/bs-neo3/src/assets/blockchain_icon_neo.png": "3b3c8c019cc3ab191648acd69b07663006abf495",
-    "packages/bs-neo3/src/assets/blockchain_icon_neo_white.png": "feaec214f1374496e428254d8d014a8aa39b7067",
-    "packages/bs-neo3/src/assets/tokens.json": "33d65a4a123ae414a95b0caf031c6d62eb715349",
-    "packages/bs-neo3/src/constants.ts": "39993e77862b88d771441980cf39a091ae5dee3a",
-    "packages/bs-neo3/src/exceptions.ts": "c7b6401d197e363dca8241b92a4304c227e7800f",
-    "packages/bs-neo3/src/explorer/dora/DoraNeo3Responses.ts": "6ccd07c95af63d966ef370ae8861cb37783cc4da",
-    "packages/bs-neo3/src/explorer/dora/DoraNeo3Routes.ts": "b6b4b85492e1a9611f0f88c2d9836371f1fba20b",
-    "packages/bs-neo3/src/explorer/index.ts": "4e892cff669a805bf2f9cc29554bdfc4e43af6c1",
-    "packages/bs-neo3/src/index.ts": "53f10ade66205f959dca69e06c4d2b73d045424a",
-    "packages/bs-neo3/tsconfig.json": "9c0d05b4a1620310c7310c1d18e7b1afb1977ff9",
-    "packages/bs-neo3/yarn.lock": "5bb25dd89095cbb23ce0906458c1234eb7da3ba2",
-    "packages/bs-neo3/.rush/temp/shrinkwrap-deps.json": "9600269a799443762d941100f09b78f5879f9de4"
-  },
-  "arguments": "tsc && typedoc src/index.ts "
-}