@sodax/sdk 1.3.0-beta → 1.3.1-beta-rc2

package/README.md

@@ -1,62 +1,6 @@
-# Sodax SDK
-
-The Sodax SDK provides a comprehensive interface for interacting with the Sodax protocol, enabling cross-chain swaps, money market, cross-chain bridging, migration and staking SODA token.
-
-## Table of Contents
-
-### Features
-
-- [Swaps (Solver / Intents)](./docs/SWAPS.md) - Cross-chain intent-based swaps
-  - EVM (Arbitrum, Avalanche, Base, BSC, Optimism, Polygon, Sonic, HyperEVM, Lightlink, Ethereum, Redbelly, Kaia) ✅
-  - Sui ✅
-  - Stellar ✅
-  - ICON ✅
-  - Solana ✅
-  - Injective ✅
-- [Money Market](./docs/MONEY_MARKET.md) - Cross-chain lending and borrowing
-  - EVM (Arbitrum, Avalanche, Base, BSC, Optimism, Polygon, Sonic, HyperEVM, Lightlink, Ethereum, Redbelly, Kaia) ✅
-  - Sui ✅
-  - Stellar ✅
-  - ICON ✅
-  - Solana ✅
-  - Injective ✅
-- [Bridge](./docs/BRIDGE.md) - Cross-chain token bridging
-  - EVM (Arbitrum, Avalanche, Base, BSC, Optimism, Polygon, Sonic, HyperEVM, Lightlink, Ethereum, Redbelly, Kaia) ✅
-  - Sui ✅
-  - Stellar ✅
-  - ICON ✅
-  - Solana ✅
-  - Injective ✅
-- [Migration](./docs/MIGRATION.md) - Token migration (ICX, bnUSD, BALN)
-- [Staking](./docs/STAKING.md) - SODA token staking
-  - EVM (Arbitrum, Avalanche, Base, BSC, Optimism, Polygon, Sonic, HyperEVM, Lightlink, Ethereum, Redbelly, Kaia) ✅
-  - Sui ✅
-  - Stellar ✅
-  - ICON ✅
-  - Solana ✅
-  - Injective ✅
-
-### API Endpoints
-
-- [Intent Solver API Endpoints](./docs/SOLVER_API_ENDPOINTS.md) - Solver API endpoint documentation
-- [Relayer API Endpoints](./docs/RELAYER_API_ENDPOINTS.md) - Relayer API endpoint documentation
-
-### Guides
-
-- [Configure SDK](./docs/CONFIGURE_SDK.md) - Comprehensive guide for configuring the SDK
-- [Monetize SDK](./docs/MONETIZE_SDK.md) - Configure fees and monetize your SDK integration
-- [Make a Swap](./docs/HOW_TO_MAKE_A_SWAP.md) - Step by step guide on how to make a swap
-- [Create a Spoke Provider](./docs/HOW_TO_CREATE_A_SPOKE_PROVIDER.md) - Comprehensive guide for creating spoke providers
-- [Estimate Gas for Raw Transactions](./docs/ESTIMATE_GAS.md) - Estimate transaction gas for raw transaction payloads.
-- [Wallet Providers](./docs/WALLET_PROVIDERS.md) - Wallet provider interfaces and implementation guide
-- [Stellar Trustline Requirements](./docs/STELLAR_TRUSTLINE.md) - Guide for handling Stellar trustlines across all operations
-
-### Miscellaneous
-
-- [Intent Relay API](./docs/INTENT_RELAY_API.md) - Intent relay API internally used to relay cross-chain messages.
-- [Backend API](./docs/BACKEND_API.md) - Sodax Backend API offering access to Intent, Swap, and Money Market data.
-
-## Development
+# @sodax/sdk
+
+## Get started
 
 ### Installation
 
@@ -79,9 +23,7 @@ Package can be locally installed by following this steps:
 2. `cd` into repository folder location.
 3. Execute `pnpm install` command in your CLI to install dependencies.
 4. Execute `pnpm run build` to build the packages.
-5. In your app repository `package.json` file, define dependency named `"@sodax/sdk"` under `"dependencies"`.
-   Instead of version define absolute path to your SDK repository `"file:<sdk-repository-path>"` (e.g. `"file:/Users/dev/.../operation-liquidity-layer/packages/sdk"`).
-   Full example: `"@sodax/sdk": "file:/Users/dev/operation-liquidity-layer/sdk-new/packages/sdk"`.
+5. In your app repository `package.json` file, define dependency named `"@sodax/sdk"` under `"dependencies"`. Instead of version define absolute path to your SDK repository `"file:<sdk-repository-path>"` (e.g. `"file:/Users/dev/.../operation-liquidity-layer/packages/sdk"`). Full example: `"@sodax/sdk": "file:/Users/dev/operation-liquidity-layer/sdk-new/packages/sdk"`.
 
 ### Local Development
 
@@ -94,9 +36,59 @@ How to setup local development
    1. Do not forget to export TS files in same folder `index.ts`.
    2. Always import files using `.js` postfix.
 
+### Functional Modules inside the SDK
+
+<a href="https://docs.sodax.com/developers/packages/sdk/swaps" class="button secondary" data-icon="rotate">Swaps (Solver)</a> -  Cross-chain intent-based swaps
+
+* EVM (Arbitrum, Avalanche, Base, BSC, Optimism, Polygon, Sonic, HyperEVM, Lightlink) ✅
+* Sui ✅
+* Stellar ✅
+* ICON ✅
+* Solana ✅
+* Injective ✅
+
+<a href="https://docs.sodax.com/developers/packages/sdk/money_market" class="button secondary" data-icon="sack-dollar">Lend / Borrow (Money Market)</a>- Cross-chain lending and borrowing
+
+* EVM (Arbitrum, Avalanche, Base, BSC, Optimism, Polygon, Sonic, HyperEVM, Lightlink) ✅
+* Sui ✅
+* Stellar ✅
+* ICON ✅
+* Solana ✅
+* Injective ✅
+
+<a href="https://docs.sodax.com/developers/packages/sdk/bridge" class="button secondary" data-icon="bridge-suspension">Bridge</a>- Cross-chain token bridging
+
+* EVM (Arbitrum, Avalanche, Base, BSC, Optimism, Polygon, Sonic, HyperEVM, Lightlink) ✅
+* Sui ✅
+* Stellar ✅
+* ICON ✅
+* Solana ✅
+* Injective ✅
+
+<a href="https://docs.sodax.com/developers/packages/sdk/migration" class="button secondary" data-icon="truck">Migration</a>- Token migration (ICX, bnUSD, BALN)
+
+<a href="https://docs.sodax.com/developers/packages/sdk/staking" class="button secondary" data-icon="seedling">Staking</a>- SODA token staking
+
+* EVM (Arbitrum, Avalanche, Base, BSC, Optimism, Polygon, Sonic, HyperEVM, Lightlink) ✅
+* Sui ✅
+* Stellar ✅
+* ICON ✅
+* Solana ✅
+* Injective ✅
+
+### Tooling Modules inside the SDK
+
+<a href="https://docs.sodax.com/developers/packages/sdk/backend_api" class="button secondary" data-icon="plug">Backend API</a>- Solver API endpoint documentation
+
+<a href="https://docs.sodax.com/developers/packages/sdk/intent_relay_api" class="button secondary" data-icon="envelope">Intent Relay API</a>- Relayer API endpoint documentation
+
+***
+
 ## Contributing
 
-We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
+We welcome contributions! Please see our [Contributing Guide](https://github.com/icon-project/sodax-document/blob/main/developers/packages/sdk/CONTRIBUTING.md) for details.
+
+***
 
 ## Development Commands
 
@@ -120,11 +112,15 @@ pnpm pretty
 pnpm lint
 ```
 
+***
+
 ## License
 
-[MIT](LICENSE)
+* [MIT](https://github.com/icon-project/sodax-document/blob/main/developers/packages/sdk/LICENSE/README.md)
+
+***
 
 ## Support
 
-- [GitHub Issues](https://github.com/icon-project/sodax-frontend/issues)
-- [Discord Community](https://discord.gg/xM2Nh4S6vN)
+* [GitHub Issues](https://github.com/icon-project/sodax-frontend/issues)
+* [Discord Community](https://discord.gg/xM2Nh4S6vN)