@exodus/activity-txs 4.3.2 → 4.3.4

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.3.4](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/activity-txs@4.3.3...@exodus/activity-txs@4.3.4) (2024-09-16)
+
+### Bug Fixes
+
+- **activity-txs:** make id to return orderId ([#9215](https://github.com/ExodusMovement/exodus-hydra/issues/9215)) ([a2f77b4](https://github.com/ExodusMovement/exodus-hydra/commit/a2f77b4e06c7302d3fda66a72d9a2b72025820c1))
+
+## [4.3.3](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/activity-txs@4.3.2...@exodus/activity-txs@4.3.3) (2024-09-09)
+
+**Note:** Version bump only for package @exodus/activity-txs
+
 ## [4.3.2](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/activity-txs@4.3.1...@exodus/activity-txs@4.3.2) (2024-07-25)
 
 ### Bug Fixes

package/README.md

@@ -1,18 +1,72 @@
 # @exodus/activity-txs
 
-Activity consists of a set of asset transactions that are transformed using `asset.api.getActivityTxs`
-which returns Array of Tx [models](https://github.com/ExodusMovement/exodus-core/blob/cdff25bb962b2301613588c615c5ac09b05f260a/packages/models/src/tx/index.js#L10): `[Tx, Tx, Tx]`
-Most of the assets don't have this api and simply return original txs.
-An example of this transformation is combining bitcoin batched transactions into a single activity item, instead of multiple Txs you get single Tx with adjusted `coinAmount`.
-These are utilized in the UI to display transaction history.
+This feature generates user-friendly activity from transactions, orders, fiat orders, NFTs, and connections by grouping, batching, and formatting them.
 
-This feature introduces atoms with activity items generated from txLog and accountState.
-It provides an efficient way to store them by wallet accounts and to update this extensive object while avoiding unnecessary re-computations.
-Additionally, it offers extra redux selectors to retrieve activity limited by size or batched activity items.
+## How it works
+
+Each asset’s activity consists of a set of transactions transformed using `asset.api.getActivityTxs`, which returns an array of Tx [models](https://github.com/ExodusMovement/exodus-core/blob/cdff25bb962b2301613588c615c5ac09b05f260a/packages/models/src/tx/index.js#L10): `[Tx, Tx, Tx]`.
+
+**Most assets don't have this API and simply return the original transactions.**
+
+For example, Bitcoin batched transactions are combined into a single activity item. Instead of multiple transactions (Txs), you get a single transaction with a summarized `coinAmount`.
+
+This feature introduces atoms with activity items generated from `txLog` and `accountState`. It provides an efficient way to store these items by wallet accounts and update this extensive object while avoiding unnecessary re-computations.
+
+Additionally, it offers extra Redux selectors to retrieve activity, limited by size or batched activity items. These selectors format activity depending on its type: NFTs (if the `nfts` module is integrated), fiat orders (if the fiat module is integrated), and swap orders (if the orders feature is integrated).
 
 ## Usage
 
-`ioc.use(activityTxs())`
+This feature is designed to be used together with `@exodus/headless`. See [Using the SDK](../../docs/using-the-sdk.md) for more details.
+
+### API Side
+
+The feature doesn't have a public API. Data is transformed automatically, stored in `activityTxsAtom`, and emitted to be stored in the Redux state.
+
+### Play with it
+
+1. Open the playground at https://exodus-hydra.pages.dev/features/activity-txs
+2. Run the following command in the Dev Tools Console to see activity for Bitcoin:
+
+   ```js
+   selectors.activityTxs.createFullActivity({
+     nftsNetworkNameToAssetName: { fantom: 'fantommainnet' },
+   })({ assetName: 'bitcoin', walletAccount: 'exodus_0' })(store.getState())
+   ```
+
+3. run the following command in the Dev Tools Console to see activity for Bitcoin and Ethereum together:
+
+```js
+selectors.activityTxs.createMultiActivity({
+  createAssetSourceActivitySelector: selectors.activityTxs.createFullActivity({
+    nftsNetworkNameToAssetName: { fantom: 'fantommainnet' },
+  }),
+})({ assetNames: ['bitcoin', 'ethereum'], walletAccounts: ['exodus_0', 'exodus_1'] })(
+  store.getState()
+)
+```
+
+4. Try out some other selectors from `selectors.activityTxs`. See example usage in [tests](./redux/__tests__/selectors/).
+
+### UI Side
+
+See [using the sdk](../../docs/using-the-sdk.md#events) for more details on basic UI-side setup.
+
+```js
+import selectors from '~/ui/flux/selectors'
+
+const fullAssetSourceActivitySelector = selectors.activityTxs.createFullActivity({
+  nftsNetworkNameToAssetName: { fantom: 'fantommainnet' },
+})
+
+const MyComponent = () => {
+  const bitcoinActivity = useSelector(
+    fullAssetSourceActivitySelector({ assetName: 'bitcoin', walletAccount: 'exodus_0' })
+  )
 
-selector example to get batched activity for specific asset from specific account:
-`selectors.activityTxs.createBatchedAssetSourceSelector({ assetName, walletAccount })` return array of txs `[Tx, Tx, ...]`
+  return bitcoinActivity.map((activityItem) => (
+    <Text>
+      {activityItem.assetName} : {activityItem.displayAmount}
+    </Text>
+  ))
+}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/activity-txs",
-  "version": "4.3.2",
+  "version": "4.3.4",
   "description": "The activity-txs feature",
   "author": "Exodus Movement, Inc.",
   "repository": {
@@ -25,15 +25,15 @@
     "!**/*.test.js"
   ],
   "scripts": {
-    "lint": "run -T eslint . --ignore-path ../../.gitignore",
+    "lint": "run -T eslint -c ../../eslint.config.mjs",
     "lint:fix": "yarn lint --fix",
-    "test": "run -T jest"
+    "test": "run -T exodus-test --jest --esbuild"
   },
   "dependencies": {
-    "@exodus/atoms": "^8.0.0",
-    "@exodus/basic-utils": "^2.3.0",
+    "@exodus/atoms": "^8.1.1",
+    "@exodus/basic-utils": "^3.0.1",
     "@exodus/core-selectors": "^1.5.0",
-    "@exodus/models": "^10.1.0",
+    "@exodus/models": "^12.0.1",
     "@exodus/module": "^1.2.2",
     "@exodus/multi-account-redux": "^2.0.1",
     "@exodus/typeforce": "^1.19.0",
@@ -44,22 +44,22 @@
   "devDependencies": {
     "@exodus/assets": "^8.0.95",
     "@exodus/assets-base": "^8.1.10",
-    "@exodus/assets-feature": "^5.8.2",
-    "@exodus/available-assets": "^8.4.0",
+    "@exodus/assets-feature": "^5.11.3",
+    "@exodus/available-assets": "^8.5.0",
     "@exodus/bitcoin-plugin": "^1.4.2",
-    "@exodus/blockchain-metadata": "^15.3.5",
-    "@exodus/connected-origins": "^3.3.4",
-    "@exodus/dependency-injection": "^2.3.2",
-    "@exodus/dependency-preprocessors": "^6.0.2",
-    "@exodus/fiat-ramp": "^10.9.2",
-    "@exodus/nfts": "^9.3.3",
-    "@exodus/orders": "^4.10.2",
-    "@exodus/personal-notes": "^3.6.2",
-    "@exodus/redux-dependency-injection": "^3.2.3",
-    "@exodus/storage-memory": "^2.1.1",
-    "@exodus/wallet-accounts": "^16.8.2",
+    "@exodus/blockchain-metadata": "^15.5.0",
+    "@exodus/connected-origins": "^3.4.0",
+    "@exodus/dependency-injection": "^3.0.0",
+    "@exodus/dependency-preprocessors": "^6.0.5",
+    "@exodus/fiat-ramp": "^10.12.1",
+    "@exodus/nfts": "^9.3.7",
+    "@exodus/orders": "^4.11.3",
+    "@exodus/personal-notes": "^3.6.3",
+    "@exodus/redux-dependency-injection": "^4.0.3",
+    "@exodus/storage-memory": "^2.2.0",
+    "@exodus/wallet-accounts": "^16.10.2",
     "@types/minimalistic-assert": "^1.0.1",
     "redux": "^4.2.1"
   },
-  "gitHead": "3995391eb48639b2d60ced5224a6a8f4902a2466"
+  "gitHead": "258c9637436b53f8bb3e77836e2e3505c81a6969"
 }

package/redux/utils/activity-formatters/format-swap-activity.js

@@ -43,7 +43,7 @@ const getSwapSharedProps = ({
     ...getSharedProps({
       txId,
       date,
-      id: `swap.${assetName}.${txId}`,
+      id: `swap.${assetName}.${order?.id || txId}`,
       assetName,
       type: getOrderType({ tx, order }),
       pending,