@vulcx/sdk 0.2.1 → 0.2.2
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.
- package/README.md +3 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@ npm install @vulcx/sdk
|
|
|
11
11
|
Or via CDN:
|
|
12
12
|
|
|
13
13
|
```html
|
|
14
|
-
<script src="https://unpkg.com/@vulcx/sdk"></script>
|
|
14
|
+
<script src="https://unpkg.com/@vulcx/sdk/dist/index.umd.js"></script>
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
## Quick Start
|
|
@@ -21,14 +21,13 @@ import { VulcxSDK } from "@vulcx/sdk";
|
|
|
21
21
|
|
|
22
22
|
const vulcx = new VulcxSDK({
|
|
23
23
|
apiKey: "vulcx_your_api_key_here",
|
|
24
|
-
chain: "solana", // or "fogo"
|
|
25
24
|
});
|
|
26
25
|
|
|
27
26
|
// Get a quote
|
|
28
27
|
const quote = await vulcx.quote({
|
|
29
28
|
inputMint: "So11111111111111111111111111111111111111112",
|
|
30
|
-
outputMint: "
|
|
31
|
-
amount: "1000000000", // 1
|
|
29
|
+
outputMint: "uSd2czE61Evaf76RNbq4KPpXnkiL3irdzgLFUMe3NoG",
|
|
30
|
+
amount: "1000000000", // 1 FOGO (9 decimals)
|
|
32
31
|
swapMode: "ExactIn",
|
|
33
32
|
slippageBps: 50,
|
|
34
33
|
});
|
|
@@ -43,7 +42,6 @@ console.log(`Output: ${quote.amountOut}, Impact: ${quote.priceImpactPercent}`);
|
|
|
43
42
|
| Parameter | Type | Default | Description |
|
|
44
43
|
| ----------- | -------- | ----------------------------- | -------------------------- |
|
|
45
44
|
| `apiKey` | `string` | **required** | Your API key |
|
|
46
|
-
| `chain` | `string` | `"solana"` | `"solana"` or `"fogo"` |
|
|
47
45
|
| `baseUrl` | `string` | `"https://api.vulcx.xyz"` | API base URL |
|
|
48
46
|
| `timeout` | `number` | `30000` | Request timeout in ms |
|
|
49
47
|
| `retries` | `number` | `2` | Retry count for 429/5xx |
|