@dynamic-labs-sdk/react-hooks 1.25.0 → 1.27.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. package/dist/core.cjs +1 -1
  2. package/dist/core.esm.js +1 -1
  3. package/dist/exports/index.d.ts +7 -0
  4. package/dist/exports/index.d.ts.map +1 -1
  5. package/dist/hooks/wrappers/functions/useCreateBusinessAccount/useCreateBusinessAccount.d.ts +2 -0
  6. package/dist/hooks/wrappers/functions/useCreateBusinessAccount/useCreateBusinessAccount.d.ts.map +1 -1
  7. package/dist/hooks/wrappers/functions/useCreateCoinbaseExchangeTransfer/index.d.ts +2 -0
  8. package/dist/hooks/wrappers/functions/useCreateCoinbaseExchangeTransfer/index.d.ts.map +1 -0
  9. package/dist/hooks/wrappers/functions/useCreateCoinbaseExchangeTransfer/useCreateCoinbaseExchangeTransfer.d.ts +37 -0
  10. package/dist/hooks/wrappers/functions/useCreateCoinbaseExchangeTransfer/useCreateCoinbaseExchangeTransfer.d.ts.map +1 -0
  11. package/dist/hooks/wrappers/functions/useCreateWaasOfflineRecoveryShares/index.d.ts +2 -0
  12. package/dist/hooks/wrappers/functions/useCreateWaasOfflineRecoveryShares/index.d.ts.map +1 -0
  13. package/dist/hooks/wrappers/functions/useCreateWaasOfflineRecoveryShares/useCreateWaasOfflineRecoveryShares.d.ts +48 -0
  14. package/dist/hooks/wrappers/functions/useCreateWaasOfflineRecoveryShares/useCreateWaasOfflineRecoveryShares.d.ts.map +1 -0
  15. package/dist/hooks/wrappers/functions/useGetCoinbaseAccounts/index.d.ts +2 -0
  16. package/dist/hooks/wrappers/functions/useGetCoinbaseAccounts/index.d.ts.map +1 -0
  17. package/dist/hooks/wrappers/functions/useGetCoinbaseAccounts/useGetCoinbaseAccounts.d.ts +41 -0
  18. package/dist/hooks/wrappers/functions/useGetCoinbaseAccounts/useGetCoinbaseAccounts.d.ts.map +1 -0
  19. package/dist/hooks/wrappers/functions/useGetYieldDetails/index.d.ts +2 -0
  20. package/dist/hooks/wrappers/functions/useGetYieldDetails/index.d.ts.map +1 -0
  21. package/dist/hooks/wrappers/functions/useGetYieldDetails/useGetYieldDetails.d.ts +36 -0
  22. package/dist/hooks/wrappers/functions/useGetYieldDetails/useGetYieldDetails.d.ts.map +1 -0
  23. package/dist/hooks/wrappers/functions/useGetYieldPosition/index.d.ts +2 -0
  24. package/dist/hooks/wrappers/functions/useGetYieldPosition/index.d.ts.map +1 -0
  25. package/dist/hooks/wrappers/functions/useGetYieldPosition/useGetYieldPosition.d.ts +47 -0
  26. package/dist/hooks/wrappers/functions/useGetYieldPosition/useGetYieldPosition.d.ts.map +1 -0
  27. package/dist/hooks/wrappers/functions/useGetYieldRewards/index.d.ts +2 -0
  28. package/dist/hooks/wrappers/functions/useGetYieldRewards/index.d.ts.map +1 -0
  29. package/dist/hooks/wrappers/functions/useGetYieldRewards/useGetYieldRewards.d.ts +47 -0
  30. package/dist/hooks/wrappers/functions/useGetYieldRewards/useGetYieldRewards.d.ts.map +1 -0
  31. package/dist/hooks/wrappers/functions/useListBusinessAccounts/useListBusinessAccounts.d.ts +8 -1
  32. package/dist/hooks/wrappers/functions/useListBusinessAccounts/useListBusinessAccounts.d.ts.map +1 -1
  33. package/dist/hooks/wrappers/functions/useListYieldVaults/index.d.ts +2 -0
  34. package/dist/hooks/wrappers/functions/useListYieldVaults/index.d.ts.map +1 -0
  35. package/dist/hooks/wrappers/functions/useListYieldVaults/useListYieldVaults.d.ts +35 -0
  36. package/dist/hooks/wrappers/functions/useListYieldVaults/useListYieldVaults.d.ts.map +1 -0
  37. package/dist/index.cjs +180 -4
  38. package/dist/index.cjs.map +1 -1
  39. package/dist/index.esm.js +176 -7
  40. package/dist/index.esm.js.map +1 -1
  41. package/dist/tsconfig.lib.tsbuildinfo +1 -1
  42. package/dist/{useBaseState-DK4rlAOO.cjs → useBaseState-C-7W_9Bl.cjs} +2 -2
  43. package/dist/{useBaseState-DK4rlAOO.cjs.map → useBaseState-C-7W_9Bl.cjs.map} +1 -1
  44. package/dist/{useBaseState-DcRIixKH.esm.js → useBaseState-CA8Djp4O.esm.js} +2 -2
  45. package/dist/{useBaseState-DcRIixKH.esm.js.map → useBaseState-CA8Djp4O.esm.js.map} +1 -1
  46. package/package.json +4 -4
package/dist/index.cjs CHANGED
@@ -1,4 +1,4 @@
1
- const require_useBaseState = require('./useBaseState-DK4rlAOO.cjs');
1
+ const require_useBaseState = require('./useBaseState-C-7W_9Bl.cjs');
2
2
  let _dynamic_labs_sdk_assert_package_version = require("@dynamic-labs-sdk/assert-package-version");
3
3
  let _dynamic_labs_sdk_client = require("@dynamic-labs-sdk/client");
4
4
  let _tanstack_react_query = require("@tanstack/react-query");
@@ -1148,6 +1148,50 @@ const useGetKrakenWhitelistedAddresses = ({ queryParams } = {}) => require_useBa
1148
1148
  queryParams
1149
1149
  });
1150
1150
 
1151
+ //#endregion
1152
+ //#region src/hooks/wrappers/functions/useGetCoinbaseAccounts/useGetCoinbaseAccounts.ts
1153
+ /**
1154
+ * Wraps `getCoinbaseAccounts` from `@dynamic-labs-sdk/client`. Returns the authenticated user's
1155
+ * Coinbase accounts (with balances), optionally filtered by chain/network.
1156
+ *
1157
+ * Automatically refetches when a different user becomes current (login or
1158
+ * account switch), so consumers don't have to pair it with a manual
1159
+ * `userChanged` listener.
1160
+ *
1161
+ * @example
1162
+ * ```tsx
1163
+ * const { data: accounts, isLoading } = useGetCoinbaseAccounts();
1164
+ * ```
1165
+ * @returns A react-query result whose `data` is the array of Coinbase accounts resolved by `getCoinbaseAccounts`.
1166
+ * @see getCoinbaseAccounts
1167
+ * @see UseGetCoinbaseAccountsParams
1168
+ */
1169
+ const useGetCoinbaseAccounts = ({ queryParams, ...args } = {}) => require_useBaseState.useBaseQuery({
1170
+ middlewares: [invalidateOnUserSwitch()],
1171
+ queryFn: (client) => (0, _dynamic_labs_sdk_client.getCoinbaseAccounts)(args, client),
1172
+ queryKey: ["useGetCoinbaseAccounts", args],
1173
+ queryParams
1174
+ });
1175
+
1176
+ //#endregion
1177
+ //#region src/hooks/wrappers/functions/useCreateCoinbaseExchangeTransfer/useCreateCoinbaseExchangeTransfer.ts
1178
+ /**
1179
+ * Wraps `createCoinbaseExchangeTransfer` from `@dynamic-labs-sdk/client`. Call `mutate({ accountId, ... })` to send crypto from a Coinbase account (see `useGetCoinbaseAccounts`) to an address; the resolved `data` is the created transfer.
1180
+ *
1181
+ * @example
1182
+ * ```tsx
1183
+ * const { mutate: transfer } = useCreateCoinbaseExchangeTransfer();
1184
+ * transfer({ accountId, amount: 0.5, currency: 'USDC', to: '0x...' });
1185
+ * ```
1186
+ * @returns A react-query mutation result whose `data` is the transfer resolved by `createCoinbaseExchangeTransfer`.
1187
+ * @see createCoinbaseExchangeTransfer
1188
+ * @see UseCreateCoinbaseExchangeTransferParams
1189
+ */
1190
+ const useCreateCoinbaseExchangeTransfer = ({ mutateParams } = {}) => require_useBaseState.useBaseMutation({
1191
+ mutateParams,
1192
+ mutationFn: ({ client, variables }) => (0, _dynamic_labs_sdk_client.createCoinbaseExchangeTransfer)(variables, client)
1193
+ });
1194
+
1151
1195
  //#endregion
1152
1196
  //#region src/hooks/wrappers/functions/useListBusinessAccounts/useListBusinessAccounts.ts
1153
1197
  /**
@@ -1157,15 +1201,17 @@ const useGetKrakenWhitelistedAddresses = ({ queryParams } = {}) => require_useBa
1157
1201
  * @example
1158
1202
  * ```tsx
1159
1203
  * const { data: businessAccounts, isLoading } = useListBusinessAccounts();
1204
+ * // or filter by a developer-supplied externalRef:
1205
+ * const { data } = useListBusinessAccounts({ externalRefs: ['acme-org-42'] });
1160
1206
  * ```
1161
1207
  *
1162
1208
  * @returns A react-query result whose `data` is the paginated list resolved by `listBusinessAccounts`.
1163
1209
  * @see listBusinessAccounts
1164
1210
  * @see UseListBusinessAccountsParams
1165
1211
  */
1166
- const useListBusinessAccounts = ({ queryParams } = {}) => require_useBaseState.useBaseQuery({
1167
- queryFn: (client) => (0, _dynamic_labs_sdk_client_waas.listBusinessAccounts)(client),
1168
- queryKey: ["useListBusinessAccounts"],
1212
+ const useListBusinessAccounts = ({ externalRefs, queryParams } = {}) => require_useBaseState.useBaseQuery({
1213
+ queryFn: (client) => (0, _dynamic_labs_sdk_client_waas.listBusinessAccounts)({ externalRefs }, client),
1214
+ queryKey: ["useListBusinessAccounts", externalRefs],
1169
1215
  queryParams
1170
1216
  });
1171
1217
 
@@ -2464,6 +2510,29 @@ const useBackupWaasKeySharesToGoogleDrive = ({ mutateParams } = {}) => require_u
2464
2510
  mutationFn: ({ client, variables }) => (0, _dynamic_labs_sdk_client_waas.backupWaasKeySharesToGoogleDrive)(variables, client)
2465
2511
  });
2466
2512
 
2513
+ //#endregion
2514
+ //#region src/hooks/wrappers/functions/useCreateWaasOfflineRecoveryShares/useCreateWaasOfflineRecoveryShares.ts
2515
+ /**
2516
+ * Wraps `createWaasOfflineRecoveryShares` from `@dynamic-labs-sdk/client/waas`. Call `mutate(variables)` to
2517
+ * mint a recovery share set for an embedded wallet available for recovery outside of Dynamic.
2518
+ *
2519
+ * @example
2520
+ * ```tsx
2521
+ * const { mutate, isPending } = useCreateWaasOfflineRecoveryShares();
2522
+ * <button onClick={() => mutate(variables)} disabled={isPending}>
2523
+ * Continue
2524
+ * </button>
2525
+ * ```
2526
+ *
2527
+ * @returns A react-query mutation whose `mutate`/`mutateAsync` calls `createWaasOfflineRecoveryShares` and whose `data` is its resolved value.
2528
+ * @see createWaasOfflineRecoveryShares
2529
+ * @see UseCreateWaasOfflineRecoverySharesParams
2530
+ */
2531
+ const useCreateWaasOfflineRecoveryShares = ({ mutateParams } = {}) => require_useBaseState.useBaseMutation({
2532
+ mutateParams,
2533
+ mutationFn: ({ client, variables }) => (0, _dynamic_labs_sdk_client_waas.createWaasOfflineRecoveryShares)(variables, client)
2534
+ });
2535
+
2467
2536
  //#endregion
2468
2537
  //#region src/hooks/wrappers/functions/useCreateWaasWalletAccounts/useCreateWaasWalletAccounts.ts
2469
2538
  /**
@@ -2768,6 +2837,106 @@ const useUpdateWaasPassword = ({ mutateParams } = {}) => require_useBaseState.us
2768
2837
  mutationFn: ({ client, variables }) => (0, _dynamic_labs_sdk_client_waas.updateWaasPassword)(variables, client)
2769
2838
  });
2770
2839
 
2840
+ //#endregion
2841
+ //#region src/hooks/wrappers/functions/useGetYieldDetails/useGetYieldDetails.ts
2842
+ /**
2843
+ * Wraps `getYieldDetails` from `@dynamic-labs-sdk/client`. Returns full details for one yield vault.
2844
+ *
2845
+ * @example
2846
+ * ```tsx
2847
+ * const { data: details, isLoading } = useGetYieldDetails({ vaultId });
2848
+ * ```
2849
+ *
2850
+ * @returns A react-query result whose `data` is the vault's full details.
2851
+ * @see getYieldDetails
2852
+ * @see UseGetYieldDetailsParams
2853
+ */
2854
+ const useGetYieldDetails = ({ queryParams, ...args }) => require_useBaseState.useBaseQuery({
2855
+ queryFn: (client) => (0, _dynamic_labs_sdk_client.getYieldDetails)(args, client),
2856
+ queryKey: ["useGetYieldDetails", args],
2857
+ queryParams
2858
+ });
2859
+
2860
+ //#endregion
2861
+ //#region src/hooks/wrappers/functions/useGetYieldPosition/useGetYieldPosition.ts
2862
+ /**
2863
+ * Wraps `getYieldPosition` from `@dynamic-labs-sdk/client`. Returns the
2864
+ * wallet account's share balance and asset value in a yield vault. The
2865
+ * hook stays disabled until `walletAccount` is defined.
2866
+ *
2867
+ * @example
2868
+ * ```tsx
2869
+ * const { data: position, isLoading } = useGetYieldPosition({ vaultId, walletAccount });
2870
+ * ```
2871
+ *
2872
+ * @returns A react-query result whose `data` is the wallet's share balance and asset value; it stays disabled until `walletAccount` is defined.
2873
+ * @see getYieldPosition
2874
+ * @see UseGetYieldPositionParams
2875
+ */
2876
+ const useGetYieldPosition = ({ vaultId, walletAccount, queryParams }) => require_useBaseState.useBaseQuery({
2877
+ enabled: walletAccount !== void 0,
2878
+ queryFn: (client) => (0, _dynamic_labs_sdk_client.getYieldPosition)({
2879
+ vaultId,
2880
+ walletAccount
2881
+ }, client),
2882
+ queryKey: [
2883
+ "useGetYieldPosition",
2884
+ vaultId,
2885
+ walletAccount?.id
2886
+ ],
2887
+ queryParams
2888
+ });
2889
+
2890
+ //#endregion
2891
+ //#region src/hooks/wrappers/functions/useGetYieldRewards/useGetYieldRewards.ts
2892
+ /**
2893
+ * Wraps `getYieldRewards` from `@dynamic-labs-sdk/client`. Returns the
2894
+ * wallet account's accrued rewards in a yield vault. The hook stays
2895
+ * disabled until `walletAccount` is defined.
2896
+ *
2897
+ * @example
2898
+ * ```tsx
2899
+ * const { data: rewards, isLoading } = useGetYieldRewards({ vaultId, walletAccount });
2900
+ * ```
2901
+ *
2902
+ * @returns A react-query result whose `data` is the wallet's accrued rewards; it stays disabled until `walletAccount` is defined.
2903
+ * @see getYieldRewards
2904
+ * @see UseGetYieldRewardsParams
2905
+ */
2906
+ const useGetYieldRewards = ({ vaultId, walletAccount, queryParams }) => require_useBaseState.useBaseQuery({
2907
+ enabled: walletAccount !== void 0,
2908
+ queryFn: (client) => (0, _dynamic_labs_sdk_client.getYieldRewards)({
2909
+ vaultId,
2910
+ walletAccount
2911
+ }, client),
2912
+ queryKey: [
2913
+ "useGetYieldRewards",
2914
+ vaultId,
2915
+ walletAccount?.id
2916
+ ],
2917
+ queryParams
2918
+ });
2919
+
2920
+ //#endregion
2921
+ //#region src/hooks/wrappers/functions/useListYieldVaults/useListYieldVaults.ts
2922
+ /**
2923
+ * Wraps `listYieldVaults` from `@dynamic-labs-sdk/client`. Returns the yield vaults available to the current environment.
2924
+ *
2925
+ * @example
2926
+ * ```tsx
2927
+ * const { data: vaults, isLoading } = useListYieldVaults();
2928
+ * ```
2929
+ *
2930
+ * @returns A react-query result whose `data` is the yield vaults accessible to this environment.
2931
+ * @see listYieldVaults
2932
+ * @see UseListYieldVaultsParams
2933
+ */
2934
+ const useListYieldVaults = ({ queryParams } = {}) => require_useBaseState.useBaseQuery({
2935
+ queryFn: (client) => (0, _dynamic_labs_sdk_client.listYieldVaults)(client),
2936
+ queryKey: ["useListYieldVaults"],
2937
+ queryParams
2938
+ });
2939
+
2771
2940
  //#endregion
2772
2941
  //#region src/hooks/wrappers/state/useInitStatus/useInitStatus.ts
2773
2942
  /**
@@ -2866,10 +3035,12 @@ exports.useConfirmTransaction = useConfirmTransaction;
2866
3035
  exports.useConnectAndVerifyWithWalletProvider = useConnectAndVerifyWithWalletProvider;
2867
3036
  exports.useConnectWithWalletProvider = useConnectWithWalletProvider;
2868
3037
  exports.useCreateBusinessAccount = useCreateBusinessAccount;
3038
+ exports.useCreateCoinbaseExchangeTransfer = useCreateCoinbaseExchangeTransfer;
2869
3039
  exports.useCreateCoinbaseOnrampOrder = useCreateCoinbaseOnrampOrder;
2870
3040
  exports.useCreateCryptoDotComPayment = useCreateCryptoDotComPayment;
2871
3041
  exports.useCreateKrakenExchangeTransfer = useCreateKrakenExchangeTransfer;
2872
3042
  exports.useCreateNewMfaRecoveryCodes = useCreateNewMfaRecoveryCodes;
3043
+ exports.useCreateWaasOfflineRecoveryShares = useCreateWaasOfflineRecoveryShares;
2873
3044
  exports.useCreateWaasWalletAccounts = useCreateWaasWalletAccounts;
2874
3045
  exports.useCreateWalletForBusinessAccount = useCreateWalletForBusinessAccount;
2875
3046
  exports.useDelegateWaasKeyShares = useDelegateWaasKeyShares;
@@ -2886,6 +3057,7 @@ exports.useGetActiveNetworkId = useGetActiveNetworkId;
2886
3057
  exports.useGetAvailableWalletProvidersData = useGetAvailableWalletProvidersData;
2887
3058
  exports.useGetBalanceForAddress = useGetBalanceForAddress;
2888
3059
  exports.useGetBusinessAccount = useGetBusinessAccount;
3060
+ exports.useGetCoinbaseAccounts = useGetCoinbaseAccounts;
2889
3061
  exports.useGetCoinbaseBuyUrl = useGetCoinbaseBuyUrl;
2890
3062
  exports.useGetConnectedAddresses = useGetConnectedAddresses;
2891
3063
  exports.useGetFlow = useGetFlow;
@@ -2913,6 +3085,9 @@ exports.useGetWalletConnectCatalogWalletByWalletProviderKey = useGetWalletConnec
2913
3085
  exports.useGetWalletOptionsCatalogue = useGetWalletOptionsCatalogue;
2914
3086
  exports.useGetWalletProviderDataByKey = useGetWalletProviderDataByKey;
2915
3087
  exports.useGetWalletRecoveryState = useGetWalletRecoveryState;
3088
+ exports.useGetYieldDetails = useGetYieldDetails;
3089
+ exports.useGetYieldPosition = useGetYieldPosition;
3090
+ exports.useGetYieldRewards = useGetYieldRewards;
2916
3091
  exports.useImportWaasPrivateKey = useImportWaasPrivateKey;
2917
3092
  exports.useInitStatus = useInitStatus;
2918
3093
  exports.useIsDeviceRegistrationRequired = useIsDeviceRegistrationRequired;
@@ -2921,6 +3096,7 @@ exports.useIsPendingRecoveryCodesAcknowledgment = useIsPendingRecoveryCodesAckno
2921
3096
  exports.useIsUserMissingMfaAuth = useIsUserMissingMfaAuth;
2922
3097
  exports.useIsUserOnboardingComplete = useIsUserOnboardingComplete;
2923
3098
  exports.useListBusinessAccounts = useListBusinessAccounts;
3099
+ exports.useListYieldVaults = useListYieldVaults;
2924
3100
  exports.useLogout = useLogout;
2925
3101
  exports.useMergeUserAccounts = useMergeUserAccounts;
2926
3102
  exports.useMigrateFromFireblocks = useMigrateFromFireblocks;