@sodax/sdk 0.0.1-rc.2 → 0.0.1-rc.20

package/README.md

@@ -2,13 +2,38 @@
 
 The Sodax SDK provides a comprehensive interface for interacting with the Sodax protocol, enabling cross-chain swaps and money market operations.
 
-## Installation
+## Features
+
+### Swaps (Solver / Intents) [📖](./docs/SOLVER.md)
+  - EVM (Arbitrum, Avalanche, Base, BSC, Optimism, Polygon, Sonic) ✅
+  - Sui ✅
+  - Stellar ✅
+  - ICON ✅
+  - Solana ✅
+  - Injective ✅
+
+### Lend and Borrow (Money Market) [📖](./docs/MONEY_MARKET.md)
+  - EVM (Arbitrum, Avalanche, Base, BSC, Optimism, Polygon, Sonic) ✅
+  - Sui ✅
+  - Stellar ✅
+  - ICON ✅
+  - Solana ✅
+  - Injective ✅
+
+### Migration [📖](./docs/MIGRATION.md)
 
-### NPM
+## Installation
+ 
+```bash
+# Using npm
+npm install @sodax/sdk
 
-Installing through npm:
+# Using yarn
+yarn add @sodax/sdk
 
-`npm i --save @sodax/sdk`
+# Using pnpm
+pnpm add @sodax/sdk
+```
 
 ### Local Installation
 
@@ -36,8 +61,8 @@ How to setup local development
 ## Intent Solver Endpoints
 
 Current Intent Solver API endpoints:
-- **Production (mainnet)**: "TODO"
-- **Staging** (mainnet): "https://staging-new-world.iconblockchain.xyz"
+- **Production (mainnet)**: "https://sodax-solver-staging.iconblockchain.xyz"
+- **Staging** (mainnet): "https://sodax-solver-staging.iconblockchain.xyz"
 
 **Note** Staging endpoint contains features to be potentially released and is subject to frequent change!
 
@@ -109,7 +134,7 @@ const partnerFeeAmount = {
 // example of custom solver config
 const customSolverConfig = {
   intentsContract: '0x6382D6ccD780758C5e8A6123c33ee8F4472F96ef',
-  solverApiEndpoint: 'https://staging-new-world.iconblockchain.xyz',
+  solverApiEndpoint: 'https://sodax-solver-staging.iconblockchain.xyz',
   partnerFee: partnerFeePercentage, // or partnerFeeAmount
 } satisfies SolverConfigParams;
 
@@ -149,6 +174,8 @@ SDK includes predefined configurations of supported chains, tokens and other rel
 
 **NOTE** you should generally only use `spokeChains` configuration to retrieve all supported chains and then invoke per spoke chain based configurations. If you are using hub configurations you should know what you are doing.
 
+Please refer to [SDK constants.ts](https://github.com/icon-project/sodax-frontend/blob/main/packages/sdk/src/constants.ts) for more.
+
 ```typescript
 import {
   getHubChainConfig,
@@ -190,24 +217,116 @@ const supportedMoneyMarketTokens: readonly Token[] = getSupportedMoneyMarketToke
 
 Sodax SDK does not force the usage of a specific wallet or library, but requires client to provide implementation of `IWalletProvider` interfaces (e.g. for EVM chains `IEvmWalletProvider` has to be implemented).
 
-As part of Sodax suite, xWagmi SDK is also going to be provided as one example wallet provider implementation. You are free to choose between using our xWagmi SDK or implementing your own wallet connectivity for each chain.
+As part of Sodax suite, Wallet SDK is also going to be provided as one example wallet provider implementation. You are free to choose between using our Wallet SDK or implementing your own wallet connectivity for each chain.
+
+- Supported Wallet Provider Interface (`IWalletProvider`)
+  - `IEvmWalletProvider`: EVM (Arbitrum, Avalanche, Base, BSC, Optimism, Polygon) ✅
+  - `ISuiWalletProvider`: Sui ✅
+  - `IIconWalletProvider`: ICON ✅
+  - `IStellarWalletProvider`: Stellar ✅
+  - `ISolanaWalletProvider`: Solana ✅
+  - `IInjectiveWalletProvider`: Injective ✅
 
 ### Initialising Spoke Provider
 
-Spoke provider is a main instance used to interact with Sodax features because it contains all the relevant information we need to successfully execute features. You should generally establish SpokeProvider instances for each chain user connects wallet to.
+Spoke provider is a main instance used to interact with Sodax features because it contains all the relevant information we need to successfully execute features. You should generally establish SpokeProvider instances for each chain (e.g. evm, sui, etc..) user connects wallet to.
+
+Spoke is simply a chain you are connecting to and SpokeProvider is a container of relevant wallet provider and chain configuration.
+
+**IMPORTANT**: Sonic Spoke Provider must be instantiated as `SonicSpokeProvider` instance even though it is of `EVM` chain type. This is due to the fact that Sonic chain is a hub chain of Sodax and needs special handling under the hood.
 
 EVM Provider example:
 
 ```typescript
 import { EvmProvider, EvmHubProvider, EvmSpokeProvider, AVALANCHE_MAINNET_CHAIN_ID, SONIC_MAINNET_CHAIN_ID } from "@sodax/sdk"
 
-const evmWalletProvider: IEvmWalletProvider = // injected by xWagmi SDK or your own implementation
+const evmWalletProvider: IEvmWalletProvider = // injected by Wallet SDK or your own implementation
 
 // spoke provider represents connection to a specific chain, should be instantiated for each supported chain when user connects wallet
 const bscSpokeProvider: EvmSpokeProvider = new EvmSpokeProvider(
   evmWalletProvider, // user connected wallet
-  spokeChainConfig[BSC_MAINNET_CHAIN_ID] as EvmSpokeChainConfig, // connected chain config
+  spokeChainConfig[BSC_MAINNET_CHAIN_ID], // connected chain config
+);
+```
+
+### Estimate Gas for Raw Transactions
+
+The `estimateGas` function allows you to estimate the gas cost for raw transactions before executing them. This is particularly useful for all Sodax operations (swaps, money market operations, approvals) to provide users with accurate gas estimates.
+
+The function is available on all service classes:
+- `SolverService.estimateGas()` - for solver/intent operations (reachable through `sodax.solver`)
+- `MoneyMarketService.estimateGas()` - for money market operations (reachable through `sodax.moneyMarket`)
+- `SpokeService.estimateGas()` - for general spoke chain operations
+
+```typescript
+import { 
+  SolverService, 
+  MoneyMarketService, 
+  SpokeService,
+  MoneyMarketSupplyParams 
+} from "@sodax/sdk";
+
+// Example: Estimate gas for a solver swap transaction
+const createIntentResult = await sodax.solver.createIntent(
+  createIntentParams,
+  bscSpokeProvider,
+  partnerFeeAmount,
+  true, // true = get raw transaction
+);
+
+if (createIntentResult.ok) {
+  const [rawTx, intent] = createIntentResult.value;
+  
+  // Estimate gas for the raw transaction
+  const gasEstimate = await SolverService.estimateGas(rawTx, bscSpokeProvider);
+  
+  if (gasEstimate.ok) {
+    console.log('Estimated gas for swap:', gasEstimate.value);
+  } else {
+    console.error('Failed to estimate gas for swap:', gasEstimate.error);
+  }
+}
+
+// Example: Estimate gas for a money market supply transaction
+const supplyResult = await sodax.moneyMarket.createSupplyIntent(
+  supplyParams,
+  bscSpokeProvider,
+  true, // true = get raw transaction
 );
+
+if (supplyResult.ok) {
+  const rawTx = supplyResult.value;
+  
+  // Estimate gas for the raw transaction
+  const gasEstimate = await MoneyMarketService.estimateGas(rawTx, bscSpokeProvider);
+  
+  if (gasEstimate.ok) {
+    console.log('Estimated gas for supply:', gasEstimate.value);
+  } else {
+    console.error('Failed to estimate gas for supply:', gasEstimate.error);
+  }
+}
+
+// Example: Estimate gas for an approval transaction
+const approveResult = await sodax.solver.approve(
+  tokenAddress,
+  amount,
+  bscSpokeProvider,
+  true // true = get raw transaction
+);
+
+if (approveResult.ok) {
+  const rawTx = approveResult.value;
+  
+  // Estimate gas for the approval transaction
+  const gasEstimate = await SpokeService.estimateGas(rawTx, bscSpokeProvider);
+  
+  if (gasEstimate.ok) {
+    console.log('Estimated gas for approval:', gasEstimate.value);
+  } else {
+    console.error('Failed to estimate gas for approval:', gasEstimate.error);
+  }
+}
 ```
 
 ### Accessing Sodax Features
@@ -220,3 +339,39 @@ Sodax feature set currently contain:
 
 Intent relay is internally used to relay transaction information from one chain to another.
 Sodax SDK abstracts the heavy lifting of using the relay, but you can find documentation for Intent Relay API in [INTENT_RELAY_API.md](./docs/INTENT_RELAY_API.md) in case you want to explore it.
+
+
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
+
+## Development
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build the package
+pnpm build
+
+# Run in development mode
+pnpm dev
+
+# Run type checking
+pnpm checkTs
+
+# Format code
+pnpm pretty
+
+# Lint code
+pnpm lint
+```
+
+## License
+
+[MIT](LICENSE)
+
+## Support
+
+- [GitHub Issues](https://github.com/icon-project/sodax-frontend/issues)
+- [Discord Community](https://discord.gg/xM2Nh4S6vN)