@exodus/assets-feature 5.14.0 → 6.0.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [6.0.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/assets-feature@5.14.0...@exodus/assets-feature@6.0.0) (2024-12-26)
+
+### ⚠ BREAKING CHANGES
+
+- **assets-feature:** forward configs from feature (#10825)
+
+### Features
+
+- feat(assets-feature)!: forward configs from feature (#10825)
+
+- feat: bitcoin as default multiple address mode (#10930)
+
+### License
+
+- license: re-license under MIT license (#10580)
+
+## [5.14.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/assets-feature@5.14.0...@exodus/assets-feature@5.14.1) (2024-11-25)
+
+### License
+
+- license: re-license under MIT license (#10580)
+
 ## [5.14.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/assets-feature@5.13.1...@exodus/assets-feature@5.14.0) (2024-10-08)
 
 ### Features

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2024 Exodus Movement, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,6 +1,6 @@
 # @exodus/assets-feature
 
-Assets module, clients and apis
+This Exodus SDK feature provides access to instances of all blockchain asset adapters supported by the wallet, and enables you to search for and add custom tokens at runtime. Added tokens persist across restarts.
 
 ## Install
 
@@ -12,34 +12,47 @@ yarn add @exodus/assets-feature
 
 `@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.
 
+Example:
+
+```js
+const myModule = {
+  id: 'myModule',
+  type: 'module,
+  factory: ({ assetsAtom }) => {
+    // get all assets known at this moment
+    const { value: assets } = await assetsAtom.get()
+    assetsAtom.observe(({ value }) => {
+      // do something with updated assets
+    })
+  },
+  dependencies: ['assetsAtom']
+}
+```
+
+### Play with it
+
+1. Open the playground https://exodus-hydra.pages.dev/features/assets
+2. Run `await exodus.assets.getAsset('bitcoin')` in the Dev Tools Console.
+3. Run `await exodus.assets.searchTokens({ lifecycleStatus: ['c', 'v'], baseAssetName: 'ethereum' })` in the Dev Tools Console.
+4. Run `await exodus.assets.addTokens({ assetIds: ['0x455e53CBB86018Ac2B8092FdCd39d8444aFFC3F6'], baseAssetName: 'ethereum', allowedStatusList: ['c', 'v'] })` in the Dev Tools Console to add the Polygon Ecosystem Token token on the ethereum chain (not financial advice).
+
+See [api/index.d.ts](./api/index.d.ts) for more details on the API and token validation/curation status.
+
+### API Side
+
+See [using the sdk](../../docs/docs-website/docs/development/using-the-sdk.md#setup-the-api-side) for more details on how features plug into the SDK and the API interface in the [type declaration](./api/index.d.ts).
+
+### UI Side
+
+See [using the sdk](../../docs/docs-website/docs/development/using-the-sdk.md#events) for more details on basic UI-side setup.
+
 ```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'
+import selectors from '~/ui/flux/selectors'
+
+const MyComponent = () => {
+  const bitcoin = useSelector(selectors.assets.createAssetByNameSelector('bitcoin'))
+  const tx = await bitcoin.api.signTx({
+    // ...,
+  })
+}
 ```

package/atoms/disabled-purposes.js

@@ -3,7 +3,7 @@ import { createStorageAtomFactory } from '@exodus/atoms'
 const createDisabledPurposesAtom = ({ storage, logger, config }) => {
   return createStorageAtomFactory({ storage, logger })({
     key: 'disabledPurposes',
-    defaultValue: config.defaults ?? {},
+    defaultValue: config.defaults,
     isSoleWriter: true,
   })
 }

package/atoms/multi-address-mode.js

@@ -8,7 +8,7 @@ const { isUndefined } = lodash
 const createMultiAddressModeAtom = ({ storage, fusion, logger, config }) => {
   const storageAtom = createStorageAtomFactory({ storage, logger })({
     key: 'multiAddressMode',
-    defaultValue: config.defaults ?? {},
+    defaultValue: config.defaults,
     isSoleWriter: true,
   })
 

package/constants.js

@@ -0,0 +1,12 @@
+export const multiAddressModeDefaultConfig = {
+  defaults: Object.create(null),
+}
+
+export const disabledPurposesDefaultConfig = {
+  defaults: Object.create(null),
+}
+
+export const defaultConfig = {
+  multiAddressMode: multiAddressModeDefaultConfig,
+  disabledPurposes: disabledPurposesDefaultConfig,
+}

package/index.js

@@ -9,17 +9,31 @@ import assetModuleDefinition from './module/index.js'
 import customTokensMonitorDefinition from './monitor/index.js'
 import assetPreferencesDefinition from './module/asset-preferences.js'
 import assetsAtomDefinition from './atoms/assets.js'
+import { defaultConfig } from './constants.js'
+
+const assets = (config = Object.create(null)) => {
+  const {
+    multiAddressMode,
+    disabledPurposes,
+    compatibilityModeGapLimits,
+    compatibilityModeMultiAddressMode,
+  } = { ...defaultConfig, ...config }
 
-const assets = ({ config = {} } = {}) => {
   return {
     id: 'assets',
     definitions: [
-      { definition: assetsClientInterfaceDefinition },
+      {
+        definition: assetsClientInterfaceDefinition,
+        config: {
+          compatibilityModeGapLimits,
+          compatibilityModeMultiAddressMode,
+        },
+      },
       { definition: assetsPluginDefinition },
       {
         definition: multiAddressModeAtomDefinition,
         storage: { namespace: 'assetPreferences' },
-        config: config.multiAddressMode || {},
+        config: multiAddressMode,
       },
       { definition: legacyAddressModeAtomDefinition },
       { definition: taprootAddressModeAtomDefinition },
@@ -27,7 +41,7 @@ const assets = ({ config = {} } = {}) => {
       {
         definition: disabledPurposesAtomDefinition,
         storage: { namespace: 'assetPreferences' },
-        config: config.disabledPurposes || {},
+        config: disabledPurposes,
       },
       { definition: assetsApiDefinition },
       // TODO: add storage namespace once we remove customTokensStorage

package/module/asset-preferences.js

@@ -25,11 +25,17 @@ class AssetPreferences {
       ...assetNames.reduce((acc, assetName) => {
         acc[assetName] = true
         return acc
-      }, {}),
+      }, Object.create(null)),
     }))
 
   disableMultiAddressMode = ({ assetNames }) =>
-    this.#multiAddressModeAtom.set((value) => omit(value, assetNames))
+    this.#multiAddressModeAtom.set((value) => ({
+      ...value,
+      ...assetNames.reduce((acc, assetName) => {
+        acc[assetName] = false
+        return acc
+      }, Object.create(null)),
+    }))
 
   enableLegacyAddressMode = async ({ assetNames }) => {
     assert(
@@ -42,7 +48,7 @@ class AssetPreferences {
       ...assetNames.reduce((acc, assetName) => {
         acc[assetName] = true
         return acc
-      }, {}),
+      }, Object.create(null)),
     }))
   }
 
@@ -66,7 +72,7 @@ class AssetPreferences {
       ...assetNames.reduce((acc, assetName) => {
         acc[assetName] = true
         return acc
-      }, {}),
+      }, Object.create(null)),
     }))
   }
 

package/module/utils.js

@@ -4,7 +4,7 @@ import assert from 'minimalistic-assert'
 
 const { get } = lodash
 
-const BLACKLISTED_ERRORS = [/Cannot destructure property 'owner'/]
+const BLACKLISTED_ERRORS = [/Cannot destructure property 'owner'/u]
 
 export const getAssetFromAssetId = (assets, assetId, baseAssetName) => {
   assert(assetId, 'getAssetFromAssetId(): assetId is required')

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@exodus/assets-feature",
-  "version": "5.14.0",
-  "license": "UNLICENSED",
-  "description": "Assets module, clients and apis",
+  "version": "6.0.0",
+  "license": "MIT",
+  "description": "This Exodus SDK feature provides access to instances of all blockchain asset adapters supported by the wallet, and enables you to search for and add custom tokens at runtime.",
   "type": "module",
   "main": "index.js",
   "author": "Exodus Movement, Inc.",
@@ -19,6 +19,7 @@
     "monitor",
     "plugin",
     "redux",
+    "constants.js",
     "index.d.ts",
     "CHANGELOG.md",
     "README.md",
@@ -37,7 +38,7 @@
     "@exodus/atoms": "^9.0.0",
     "@exodus/basic-utils": "^3.0.1",
     "@exodus/fetch": "^1.3.0",
-    "@exodus/fusion-atoms": "^1.2.0",
+    "@exodus/fusion-atoms": "^1.4.0",
     "@exodus/timer": "^1.1.2",
     "lodash": "^4.17.21",
     "minimalistic-assert": "^1.0.1",
@@ -45,31 +46,35 @@
     "reselect": "^3.0.1"
   },
   "devDependencies": {
-    "@exodus/available-assets": "^8.6.0",
+    "@exodus/available-assets": "^8.7.0",
     "@exodus/bip44-constants": "^195.0.0",
     "@exodus/bitcoin-meta": "^2.0.0",
-    "@exodus/bitcoin-plugin": "^1.0.3",
-    "@exodus/bitcoinregtest-plugin": "^1.0.3",
-    "@exodus/bitcointestnet-plugin": "^1.0.3",
-    "@exodus/blockchain-metadata": "^15.5.0",
+    "@exodus/bitcoin-plugin": "^1.29.1",
+    "@exodus/bitcoinregtest-plugin": "^1.11.0",
+    "@exodus/bitcointestnet-plugin": "^1.13.1",
+    "@exodus/blockchain-metadata": "^15.7.1",
     "@exodus/cardano-lib": "^2.2.0",
     "@exodus/combined-assets-meta": "^3.0.0",
-    "@exodus/cosmos-plugin": "^1.0.0",
+    "@exodus/cosmos-plugin": "^1.3.3",
     "@exodus/ethereum-lib": "^5.0.0",
     "@exodus/ethereum-meta": "^2.0.0",
-    "@exodus/fusion-local": "^2.0.6",
-    "@exodus/keychain": "^6.9.1",
-    "@exodus/models": "^12.1.0",
-    "@exodus/osmosis-plugin": "^1.0.0",
-    "@exodus/public-key-provider": "^3.0.0",
-    "@exodus/redux-dependency-injection": "^4.0.3",
-    "@exodus/storage-memory": "^2.2.1",
-    "@exodus/wallet-accounts": "^17.0.0",
+    "@exodus/fusion-local": "^2.1.0",
+    "@exodus/keychain": "^7.3.0",
+    "@exodus/logger": "^1.2.3",
+    "@exodus/models": "^12.3.0",
+    "@exodus/osmosis-plugin": "^1.3.3",
+    "@exodus/public-key-provider": "^4.0.2",
+    "@exodus/redux-dependency-injection": "^4.1.1",
+    "@exodus/storage-memory": "^2.2.2",
+    "@exodus/wallet-accounts": "^17.1.3",
     "@exodus/wild-emitter": "^1.0.0",
     "bip39": "^3.1.0",
     "events": "^3.3.0",
     "msw": "^2.0.0",
     "redux": "^4.0.0"
   },
-  "gitHead": "c973d67602c94bdc2fad1b253fc6e5e684cde7c8"
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "361f9f307a50254391dbf46ccb95e6520c203e29"
 }

package/redux/selectors/index.js

@@ -61,7 +61,8 @@ const createMultiAddressModeSelectorDefinition = {
     memoize((assetName) =>
       createSelector(
         multiAddressModeDataSelector,
-        (multiAddressModeData) => multiAddressModeData[assetName] || false
+        (multiAddressModeData) =>
+          multiAddressModeData[assetName] ?? multiAddressModeData.bitcoin ?? false
       )
     ),
   dependencies: [{ selector: 'multiAddressMode' }],