@exodus/headless 2.0.0-alpha.47 → 2.0.0-alpha.48

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.0.0-alpha.48](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/headless@2.0.0-alpha.47...@exodus/headless@2.0.0-alpha.48) (2023-06-20)
+
+### Bug Fixes
+
+- declare atoms in writesAtoms ([#2006](https://github.com/ExodusMovement/exodus-hydra/issues/2006)) ([02b7227](https://github.com/ExodusMovement/exodus-hydra/commit/02b72271116b4e3b034b7f889b0dc333fda17413))
+
 ## [2.0.0-alpha.47](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/headless@2.0.0-alpha.46...@exodus/headless@2.0.0-alpha.47) (2023-06-18)
 
 ### Features

package/README.md

@@ -15,6 +15,7 @@ The headless Exodus wallet SDK
 
 ```js
 import createExodus from '@exodus/headless'
+import referrals from '@exodus/headless/src/modules/referrals'
 import Emitter from '@exodus/wild-emitter'
 
 // 1. Create port. Acts as an event bus between headless wallet and client
@@ -25,10 +26,10 @@ const adapters = {}
 const config = {}
 
 // 3. Create Exodus container
-const container = createExodus({ port, adapters, config })
+const exodusContainer = createExodus({ port, adapters, config })
 
 // 4. Register external modules. Does not support overriding modules at the moment.
-container.register({
+exodusContainer.register({
   definition: {
     id: 'remoteConfig',
     factory: createRemoteConfig,
@@ -36,14 +37,22 @@ container.register({
   },
 })
 
+// see an example feature definition:
+// https://github.com/ExodusMovement/exodus-hydra/blob/2e8d63426421ffcbec84a9b6fbc83eb913b47eba/modules/headless/src/modules/geolocation/index.js
+exodusContainer.use(referrals())
+exodusContainer.use(myCustomFeature({ id: 'myCustomFeature', ... }))
+
 // 5. Resolve exodus instance
-const exodus = container.resolve()
+const exodus = exodusContainer.resolve()
 
 // 6. Start exodus instance
 await exodus.wallet.start()
 
 // 7. Use it!
 await exodus.wallet.create({ passphrase: 'my-super-secure-passphrase' })
+
+// 8. Use your custom feature API, if any
+exodus.myCustomFeature.doThatThingYouDo()
 ```
 
 ## Lifecycle

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/headless",
-  "version": "2.0.0-alpha.47",
+  "version": "2.0.0-alpha.48",
   "description": "The headless Exodus wallet SDK",
   "author": "Exodus Movement Inc",
   "main": "src/index.js",
@@ -45,6 +45,7 @@
     "@exodus/feature-flags": "^2.1.0",
     "@exodus/fee-monitors": "^1.0.0",
     "@exodus/fetch": "^1.2.1",
+    "@exodus/fusion": "^5.0.0",
     "@exodus/geolocation": "^2.0.0",
     "@exodus/key-identifier-provider": "^1.1.3",
     "@exodus/keychain": "^4.0.0",
@@ -88,5 +89,5 @@
     "nock": "^13.3.1",
     "p-defer": "^4.0.0"
   },
-  "gitHead": "003665277a4a7ee772af60ab555f5692b1f840f6"
+  "gitHead": "a8a419acb6f13d21b294f346e1c00f10a5b3a90b"
 }

package/src/modules/ab-testing/index.js

@@ -15,7 +15,7 @@ const abTesting = () => {
       },
       {
         definition: abTestingDefinition,
-        writesAtom: ['abTestingAtom'],
+        writesAtoms: ['abTestingAtom'],
       },
       { definition: abTestingPluginDefinition },
       { definition: abTestingApiDefinition },

package/src/modules/locale/index.js

@@ -1,4 +1,5 @@
-import { createFusionAtomFactory, createStorageAtomFactory } from '@exodus/atoms'
+import { createStorageAtomFactory } from '@exodus/atoms'
+import { fusionAtomFactory } from '@exodus/fusion/atoms'
 
 import localeApiDefinition from './api'
 import localePluginDefinition from './plugin'
@@ -12,7 +13,8 @@ const locale = () => {
           id: 'currencyAtom',
           type: 'atom',
           factory: ({ fusion, config }) =>
-            createFusionAtomFactory({ fusion })({
+            fusionAtomFactory({
+              fusion,
               path: `private.currency`,
               defaultValue: config.defaultValue,
             }),
@@ -39,8 +41,8 @@ const locale = () => {
         ],
         storage: { namespace: 'locale' },
       },
-      { definition: localePluginDefinition },
-      { definition: localeApiDefinition },
+      { definition: localePluginDefinition, writesAtoms: ['languageAtom'] },
+      { definition: localeApiDefinition, writesAtoms: ['languageAtom', 'currencyAtom'] },
     ],
   }
 }

package/src/modules/nfts/index.js

@@ -23,7 +23,7 @@ const nfts = () => {
         definition: { type: 'monitor', ...nftsMonitorDefinition },
         writesAtoms: ['nftsCacheAtom'],
       },
-      { definition: nftsModuleDefinition },
+      { definition: nftsModuleDefinition, writesAtoms: ['nftsCacheAtom', 'nftsConfigAtom'] },
       { definition: nftsPluginDefinition },
       { definition: nftsApiDefinition },
     ],

package/src/modules/personal-notes/index.js

@@ -18,7 +18,10 @@ const personalNotes = () => {
           },
         ],
       },
-      { definition: { type: 'module', ...personalNotesDefinition } },
+      {
+        definition: { type: 'module', ...personalNotesDefinition },
+        writesAtoms: ['personalNotesAtom'],
+      },
       { definition: personalNotesPluginDefinition },
       { definition: personalNotesApiDefinition },
     ],

package/src/modules/wallet/index.js

@@ -15,7 +15,7 @@ const wallet = () => {
       },
       { definition: lockedAtomDefinition },
       { definition: restoreAtomDefinition },
-      { definition: restorePluginDefinition },
+      { definition: restorePluginDefinition, writesAtoms: ['restoreAtom'] },
       { definition: walletApi },
     ],
   }