@sodax/dapp-kit 0.0.1-rc.29 → 0.0.1-rc.30

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 (137) hide show
  1. package/README.md +37 -37
  2. package/dist/index.d.mts +1425 -0
  3. package/dist/index.d.ts +1425 -5
  4. package/dist/index.js +364 -0
  5. package/dist/index.js.map +1 -1
  6. package/dist/index.mjs +347 -1
  7. package/dist/index.mjs.map +1 -1
  8. package/package.json +3 -3
  9. package/src/contexts/index.ts +1 -1
  10. package/src/hooks/bridge/useGetBridgeableAmount.ts +1 -1
  11. package/src/hooks/index.ts +1 -0
  12. package/src/hooks/shared/useDeriveUserWalletAddress.ts +1 -1
  13. package/src/hooks/staking/index.ts +19 -0
  14. package/src/hooks/staking/useCancelUnstake.ts +52 -0
  15. package/src/hooks/staking/useClaim.ts +46 -0
  16. package/src/hooks/staking/useConvertedAssets.ts +47 -0
  17. package/src/hooks/staking/useInstantUnstake.ts +50 -0
  18. package/src/hooks/staking/useInstantUnstakeAllowance.ts +59 -0
  19. package/src/hooks/staking/useInstantUnstakeApprove.ts +52 -0
  20. package/src/hooks/staking/useInstantUnstakeRatio.ts +54 -0
  21. package/src/hooks/staking/useStake.ts +47 -0
  22. package/src/hooks/staking/useStakeAllowance.ts +57 -0
  23. package/src/hooks/staking/useStakeApprove.ts +50 -0
  24. package/src/hooks/staking/useStakeRatio.ts +53 -0
  25. package/src/hooks/staking/useStakingConfig.ts +40 -0
  26. package/src/hooks/staking/useStakingInfo.ts +50 -0
  27. package/src/hooks/staking/useUnstake.ts +54 -0
  28. package/src/hooks/staking/useUnstakeAllowance.ts +58 -0
  29. package/src/hooks/staking/useUnstakeApprove.ts +52 -0
  30. package/src/hooks/staking/useUnstakingInfo.ts +53 -0
  31. package/src/hooks/staking/useUnstakingInfoWithPenalty.ts +59 -0
  32. package/src/index.ts +0 -1
  33. package/src/providers/SodaxProvider.tsx +1 -1
  34. package/dist/contexts/index.d.ts +0 -9
  35. package/dist/contexts/index.d.ts.map +0 -1
  36. package/dist/core/index.d.ts +0 -3
  37. package/dist/core/index.d.ts.map +0 -1
  38. package/dist/hooks/backend/index.d.ts +0 -17
  39. package/dist/hooks/backend/index.d.ts.map +0 -1
  40. package/dist/hooks/backend/useBackendAllMoneyMarketAssets.d.ts +0 -37
  41. package/dist/hooks/backend/useBackendAllMoneyMarketAssets.d.ts.map +0 -1
  42. package/dist/hooks/backend/useBackendAllMoneyMarketBorrowers.d.ts +0 -45
  43. package/dist/hooks/backend/useBackendAllMoneyMarketBorrowers.d.ts.map +0 -1
  44. package/dist/hooks/backend/useBackendIntentByHash.d.ts +0 -36
  45. package/dist/hooks/backend/useBackendIntentByHash.d.ts.map +0 -1
  46. package/dist/hooks/backend/useBackendIntentByTxHash.d.ts +0 -35
  47. package/dist/hooks/backend/useBackendIntentByTxHash.d.ts.map +0 -1
  48. package/dist/hooks/backend/useBackendMoneyMarketAsset.d.ts +0 -38
  49. package/dist/hooks/backend/useBackendMoneyMarketAsset.d.ts.map +0 -1
  50. package/dist/hooks/backend/useBackendMoneyMarketAssetBorrowers.d.ts +0 -47
  51. package/dist/hooks/backend/useBackendMoneyMarketAssetBorrowers.d.ts.map +0 -1
  52. package/dist/hooks/backend/useBackendMoneyMarketAssetSuppliers.d.ts +0 -47
  53. package/dist/hooks/backend/useBackendMoneyMarketAssetSuppliers.d.ts.map +0 -1
  54. package/dist/hooks/backend/useBackendMoneyMarketPosition.d.ts +0 -37
  55. package/dist/hooks/backend/useBackendMoneyMarketPosition.d.ts.map +0 -1
  56. package/dist/hooks/backend/useBackendOrderbook.d.ts +0 -46
  57. package/dist/hooks/backend/useBackendOrderbook.d.ts.map +0 -1
  58. package/dist/hooks/bridge/index.d.ts +0 -6
  59. package/dist/hooks/bridge/index.d.ts.map +0 -1
  60. package/dist/hooks/bridge/useBridge.d.ts +0 -33
  61. package/dist/hooks/bridge/useBridge.d.ts.map +0 -1
  62. package/dist/hooks/bridge/useBridgeAllowance.d.ts +0 -23
  63. package/dist/hooks/bridge/useBridgeAllowance.d.ts.map +0 -1
  64. package/dist/hooks/bridge/useBridgeApprove.d.ts +0 -29
  65. package/dist/hooks/bridge/useBridgeApprove.d.ts.map +0 -1
  66. package/dist/hooks/bridge/useGetBridgeableAmount.d.ts +0 -26
  67. package/dist/hooks/bridge/useGetBridgeableAmount.d.ts.map +0 -1
  68. package/dist/hooks/bridge/useGetBridgeableTokens.d.ts +0 -37
  69. package/dist/hooks/bridge/useGetBridgeableTokens.d.ts.map +0 -1
  70. package/dist/hooks/index.d.ts +0 -7
  71. package/dist/hooks/index.d.ts.map +0 -1
  72. package/dist/hooks/mm/index.d.ts +0 -9
  73. package/dist/hooks/mm/index.d.ts.map +0 -1
  74. package/dist/hooks/mm/useBorrow.d.ts +0 -35
  75. package/dist/hooks/mm/useBorrow.d.ts.map +0 -1
  76. package/dist/hooks/mm/useMMAllowance.d.ts +0 -26
  77. package/dist/hooks/mm/useMMAllowance.d.ts.map +0 -1
  78. package/dist/hooks/mm/useMMApprove.d.ts +0 -27
  79. package/dist/hooks/mm/useMMApprove.d.ts.map +0 -1
  80. package/dist/hooks/mm/useRepay.d.ts +0 -35
  81. package/dist/hooks/mm/useRepay.d.ts.map +0 -1
  82. package/dist/hooks/mm/useReservesData.d.ts +0 -19
  83. package/dist/hooks/mm/useReservesData.d.ts.map +0 -1
  84. package/dist/hooks/mm/useReservesHumanized.d.ts +0 -21
  85. package/dist/hooks/mm/useReservesHumanized.d.ts.map +0 -1
  86. package/dist/hooks/mm/useReservesList.d.ts +0 -18
  87. package/dist/hooks/mm/useReservesList.d.ts.map +0 -1
  88. package/dist/hooks/mm/useReservesUsdFormat.d.ts +0 -23
  89. package/dist/hooks/mm/useReservesUsdFormat.d.ts.map +0 -1
  90. package/dist/hooks/mm/useSupply.d.ts +0 -34
  91. package/dist/hooks/mm/useSupply.d.ts.map +0 -1
  92. package/dist/hooks/mm/useUserFormattedSummary.d.ts +0 -21
  93. package/dist/hooks/mm/useUserFormattedSummary.d.ts.map +0 -1
  94. package/dist/hooks/mm/useUserReservesData.d.ts +0 -20
  95. package/dist/hooks/mm/useUserReservesData.d.ts.map +0 -1
  96. package/dist/hooks/mm/useWithdraw.d.ts +0 -33
  97. package/dist/hooks/mm/useWithdraw.d.ts.map +0 -1
  98. package/dist/hooks/provider/index.d.ts +0 -3
  99. package/dist/hooks/provider/index.d.ts.map +0 -1
  100. package/dist/hooks/provider/useHubProvider.d.ts +0 -3
  101. package/dist/hooks/provider/useHubProvider.d.ts.map +0 -1
  102. package/dist/hooks/provider/useSpokeProvider.d.ts +0 -18
  103. package/dist/hooks/provider/useSpokeProvider.d.ts.map +0 -1
  104. package/dist/hooks/shared/index.d.ts +0 -6
  105. package/dist/hooks/shared/index.d.ts.map +0 -1
  106. package/dist/hooks/shared/useDeriveUserWalletAddress.d.ts +0 -24
  107. package/dist/hooks/shared/useDeriveUserWalletAddress.d.ts.map +0 -1
  108. package/dist/hooks/shared/useEstimateGas.d.ts +0 -4
  109. package/dist/hooks/shared/useEstimateGas.d.ts.map +0 -1
  110. package/dist/hooks/shared/useRequestTrustline.d.ts +0 -44
  111. package/dist/hooks/shared/useRequestTrustline.d.ts.map +0 -1
  112. package/dist/hooks/shared/useSodaxContext.d.ts +0 -8
  113. package/dist/hooks/shared/useSodaxContext.d.ts.map +0 -1
  114. package/dist/hooks/shared/useStellarTrustlineCheck.d.ts +0 -40
  115. package/dist/hooks/shared/useStellarTrustlineCheck.d.ts.map +0 -1
  116. package/dist/hooks/swap/index.d.ts +0 -7
  117. package/dist/hooks/swap/index.d.ts.map +0 -1
  118. package/dist/hooks/swap/useCancelSwap.d.ts +0 -29
  119. package/dist/hooks/swap/useCancelSwap.d.ts.map +0 -1
  120. package/dist/hooks/swap/useQuote.d.ts +0 -39
  121. package/dist/hooks/swap/useQuote.d.ts.map +0 -1
  122. package/dist/hooks/swap/useStatus.d.ts +0 -31
  123. package/dist/hooks/swap/useStatus.d.ts.map +0 -1
  124. package/dist/hooks/swap/useSwap.d.ts +0 -29
  125. package/dist/hooks/swap/useSwap.d.ts.map +0 -1
  126. package/dist/hooks/swap/useSwapAllowance.d.ts +0 -23
  127. package/dist/hooks/swap/useSwapAllowance.d.ts.map +0 -1
  128. package/dist/hooks/swap/useSwapApprove.d.ts +0 -25
  129. package/dist/hooks/swap/useSwapApprove.d.ts.map +0 -1
  130. package/dist/index.d.ts.map +0 -1
  131. package/dist/providers/SodaxProvider.d.ts +0 -12
  132. package/dist/providers/SodaxProvider.d.ts.map +0 -1
  133. package/dist/providers/index.d.ts +0 -2
  134. package/dist/providers/index.d.ts.map +0 -1
  135. package/dist/types.d.ts +0 -17
  136. package/dist/types.d.ts.map +0 -1
  137. package/src/types.ts +0 -22
package/README.md CHANGED
@@ -44,6 +44,26 @@ dApp Kit is a collection of React components, hooks, and utilities designed to s
44
44
  - Check if Stellar trustline is established for an asset (`useStellarTrustlineCheck`)
45
45
  - Request creation of Stellar trustline line for an asset (`useRequestTrustline`)
46
46
 
47
+ - Staking
48
+ - Stake SODA tokens to receive xSODA shares (`useStake`)
49
+ - Unstake xSODA shares (`useUnstake`)
50
+ - Instant unstake xSODA shares with penalty (`useInstantUnstake`)
51
+ - Claim unstaked SODA tokens after unstaking period (`useClaim`)
52
+ - Cancel unstake request (`useCancelUnstake`)
53
+ - Check SODA token allowance for staking (`useStakeAllowance`)
54
+ - Approve SODA token spending for staking (`useStakeApprove`)
55
+ - Check xSODA token allowance for unstaking (`useUnstakeAllowance`)
56
+ - Approve xSODA token spending for unstaking (`useUnstakeApprove`)
57
+ - Check xSODA token allowance for instant unstaking (`useInstantUnstakeAllowance`)
58
+ - Approve xSODA token spending for instant unstaking (`useInstantUnstakeApprove`)
59
+ - Get comprehensive staking information (`useStakingInfo`)
60
+ - Get unstaking information with penalty details (`useUnstakingInfoWithPenalty`)
61
+ - Get unstaking information (`useUnstakingInfo`)
62
+ - Get staking configuration (`useStakingConfig`)
63
+ - Get stake ratio (SODA to xSODA conversion rate) (`useStakeRatio`)
64
+ - Get instant unstake ratio (xSODA to SODA conversion rate with penalty) (`useInstantUnstakeRatio`)
65
+ - Get converted assets amount for xSODA shares (`useConvertedAssets`)
66
+
47
67
  ## Installation
48
68
 
49
69
  ```bash
@@ -68,52 +88,32 @@ pnpm install @sodax/dapp-kit @tanstack/react-query @sodax/wallet-sdk-react
68
88
  import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
69
89
  import { SodaxWalletProvider } from '@sodax/wallet-sdk-react';
70
90
  import { SodaxProvider } from '@sodax/dapp-kit';
71
- import {
72
- ARBITRUM_MAINNET_CHAIN_ID,
73
- AVALANCHE_MAINNET_CHAIN_ID,
74
- BASE_MAINNET_CHAIN_ID,
75
- BSC_MAINNET_CHAIN_ID,
76
- OPTIMISM_MAINNET_CHAIN_ID,
77
- POLYGON_MAINNET_CHAIN_ID,
78
- SONIC_MAINNET_CHAIN_ID,
79
- HYPEREVM_MAINNET_CHAIN_ID,
80
- LIGHTLINK_MAINNET_CHAIN_ID,
81
- } from '@sodax/types';
91
+ import type { RpcConfig } from '@sodax/types';
82
92
 
83
93
  const queryClient = new QueryClient();
84
94
 
85
- const rpcConfig = {
86
- "solana": "private rpc url",
95
+ const rpcConfig: RpcConfig = {
96
+ // EVM chains
97
+ sonic: 'https://rpc.soniclabs.com',
98
+ '0xa86a.avax': 'https://api.avax.network/ext/bc/C/rpc',
99
+ '0xa4b1.arbitrum': 'https://arb1.arbitrum.io/rpc',
100
+ '0x2105.base': 'https://mainnet.base.org',
101
+ '0x38.bsc': 'https://bsc-dataseed1.binance.org',
102
+ '0xa.optimism': 'https://mainnet.optimism.io',
103
+ '0x89.polygon': 'https://polygon-rpc.com',
104
+
105
+ // Other chains
106
+ '0x1.icon': 'https://ctz.solidwallet.io/api/v3',
107
+ solana: 'https://solana-mainnet.g.alchemy.com/v2/your-api-key',
108
+ sui: 'https://fullnode.mainnet.sui.io',
109
+ 'injective-1': 'https://sentry.tm.injective.network:26657',
87
110
  };
88
111
 
89
112
  function App() {
90
113
  return (
91
114
  <SodaxProvider testnet={false} rpcConfig={rpcConfig}>
92
115
  <QueryClientProvider client={queryClient}>
93
- <SodaxWalletProvider
94
- config={{
95
- EVM: {
96
- // Add all the EVM chains you want to support
97
- chains: [
98
- ARBITRUM_MAINNET_CHAIN_ID,
99
- AVALANCHE_MAINNET_CHAIN_ID,
100
- BASE_MAINNET_CHAIN_ID,
101
- BSC_MAINNET_CHAIN_ID,
102
- OPTIMISM_MAINNET_CHAIN_ID,
103
- POLYGON_MAINNET_CHAIN_ID,
104
- SONIC_MAINNET_CHAIN_ID,
105
- HYPEREVM_MAINNET_CHAIN_ID,
106
- LIGHTLINK_MAINNET_CHAIN_ID,
107
- ],
108
- },
109
- SUI: {
110
- isMainnet: true,
111
- },
112
- SOLANA: {
113
- endpoint: 'https://solana-mainnet.g.alchemy.com/v2/your-api-key',
114
- },
115
- }}
116
- >
116
+ <SodaxWalletProvider rpcConfig={rpcConfig}>
117
117
  <YourApp />
118
118
  </SodaxWalletProvider>
119
119
  </QueryClientProvider>