@exodus/assets-feature 4.1.2 → 5.1.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.1.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/assets-feature@5.0.0...@exodus/assets-feature@5.1.0) (2024-04-23)
+
+### Features
+
+- type remaining API methods shipped with headless ([#6619](https://github.com/ExodusMovement/exodus-hydra/issues/6619)) ([d1ec08e](https://github.com/ExodusMovement/exodus-hydra/commit/d1ec08e695f0df2c9e63b01169c746ef872fe541))
+
+## [5.0.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/assets-feature@4.1.2...@exodus/assets-feature@5.0.0) (2024-03-11)
+
+### ⚠ BREAKING CHANGES
+
+- get public key from `publicKeyProvider` (#5924)
+
+### Code Refactoring
+
+- get public key from `publicKeyProvider` ([#5924](https://github.com/ExodusMovement/exodus-hydra/issues/5924)) ([5f656cf](https://github.com/ExodusMovement/exodus-hydra/commit/5f656cf41503ff59e98dc0259b0e76b30c94a5e2))
+
 ## [4.1.2](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/assets-feature@4.1.1...@exodus/assets-feature@4.1.2) (2024-02-20)
 
 ### Bug Fixes

package/README.md

@@ -7,3 +7,39 @@ Assets module, clients and apis
 ```sh
 yarn add @exodus/assets-feature
 ```
+
+## Usage
+
+`@exodus/assets-feature` is bundled with `@exodus/headless`. It injects the `assetsAtom` into the IOC, which you can then reference in your feature's dependencies to get all/any particular assets.
+
+```js
+import createExodus from '@exodus/headless'
+
+const container = createExodus({ adapters, config, port })
+const terribleTickersFeatureYouShouldNotUse = () => ({
+  id: 'tickers',
+  definitions: [
+    {
+      definition: {
+        id: 'tickers',
+        type: 'api',
+        factory: ({ assetsAtom }) => ({
+          tickers: {
+            get: async (name) => {
+              const { value: assets } = await assetsAtom.get()
+              return assets[name].ticker
+            },
+          },
+        }),
+
+        // provided by `@exodus/assets-feature`
+        dependencies: ['assetsAtom'],
+      },
+    },
+  ],
+})
+
+container.use(terribleTickersFeatureYouShouldNotUse())
+const exodus = container.resolve()
+exodus.tickers.get('bitcoin').then(console.log) // 'BTC'
+```

package/api/index.d.ts

@@ -0,0 +1,14 @@
+declare const assetsApiDefinition: {
+  id: 'assetsApi'
+  type: 'api'
+  factory(): {
+    assets: {
+      enableMultiAddressMode(params: { assetNames: string[] }): Promise<void>
+      disableMultiAddressMode(params: { assetNames: string[] }): Promise<void>
+      disablePurpose(params: { assetName: string; purpose: number }): Promise<void>
+      enablePurpose(params: { assetName: string; purpose: number }): Promise<void>
+    }
+  }
+}
+
+export default assetsApiDefinition

package/client/asset-client-interface.js

@@ -8,10 +8,10 @@ class AssetClientInterface {
   #walletAccountsAtom
   #enabledWalletAccountsAtom
   #transactionSigner
+  #publicKeyProvider
 
   constructor({
     blockchainMetadata,
-    wallet,
     walletAccountsAtom,
     enabledWalletAccountsAtom,
     assetsModule,
@@ -19,9 +19,9 @@ class AssetClientInterface {
     addressProvider,
     feeMonitors,
     transactionSigner,
+    publicKeyProvider,
   }) {
     this.blockchainMetadata = blockchainMetadata
-    this.wallet = wallet
     this.#walletAccountsAtom = walletAccountsAtom
     this.#enabledWalletAccountsAtom = enabledWalletAccountsAtom
     this.assetsModule = assetsModule
@@ -29,6 +29,7 @@ class AssetClientInterface {
     this.feeMonitors = feeMonitors
     this.#availableAssetNamesAtom = availableAssetNamesAtom
     this.#transactionSigner = transactionSigner
+    this.#publicKeyProvider = publicKeyProvider
 
     // TODO: remove conditional when clients updated
     if (assetsModule.initialize) {
@@ -172,13 +173,26 @@ class AssetClientInterface {
 
   // addresses interface
 
-  getPublicKey = async ({ assetName, walletAccount, addressIndex = 0, chainIndex = 0 }) => {
+  getPublicKey = async ({
+    assetName,
+    walletAccount,
+    purpose = 44,
+    addressIndex = 0,
+    chainIndex = 0,
+  }) => {
     const walletAccountInstance = await this.#getWalletAccount(walletAccount)
-    return this.wallet.getPublicKey({
+    const asset = this.assetsModule.getAsset(assetName)
+
+    const keyIdentifier = asset.baseAsset.api.getKeyIdentifier({
+      purpose,
       accountIndex: walletAccountInstance.index,
-      baseAssetName: assetName,
-      addressIndex,
       chainIndex,
+      addressIndex,
+    })
+
+    return this.#publicKeyProvider.getPublicKey({
+      walletAccount: walletAccountInstance,
+      keyIdentifier,
     })
   }
 

package/client/index.js

@@ -14,6 +14,7 @@ const assetsClientInterfaceDefinition = {
     'addressProvider',
     'feeMonitors',
     'transactionSigner',
+    'publicKeyProvider',
   ],
 }
 

package/index.d.ts

@@ -0,0 +1,8 @@
+import assetsApiDefinition from './api'
+
+declare const assets: () => {
+  id: 'assets'
+  definitions: [{ definition: typeof assetsApiDefinition }]
+}
+
+export default assets

package/module/asset-preferences.js

@@ -1,4 +1,4 @@
-import ExodusModule from '@exodus/module'
+import ExodusModule from '@exodus/module' // eslint-disable-line import/no-deprecated
 import { omit } from '@exodus/basic-utils'
 
 const MODULE_ID = 'assetPreferences'

package/module/assets-module.js

@@ -46,8 +46,8 @@ const _isDisabledCustomToken = (token) => token.lifecycleStatus === STATUS.DISAB
 const normalizeToken = (token) => ({
   ...token,
   name: token.name || token.assetName,
-  displayName: token.displayName || token.properName,
-  displayTicker: token.displayTicker || token.properTicker,
+  displayName: token.displayName || token.properName, // eslint-disable-line @exodus/hydra/no-asset-proper
+  displayTicker: token.displayTicker || token.properTicker, // eslint-disable-line @exodus/hydra/no-asset-proper
 })
 
 const initialAssetRegistry = {

package/package.json

@@ -1,25 +1,26 @@
 {
   "name": "@exodus/assets-feature",
-  "version": "4.1.2",
+  "version": "5.1.0",
   "license": "UNLICENSED",
   "description": "Assets module, clients and apis",
   "main": "index.js",
-  "author": "Exodus Movement Inc.",
+  "author": "Exodus Movement, Inc.",
   "scripts": {
-    "test": "jest",
-    "lint": "eslint . --ignore-path ../../.gitignore",
+    "test": "run -T jest",
+    "lint": "run -T eslint . --ignore-path ../../.gitignore",
     "lint:fix": "yarn lint --fix"
   },
   "files": [
+    "api",
+    "atoms",
     "client",
     "module",
     "monitor",
     "plugin",
     "redux",
-    "api",
-    "atoms",
-    "README.md",
+    "index.d.ts",
     "CHANGELOG.md",
+    "README.md",
     "!**/__tests__/**"
   ],
   "homepage": "https://github.com/ExodusMovement/exodus-hydra/tree/master/features/assets-feature",
@@ -43,26 +44,29 @@
     "reselect": "^3.0.1"
   },
   "devDependencies": {
-    "@exodus/available-assets": "^8.0.0",
+    "@exodus/available-assets": "^8.1.0",
+    "@exodus/bip44-constants": "^195.0.0",
     "@exodus/bitcoin-meta": "^1.0.1",
     "@exodus/bitcoin-plugin": "^1.0.3",
     "@exodus/bitcoinregtest-plugin": "^1.0.3",
     "@exodus/bitcointestnet-plugin": "^1.0.3",
-    "@exodus/blockchain-metadata": "^15.1.0",
+    "@exodus/blockchain-metadata": "^15.3.0",
     "@exodus/combined-assets-meta": "^1.2.5",
     "@exodus/cosmos-plugin": "^1.0.0",
+    "@exodus/ethereum-lib": "^4.2.7",
     "@exodus/ethereum-meta": "^1.1.0",
+    "@exodus/keychain": "^6.1.1",
     "@exodus/models": "^9.1.1",
     "@exodus/osmosis-plugin": "^1.0.0",
+    "@exodus/public-key-provider": "^2.0.1",
     "@exodus/redux-dependency-injection": "^3.0.0",
     "@exodus/storage-memory": "^2.1.1",
-    "@exodus/wallet-accounts": "^16.0.0",
+    "@exodus/wallet-accounts": "^16.3.1",
     "@exodus/wild-emitter": "^1.0.0",
-    "eslint": "^8.44.0",
+    "bip39": "^3.1.0",
     "events": "^3.3.0",
-    "jest": "^29.1.2",
     "msw": "^2.0.0",
     "redux": "^4.0.0"
   },
-  "gitHead": "27ed0586ad800043afc77ebe8192259fcfb966cc"
+  "gitHead": "34f1dab70f6c2fc0062d946f5c74ae84e5379539"
 }