@cityofzion/bs-ethereum 0.8.2 → 0.9.0

package/package.json

@@ -1,34 +1,34 @@
-{
-  "name": "@cityofzion/bs-ethereum",
-  "version": "0.8.2",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "repository": "https://github.com/CityOfZion/blockchain-services",
-  "author": "Coz",
-  "license": "MIT",
-  "scripts": {
-    "build": "tsc --project tsconfig.build.json",
-    "test": "jest --config jest.config.ts"
-  },
-  "dependencies": {
-    "@cityofzion/blockchain-service": "^0.8.0",
-    "ethers": "5.7.2",
-    "@urql/core": "~4.1.1",
-    "graphql": "~16.8.0",
-    "node-fetch": "2.6.4",
-    "dayjs": "~1.11.9",
-    "query-string": "7.1.3",
-    "@ethersproject/json-wallets": "5.7.0",
-    "@ethersproject/bytes": "5.7.0",
-    "@ethersproject/bignumber": "5.7.0"
-  },
-  "devDependencies": {
-    "@types/node-fetch": "2.6.4",
-    "ts-node": "10.9.1",
-    "typescript": "4.9.5",
-    "jest": "29.6.2",
-    "ts-jest": "29.1.1",
-    "@types/jest": "29.5.3",
-    "dotenv": "16.3.1"
-  }
-}
+{
+  "name": "@cityofzion/bs-ethereum",
+  "version": "0.9.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "repository": "https://github.com/CityOfZion/blockchain-services",
+  "author": "Coz",
+  "license": "MIT",
+  "dependencies": {
+    "ethers": "5.7.2",
+    "@urql/core": "~4.1.1",
+    "graphql": "~16.8.0",
+    "node-fetch": "2.6.4",
+    "dayjs": "~1.11.9",
+    "query-string": "7.1.3",
+    "@ethersproject/json-wallets": "5.7.0",
+    "@ethersproject/bytes": "5.7.0",
+    "@ethersproject/bignumber": "5.7.0",
+    "@cityofzion/blockchain-service": "0.9.0"
+  },
+  "devDependencies": {
+    "@types/node-fetch": "2.6.4",
+    "ts-node": "10.9.1",
+    "typescript": "4.9.5",
+    "jest": "29.6.2",
+    "ts-jest": "29.1.1",
+    "@types/jest": "29.5.3",
+    "dotenv": "16.3.1"
+  },
+  "scripts": {
+    "build": "tsc --project tsconfig.build.json",
+    "test": "jest --config jest.config.ts"
+  }
+}

package/src/BSEthereum.ts

@@ -1,184 +1,189 @@
-import {
-  Account,
-  AccountWithDerivationPath,
-  BSCalculableFee,
-  BSWithNameService,
-  BSWithNft,
-  BlockchainDataService,
-  BlockchainService,
-  ExchangeDataService,
-  Network,
-  NftDataService,
-  PartialBy,
-  Token,
-  TransferParam,
-} from '@cityofzion/blockchain-service'
-import { ethers } from 'ethers'
-import * as ethersJsonWallets from '@ethersproject/json-wallets'
-import * as ethersBytes from '@ethersproject/bytes'
-import * as ethersBigNumber from '@ethersproject/bignumber'
-import { DEFAULT_URL_BY_NETWORK_TYPE, DERIVATION_PATH, NATIVE_ASSETS, TOKENS } from './constants'
-import { BitqueryEDSEthereum } from './BitqueryEDSEthereum'
-import { GhostMarketNDSEthereum } from './GhostMarketNDSEthereum'
-import { RpcBDSEthereum } from './RpcBDSEthereum'
-import { BitqueryBDSEthereum } from './BitqueryBDSEthereum'
-
-export class BSEthereum<BSCustomName extends string = string>
-  implements BlockchainService, BSWithNft, BSWithNameService, BSCalculableFee
-{
-  readonly blockchainName: BSCustomName
-  readonly feeToken: Token
-  readonly derivationPath: string
-
-  blockchainDataService!: BlockchainDataService
-  exchangeDataService!: ExchangeDataService
-  tokens: Token[]
-  nftDataService!: NftDataService
-  network!: Network
-
-  constructor(blockchainName: BSCustomName, network: PartialBy<Network, 'url'>) {
-    this.blockchainName = blockchainName
-    this.derivationPath = DERIVATION_PATH
-    this.tokens = TOKENS[network.type]
-
-    this.feeToken = this.tokens.find(token => token.symbol === 'ETH')!
-    this.setNetwork(network)
-  }
-
-  setNetwork(param: PartialBy<Network, 'url'>) {
-    const network = {
-      type: param.type,
-      url: param.url ?? DEFAULT_URL_BY_NETWORK_TYPE[param.type],
-    }
-    this.network = network
-
-    if (network.type === 'custom') {
-      this.blockchainDataService = new RpcBDSEthereum(network)
-    } else {
-      this.blockchainDataService = new BitqueryBDSEthereum(network)
-    }
-
-    this.exchangeDataService = new BitqueryEDSEthereum(network.type)
-    this.nftDataService = new GhostMarketNDSEthereum(network.type)
-  }
-
-  validateAddress(address: string): boolean {
-    return ethers.utils.isAddress(address)
-  }
-
-  validateEncrypted(json: string): boolean {
-    return ethersJsonWallets.isCrowdsaleWallet(json) || ethersJsonWallets.isKeystoreWallet(json)
-  }
-
-  validateKey(key: string): boolean {
-    try {
-      if (!key.startsWith('0x')) {
-        key = '0x' + key
-      }
-      if (ethersBytes.hexDataLength(key) !== 32) return false
-
-      return true
-    } catch (error) {
-      return false
-    }
-  }
-
-  validateNameServiceDomainFormat(domainName: string): boolean {
-    if (!domainName.endsWith('.eth')) return false
-    return true
-  }
-
-  generateAccountFromMnemonic(mnemonic: string[] | string, index: number): AccountWithDerivationPath {
-    const path = this.derivationPath.replace('?', index.toString())
-    const wallet = ethers.Wallet.fromMnemonic(Array.isArray(mnemonic) ? mnemonic.join(' ') : mnemonic, path)
-
-    return {
-      address: wallet.address,
-      key: wallet.privateKey,
-      type: 'privateKey',
-      derivationPath: path,
-    }
-  }
-
-  generateAccountFromKey(key: string): Account {
-    const wallet = new ethers.Wallet(key)
-    return {
-      address: wallet.address,
-      key,
-      type: 'privateKey',
-    }
-  }
-
-  async decrypt(json: string, password: string): Promise<Account> {
-    const wallet = await ethers.Wallet.fromEncryptedJson(json, password)
-    return {
-      address: wallet.address,
-      key: wallet.privateKey,
-      type: 'privateKey',
-    }
-  }
-
-  async transfer({ senderAccount, intent }: TransferParam): Promise<string> {
-    const provider = new ethers.providers.JsonRpcProvider(this.network.url)
-    const wallet = new ethers.Wallet(senderAccount.key, provider)
-
-    let transaction: ethers.providers.TransactionResponse
-    const decimals = intent.tokenDecimals ?? 18
-    const amount = ethersBigNumber.parseFixed(intent.amount, decimals)
-
-    const isNative = NATIVE_ASSETS.some(asset => asset.hash === intent.tokenHash)
-    if (!isNative) {
-      const contract = new ethers.Contract(
-        intent.tokenHash,
-        ['function transfer(address to, uint amount) returns (bool)'],
-        wallet
-      )
-      transaction = await contract.transfer(intent.receiverAddress, amount)
-    } else {
-      transaction = await wallet.sendTransaction({
-        to: intent.receiverAddress,
-        value: amount,
-      })
-    }
-
-    const transactionMined = await transaction.wait()
-    if (!transactionMined) throw new Error('Transaction not mined')
-
-    return transactionMined.transactionHash
-  }
-
-  async calculateTransferFee({ senderAccount, intent }: TransferParam, details?: boolean | undefined): Promise<string> {
-    const provider = new ethers.providers.JsonRpcProvider(this.network.url)
-    const wallet = new ethers.Wallet(senderAccount.key, provider)
-
-    let estimated: ethers.BigNumber
-
-    const isNative = NATIVE_ASSETS.some(asset => asset.hash === intent.tokenHash)
-    const decimals = intent.tokenDecimals ?? 18
-    const amount = ethersBigNumber.parseFixed(intent.amount, decimals)
-
-    if (!isNative) {
-      const contract = new ethers.Contract(
-        intent.tokenHash,
-        ['function transfer(address to, uint amount) returns (bool)'],
-        wallet
-      )
-
-      estimated = await contract.estimateGas.transfer(intent.receiverAddress, amount)
-    } else {
-      estimated = await wallet.estimateGas({
-        to: intent.receiverAddress,
-        value: amount,
-      })
-    }
-
-    return ethers.utils.formatEther(estimated)
-  }
-
-  async resolveNameServiceDomain(domainName: string): Promise<string> {
-    const provider = new ethers.providers.JsonRpcProvider(this.network.url)
-    const address = await provider.resolveName(domainName)
-    if (!address) throw new Error('No address found for domain name')
-    return address
-  }
-}
+import {
+  Account,
+  AccountWithDerivationPath,
+  BSCalculableFee,
+  BSWithNameService,
+  BSWithNft,
+  BlockchainDataService,
+  BlockchainService,
+  ExchangeDataService,
+  Network,
+  NftDataService,
+  PartialBy,
+  Token,
+  TransferParam,
+} from '@cityofzion/blockchain-service'
+import { ethers } from 'ethers'
+import * as ethersJsonWallets from '@ethersproject/json-wallets'
+import * as ethersBytes from '@ethersproject/bytes'
+import * as ethersBigNumber from '@ethersproject/bignumber'
+import { DEFAULT_URL_BY_NETWORK_TYPE, DERIVATION_PATH, NATIVE_ASSETS, TOKENS } from './constants'
+import { BitqueryEDSEthereum } from './BitqueryEDSEthereum'
+import { GhostMarketNDSEthereum } from './GhostMarketNDSEthereum'
+import { RpcBDSEthereum } from './RpcBDSEthereum'
+import { BitqueryBDSEthereum } from './BitqueryBDSEthereum'
+
+export class BSEthereum<BSCustomName extends string = string>
+  implements BlockchainService, BSWithNft, BSWithNameService, BSCalculableFee
+{
+  readonly blockchainName: BSCustomName
+  readonly feeToken: Token
+  readonly derivationPath: string
+
+  blockchainDataService!: BlockchainDataService
+  exchangeDataService!: ExchangeDataService
+  tokens: Token[]
+  nftDataService!: NftDataService
+  network!: Network
+
+  constructor(blockchainName: BSCustomName, network: PartialBy<Network, 'url'>) {
+    this.blockchainName = blockchainName
+    this.derivationPath = DERIVATION_PATH
+    this.tokens = TOKENS[network.type]
+
+    this.feeToken = this.tokens.find(token => token.symbol === 'ETH')!
+    this.setNetwork(network)
+  }
+
+  setNetwork(param: PartialBy<Network, 'url'>) {
+    const network = {
+      type: param.type,
+      url: param.url ?? DEFAULT_URL_BY_NETWORK_TYPE[param.type],
+    }
+    this.network = network
+
+    if (network.type === 'custom') {
+      this.blockchainDataService = new RpcBDSEthereum(network)
+    } else {
+      this.blockchainDataService = new BitqueryBDSEthereum(network)
+    }
+
+    this.exchangeDataService = new BitqueryEDSEthereum(network.type)
+    this.nftDataService = new GhostMarketNDSEthereum(network.type)
+  }
+
+  validateAddress(address: string): boolean {
+    return ethers.utils.isAddress(address)
+  }
+
+  validateEncrypted(json: string): boolean {
+    return ethersJsonWallets.isCrowdsaleWallet(json) || ethersJsonWallets.isKeystoreWallet(json)
+  }
+
+  validateKey(key: string): boolean {
+    try {
+      if (!key.startsWith('0x')) {
+        key = '0x' + key
+      }
+      if (ethersBytes.hexDataLength(key) !== 32) return false
+
+      return true
+    } catch (error) {
+      return false
+    }
+  }
+
+  validateNameServiceDomainFormat(domainName: string): boolean {
+    if (!domainName.endsWith('.eth')) return false
+    return true
+  }
+
+  generateAccountFromMnemonic(mnemonic: string[] | string, index: number): AccountWithDerivationPath {
+    const path = this.derivationPath.replace('?', index.toString())
+    const wallet = ethers.Wallet.fromMnemonic(Array.isArray(mnemonic) ? mnemonic.join(' ') : mnemonic, path)
+
+    return {
+      address: wallet.address,
+      key: wallet.privateKey,
+      type: 'privateKey',
+      derivationPath: path,
+    }
+  }
+
+  generateAccountFromKey(key: string): Account {
+    const wallet = new ethers.Wallet(key)
+    return {
+      address: wallet.address,
+      key,
+      type: 'privateKey',
+    }
+  }
+
+  async decrypt(json: string, password: string): Promise<Account> {
+    const wallet = await ethers.Wallet.fromEncryptedJson(json, password)
+    return {
+      address: wallet.address,
+      key: wallet.privateKey,
+      type: 'privateKey',
+    }
+  }
+
+  async encrypt(key: string, password: string): Promise<string> {
+    const wallet = new ethers.Wallet(key)
+    return wallet.encrypt(password)
+  }
+
+  async transfer({ senderAccount, intent }: TransferParam): Promise<string> {
+    const provider = new ethers.providers.JsonRpcProvider(this.network.url)
+    const wallet = new ethers.Wallet(senderAccount.key, provider)
+
+    let transaction: ethers.providers.TransactionResponse
+    const decimals = intent.tokenDecimals ?? 18
+    const amount = ethersBigNumber.parseFixed(intent.amount, decimals)
+
+    const isNative = NATIVE_ASSETS.some(asset => asset.hash === intent.tokenHash)
+    if (!isNative) {
+      const contract = new ethers.Contract(
+        intent.tokenHash,
+        ['function transfer(address to, uint amount) returns (bool)'],
+        wallet
+      )
+      transaction = await contract.transfer(intent.receiverAddress, amount)
+    } else {
+      transaction = await wallet.sendTransaction({
+        to: intent.receiverAddress,
+        value: amount,
+      })
+    }
+
+    const transactionMined = await transaction.wait()
+    if (!transactionMined) throw new Error('Transaction not mined')
+
+    return transactionMined.transactionHash
+  }
+
+  async calculateTransferFee({ senderAccount, intent }: TransferParam, details?: boolean | undefined): Promise<string> {
+    const provider = new ethers.providers.JsonRpcProvider(this.network.url)
+    const wallet = new ethers.Wallet(senderAccount.key, provider)
+
+    let estimated: ethers.BigNumber
+
+    const isNative = NATIVE_ASSETS.some(asset => asset.hash === intent.tokenHash)
+    const decimals = intent.tokenDecimals ?? 18
+    const amount = ethersBigNumber.parseFixed(intent.amount, decimals)
+
+    if (!isNative) {
+      const contract = new ethers.Contract(
+        intent.tokenHash,
+        ['function transfer(address to, uint amount) returns (bool)'],
+        wallet
+      )
+
+      estimated = await contract.estimateGas.transfer(intent.receiverAddress, amount)
+    } else {
+      estimated = await wallet.estimateGas({
+        to: intent.receiverAddress,
+        value: amount,
+      })
+    }
+
+    return ethers.utils.formatEther(estimated)
+  }
+
+  async resolveNameServiceDomain(domainName: string): Promise<string> {
+    const provider = new ethers.providers.JsonRpcProvider(this.network.url)
+    const address = await provider.resolveName(domainName)
+    if (!address) throw new Error('No address found for domain name')
+    return address
+  }
+}