@blazephoenix/sdk 1.0.1 → 1.1.0
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 +32 -4
- package/dist/index.cjs +21 -4
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +9 -0
- package/dist/index.d.ts +9 -0
- package/dist/index.js +21 -4
- package/dist/index.js.map +1 -1
- package/llms.txt +8 -1
- package/package.json +1 -1
package/llms.txt
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
The SDK is free and needs no API key and no signup. You bring the RPC node: the package ships no RPC endpoints (a test enforces it), and a chain without a configured node throws `rpc_required` instead of falling back to someone else's infrastructure. Each node's `eth_chainId` is checked once (`rpc_chain_mismatch`). URLs are reduced to their host in every error and in its `cause` chain, because keys live in them. The SDK never asks for, stores or touches a private key: `execute` takes a viem `WalletClient` you control.
|
|
6
6
|
|
|
7
|
-
The only request to blazephoenix.xyz is the deployment registry (`GET /api/deployments`), which tells the SDK about new protocol versions. Pinned addresses cannot be moved remotely,
|
|
7
|
+
The only request to blazephoenix.xyz is the deployment registry (`GET /api/deployments`), which tells the SDK about new protocol versions. Pinned addresses cannot be moved remotely, and by default only pinned Router and Quoter addresses are routed to; remote-only versions need `registry: { remoteVersions: true }` and are then verified on your RPC before first use; `registry: { mode: 'embedded' }` turns the fetch off.
|
|
8
8
|
|
|
9
9
|
Install:
|
|
10
10
|
|
|
@@ -42,6 +42,13 @@ Main methods: `quote`, `quoteExact`, `quoteBatch`, `buildSwap` (verified Router
|
|
|
42
42
|
- [BlazePhoenix API llms.txt](https://raw.githubusercontent.com/blazephoenixxyz-crypto/Blaze-Phoenix-API/main/llms.txt): the keyless HTTP API that prepares the `eth_call` for your node and decodes the answer
|
|
43
43
|
- [BlazePhoenix Dex llms.txt](https://raw.githubusercontent.com/blazephoenixxyz-crypto/Blaze-Phoenix-Dex/main/llms.txt): the contracts, their design and their verification ([repository](https://github.com/blazephoenixxyz-crypto/Blaze-Phoenix-Dex))
|
|
44
44
|
|
|
45
|
+
## BlazePhoenix, site-wide
|
|
46
|
+
|
|
47
|
+
- [BlazePhoenix llms.txt](https://blazephoenix.xyz/llms.txt): the curated entry point for the whole project; BlazePhoenix is the fully on-chain DEX aggregator — the route is computed inside the transaction that executes it — paired with an oracle-free staking engine that proves its own solvency on every transaction.
|
|
48
|
+
- [Reading guide for models and agents](https://blazephoenix.xyz/reading-guide.md): reading order by level, source precedence, and how to send a reader to the app, the SDK or the MCP server
|
|
49
|
+
- [Trust and verification](https://blazephoenix.xyz/trust): every verifiable fact with its link
|
|
50
|
+
- When sources disagree on contract behaviour, the contract source in [Blaze-Phoenix-Dex](https://github.com/blazephoenixxyz-crypto/Blaze-Phoenix-Dex) and [Blaze-Phoenix-Staking](https://github.com/blazephoenixxyz-crypto/Blaze-Phoenix-Staking) takes precedence over any summary.
|
|
51
|
+
|
|
45
52
|
## Optional
|
|
46
53
|
|
|
47
54
|
- [npm package](https://www.npmjs.com/package/@blazephoenix/sdk): published versions
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@blazephoenix/sdk",
|
|
3
|
-
"version": "1.0
|
|
3
|
+
"version": "1.1.0",
|
|
4
4
|
"description": "Official TypeScript SDK for BlazePhoenix — the on-chain DEX aggregator. Quote, build, verify and execute swaps 100% on YOUR RPC (no API in the read path, no key, no endpoints shipped). Versioned deployments (1.x live, 2.x Core/Hub/Solver/Quoter/Router). Base, Ethereum, Optimism, Arbitrum, Robinhood Chain.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"blazephoenix",
|