@exodus/assets-feature 1.0.0

package/README.md

@@ -0,0 +1,9 @@
+# @exodus/assets-feature
+
+Assets module, clients and apis
+
+## Install
+
+```sh
+yarn add @exodus/assets-feature
+```

package/client/asset-client-interface.js

@@ -0,0 +1,210 @@
+import { pickBy } from '@exodus/basic-utils'
+import { isEmpty } from 'lodash'
+import assert from 'minimalistic-assert'
+
+class AssetClientInterface {
+  #availableAssetNamesAtom
+  #walletAccountsAtom
+  #enabledWalletAccountsAtom
+
+  constructor({
+    blockchainMetadata,
+    wallet,
+    walletAccountsAtom,
+    enabledWalletAccountsAtom,
+    assetsModule,
+    availableAssetNamesAtom,
+    addressProvider,
+    feeMonitors,
+  }) {
+    this.blockchainMetadata = blockchainMetadata
+    this.wallet = wallet
+    this.#walletAccountsAtom = walletAccountsAtom
+    this.#enabledWalletAccountsAtom = enabledWalletAccountsAtom
+    this.assetsModule = assetsModule
+    this.addressProvider = addressProvider
+    this.feeMonitors = feeMonitors
+    this.#availableAssetNamesAtom = availableAssetNamesAtom
+  }
+
+  getTxHistory = async ({ assetName, walletAccount }) => {
+    return this.blockchainMetadata.getTxLog({ assetName, walletAccount })
+  }
+
+  async getTxLog({ assetName, walletAccount }) {
+    return this.blockchainMetadata.getTxLog({ assetName, walletAccount })
+  }
+
+  async updateTxLogAndNotify(params) {
+    return this.updateTxLogAndNotifyBatch(params).commit()
+  }
+
+  updateTxLogAndNotifyBatch = ({
+    assetName,
+    walletAccount,
+    txs,
+    batch = this.blockchainMetadata.batch(),
+  }) => {
+    return batch.updateTxs({ assetName, walletAccount, txs })
+  }
+
+  async getAccountState({ assetName, walletAccount }) {
+    return this.blockchainMetadata.getAccountState({ assetName, walletAccount })
+  }
+
+  async updateAccountState(params) {
+    return this.updateAccountStateBatch(params).commit()
+  }
+
+  updateAccountStateBatch = ({
+    assetName,
+    walletAccount,
+    newData,
+    batch = this.blockchainMetadata.batch(),
+  }) => {
+    if (!isEmpty(newData)) {
+      return batch.updateAccountState({ assetName, walletAccount, newData })
+    }
+
+    return batch
+  }
+
+  removeTxLog = async (params) => {
+    return this.removeTxLogBatch(params).commit()
+  }
+
+  removeTxLogBatch = ({
+    assetName,
+    walletAccount,
+    txs,
+    batch = this.blockchainMetadata.batch(),
+  }) => {
+    return batch.removeTxs({ assetName, walletAccount, txs })
+  }
+
+  async getWalletAccounts({ assetName }) {
+    // In the future, the list of wallets may be different based on the provided assets
+    const asset = this.assetsModule.getAsset(assetName)
+    assert(asset, `${assetName} is not supported`)
+    return Object.keys(await this.#enabledWalletAccountsAtom.get())
+  }
+
+  async getAssetsForNetwork({ baseAssetName }) {
+    const availableAssetNames = new Set(await this.#availableAssetNamesAtom.get())
+    return pickBy(
+      this.assetsModule.getAssets(),
+      (asset) => asset.baseAsset.name === baseAssetName && availableAssetNames.has(asset.name)
+    )
+  }
+
+  async getConfirmationsNumber({ assetName }) {
+    const baseAsset = this.assetsModule.getAsset(assetName).baseAsset
+    return baseAsset.api?.getConfirmationsNumber ? baseAsset.api.getConfirmationsNumber() : 1
+  }
+
+  async updateFeeConfig({ assetName, feeConfig }) {
+    await this.feeMonitors.updateFee({ assetName, feeData: feeConfig })
+  }
+
+  async getFeeData({ assetName }) {
+    const baseAssetName = this.assetsModule.getAsset(assetName).baseAsset.name
+    return this.feeMonitors.getFeeData({ assetName: baseAssetName })
+  }
+
+  // The interface consumer does not need to know the structure of the returned batch object, just
+  // that it needs to be passed along wherever operations need to be batched.
+  createOperationsBatch = () => this.blockchainMetadata.batch()
+
+  executeOperationsBatch = async (batch) => batch.commit()
+
+  getPublicKey = async ({ assetName, walletAccount, addressIndex = 0, chainIndex = 0 }) => {
+    const walletAccountInstance = await this.#getWalletAccount(walletAccount)
+    return this.wallet.getPublicKey({
+      accountIndex: walletAccountInstance.index,
+      baseAssetName: assetName,
+      addressIndex,
+      chainIndex,
+    })
+  }
+
+  getAddress = async (opts) => {
+    return this.addressProvider.getAddress({
+      ...opts,
+      walletAccount: await this.#getWalletAccount(opts.walletAccount),
+    })
+  }
+
+  getReceiveAddress = async (opts) => {
+    const address = await this.getReceiveAddressObject(opts)
+    return address.toString()
+  }
+
+  getReceiveAddressObject = async (opts) => {
+    return this.addressProvider.getReceiveAddress({
+      ...opts,
+      walletAccount: await this.#getWalletAccount(opts.walletAccount),
+    })
+  }
+
+  getReceiveAddresses = async (opts) => {
+    const addresses = await this.addressProvider.getReceiveAddresses({
+      ...opts,
+      walletAccount: await this.#getWalletAccount(opts.walletAccount),
+    })
+
+    return [...addresses].map((address) => address.toString())
+  }
+  getChangeAddresses = async (opts) => {
+    const addresses = await this.addressProvider.getChangeAddresses({
+      ...opts,
+      walletAccount: await this.#getWalletAccount(opts.walletAccount),
+    })
+
+    return [...addresses].map((address) => address.toString())
+  }
+
+  #getWalletAccount = async (name) => {
+    const walletAccounts = await this.#walletAccountsAtom.get()
+    return walletAccounts[name]
+  }
+
+  getSupportedPurposes = async ({ assetName, walletAccount }) => {
+    return this.addressProvider.getSupportedPurposes({
+      assetName,
+      walletAccount: await this.#getWalletAccount(walletAccount),
+    })
+  }
+
+  getUnusedAddressIndexes = async ({ assetName, walletAccount }) => {
+    return this.addressProvider.getUnusedAddressIndexes({
+      assetName,
+      walletAccount: await this.#getWalletAccount(walletAccount),
+    })
+  }
+
+  saveUnusedAddressIndexes = async () => {
+    // no op!! getUnusedAddressIndexes loads from tx log, not from storage
+  }
+
+  signTransaction = async ({ assetName, unsignedTx, walletAccount }) => {
+    const accountIndex = (await this.#getWalletAccount(walletAccount)).index
+    const baseAssetName = this.assetsModule.getAsset(assetName).baseAsset.name
+    return this.wallet.signTransaction({ baseAssetName, unsignedTx, accountIndex })
+  }
+
+  getNextChangeAddress = async ({ assetName, walletAccount }) => {
+    return this.addressProvider.getUnusedAddress({
+      assetName,
+      walletAccount: await this.#getWalletAccount(walletAccount),
+      chainIndex: 1,
+    })
+  }
+
+  getFeeConfig = async ({ assetName }) => {
+    return this.feeMonitors.getFeeData({ assetName })
+  }
+}
+
+const createAssetClientInterface = (args) => new AssetClientInterface(args)
+
+export default createAssetClientInterface

package/client/index.js

@@ -0,0 +1,19 @@
+import createAssetClientInterface from './asset-client-interface'
+
+const assetsClientInterfaceDefinition = {
+  id: 'assetClientInterface',
+  type: 'module',
+  factory: createAssetClientInterface,
+  dependencies: [
+    'blockchainMetadata',
+    'wallet',
+    'walletAccountsAtom',
+    'enabledWalletAccountsAtom',
+    'assetsModule',
+    'availableAssetNamesAtom',
+    'addressProvider',
+    'feeMonitors',
+  ],
+}
+
+export default assetsClientInterfaceDefinition

package/index.js

@@ -0,0 +1,10 @@
+import assetsClientInterfaceDefinition from './client'
+
+const assets = () => {
+  return {
+    id: 'assets',
+    definitions: [{ definition: assetsClientInterfaceDefinition }],
+  }
+}
+
+export default assets

package/module/index.js

@@ -0,0 +1,5 @@
+// TODO: ship assets module here in the future
+
+const assetsModuleDefinition = {}
+
+export default assetsModuleDefinition

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@exodus/assets-feature",
+  "version": "1.0.0",
+  "license": "UNLICENSED",
+  "description": "Assets module, clients and apis",
+  "main": "index.js",
+  "author": "Exodus Movement Inc.",
+  "scripts": {
+    "test": "jest",
+    "lint": "eslint . --ignore-path ../../.gitignore",
+    "lint:fix": "yarn lint --fix"
+  },
+  "files": [
+    "client",
+    "module",
+    "README.md",
+    "CHANGELOG.md",
+    "!**/__tests__/**"
+  ],
+  "homepage": "https://github.com/ExodusMovement/exodus-hydra/tree/master/features/assets-feature",
+  "bugs": {
+    "url": "https://github.com/ExodusMovement/exodus-hydra/issues?q=is%3Aissue+is%3Aopen+label%3Aassets-feature"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ExodusMovement/exodus-hydra.git"
+  },
+  "dependencies": {
+    "@exodus/basic-utils": "^2.1.0",
+    "lodash": "^4.17.21",
+    "minimalistic-assert": "^1.0.1"
+  },
+  "devDependencies": {
+    "@exodus/available-assets": "^4.0.0",
+    "@exodus/models": "^9.1.1",
+    "@exodus/storage-memory": "^2.1.0",
+    "@exodus/wallet-accounts": "^12.0.2"
+  },
+  "gitHead": "69a96e03f6c96d7284d98abb832a7b59b58f718b"
+}