@sky-mavis/ronin-dex 0.0.1

package/README.md

@@ -0,0 +1,53 @@
+# ronin-dex
+
+Multi-chain swap integration.
+
+## Installation
+
+```bash
+npm install ronin-dex
+```
+
+## Features
+
+- Multi-protocol support (KyberSwap, Relay, Li.fi)
+- Cross-chain trading (EVM + Solana)
+- Quote aggregation and optimization
+- Transaction building and execution
+- Event-driven architecture for trade lifecycle
+- Type-safe contract interactions
+- Gas estimation and fee management
+
+## Usage
+
+```typescript
+import DexFactory from 'ronin-dex';
+import type { CoreDexDependencies } from 'ronin-dex';
+
+// Initialize with your provider manager and account handlers
+const dependencies: CoreDexDependencies = {
+  apiUrl: 'https://api.example.com',
+  providerManager: yourProviderManager,
+  getAccounts: async (address) => { /* ... */ },
+  getSignerForAddress: async (address) => { /* ... */ },
+};
+
+const dex = new DexFactory(new CoreDex(dependencies));
+
+// Get quotes
+const quotes = await dex.getQuotes({
+  currencyIn,
+  currencyOut,
+  amount: '1000000000000000000',
+  direction: 'exactIn',
+  account: '0x...',
+  slippageToleranceBps: new Percent(50, 10000), // 0.5%
+});
+
+// Execute trade
+const txResponse = await dex.handle(quotes[0]);
+```
+
+## License
+
+ISC