@spicenet-io/spiceflow-core 0.2.0 → 0.3.1

package/README.md

@@ -0,0 +1,82 @@
+# @spicenet-io/spiceflow-core
+
+Single source of truth for chain configs, token lists, logos, ABIs, and shared utilities across spiceflow repos.
+
+## Install
+
+```
+npm install @spicenet-io/spiceflow-core
+```
+
+## What's in here
+
+### Chains
+
+`CHAINS` is a record of all supported chains keyed by chain ID. Each entry has id, name, display name, network (mainnet/testnet), native currency, delegate contract address, block explorer, rpc url, and logo.
+
+Helper functions: `getChainMeta(chainId)`, `getChainsByNetwork(network)`, `getChainIdsByNetwork(network)`, `getMainnetChains()`, `getTestnetChains()`, `getDelegateContract(chainId)`.
+
+### Tokens
+
+`TOKENS` is the official token list. Each token has symbol, name, equivalence group, logo, and deployments across chains (address, decimals, network per chain).
+
+Helper functions: `getTokensForChain(chainId)`, `getTokenByAddress(address, chainId)`, `getEquivalentAddresses(tokenAddress)`, `areEquivalent(a, b)`, `isUsdDenominated(address)`, `isBtcDenominated(address)`.
+
+### Logos
+
+All chain and token logos are bundled as base64 data URIs in the package. They work directly in img src attributes with no network requests. To add a new logo, drop the PNG in `logos/` and reference it in the chain or token list. `npm run build` auto generates the base64 file.
+
+### Utilities
+
+`isNativeToken(address)` checks if an address is a native token (zero address, 0x0, or 0xeee...eee).
+
+`normalizeNativeTokenAddress(address)` normalizes any native token address to the zero address.
+
+`convertAmountBetweenDecimals(amount, fromDecimals, toDecimals)` converts token amounts between different decimal precisions.
+
+`formatTokenAmount(amount, decimals)` formats a bigint token amount into a human readable string.
+
+`truncateAddress(address)` shortens an address for display.
+
+`withRetry(fn, maxRetries, delayMs)` retries an async function with exponential backoff.
+
+Constants: `NATIVE_TOKEN_ADDRESS`, `ZERO_ADDRESS`, `ESCROW_ADDRESS`.
+
+### ABIs
+
+`DELEGATE_ABI`, `ERC20_ABI`, `WCBTC_ABI`.
+
+### Authorization
+
+`hashChainBatches(chainCalls)` hashes chain call batches for intent signing.
+
+`getIntentHash(signatureType, nbf, exp, chainBatches)` computes the intent hash.
+
+`getAccountNonce(address, publicClient)` gets the account nonce from chain.
+
+### Core SDK
+
+`SpiceFlowCore` class for building and submitting intents. Handles delegation signing, chain batch construction, intent signing, and transaction submission.
+
+### HTTP
+
+`fetchWithRetry(url, init, opts)` is a fetch wrapper with retry and exponential backoff.
+
+`submitTransaction(baseUrl, request)` submits a transaction to the relayer API.
+
+`getIntentStepStatus(txApiUrl, intentId, stepId)` checks intent execution status.
+
+`prepareRFQT(txApiUrl, request)` prepares an RFQT quote.
+
+## Adding a token
+
+1. Drop the logo PNG in `logos/`
+2. Add the token entry in `src/tokens/list.ts` with symbol, name, equivalence group, logo reference, and deployments
+3. `npm run build` and publish
+
+## Adding a chain
+
+1. Drop the logo PNG in `logos/` if it's a new chain logo
+2. Add the chain entry in `src/chains/list.ts`
+3. Add token deployments on that chain in `src/tokens/list.ts`
+4. `npm run build` and publish

package/dist/abis/index.d.ts

@@ -1,4 +1,5 @@
 export { DELEGATE_ABI } from "./delegate.js";
 export { ERC20_ABI } from "./erc20.js";
 export { WCBTC_ABI } from "./wcbtc.js";
+export { uniV3QuoterV2Abi, uniV3SwapRouterAbi } from "./uniV3.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/abis/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/abis/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/abis/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AACvC,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC"}

package/dist/abis/uniV3.d.ts

@@ -0,0 +1,93 @@
+export declare const uniV3QuoterV2Abi: readonly [{
+    readonly inputs: readonly [{
+        readonly components: readonly [{
+            readonly internalType: "address";
+            readonly name: "tokenIn";
+            readonly type: "address";
+        }, {
+            readonly internalType: "address";
+            readonly name: "tokenOut";
+            readonly type: "address";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "amountIn";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint24";
+            readonly name: "fee";
+            readonly type: "uint24";
+        }, {
+            readonly internalType: "uint160";
+            readonly name: "sqrtPriceLimitX96";
+            readonly type: "uint160";
+        }];
+        readonly internalType: "struct IQuoterV2.QuoteExactInputSingleParams";
+        readonly name: "params";
+        readonly type: "tuple";
+    }];
+    readonly name: "quoteExactInputSingle";
+    readonly outputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "amountOut";
+        readonly type: "uint256";
+    }, {
+        readonly internalType: "uint160";
+        readonly name: "sqrtPriceX96After";
+        readonly type: "uint160";
+    }, {
+        readonly internalType: "uint32";
+        readonly name: "initializedTicksCrossed";
+        readonly type: "uint32";
+    }, {
+        readonly internalType: "uint256";
+        readonly name: "gasEstimate";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+    readonly type: "function";
+}];
+export declare const uniV3SwapRouterAbi: readonly [{
+    readonly inputs: readonly [{
+        readonly components: readonly [{
+            readonly internalType: "address";
+            readonly name: "tokenIn";
+            readonly type: "address";
+        }, {
+            readonly internalType: "address";
+            readonly name: "tokenOut";
+            readonly type: "address";
+        }, {
+            readonly internalType: "uint24";
+            readonly name: "fee";
+            readonly type: "uint24";
+        }, {
+            readonly internalType: "address";
+            readonly name: "recipient";
+            readonly type: "address";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "amountIn";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint256";
+            readonly name: "amountOutMinimum";
+            readonly type: "uint256";
+        }, {
+            readonly internalType: "uint160";
+            readonly name: "sqrtPriceLimitX96";
+            readonly type: "uint160";
+        }];
+        readonly internalType: "struct IV3SwapRouter.ExactInputSingleParams";
+        readonly name: "params";
+        readonly type: "tuple";
+    }];
+    readonly name: "exactInputSingle";
+    readonly outputs: readonly [{
+        readonly internalType: "uint256";
+        readonly name: "amountOut";
+        readonly type: "uint256";
+    }];
+    readonly stateMutability: "payable";
+    readonly type: "function";
+}];
+//# sourceMappingURL=uniV3.d.ts.map

package/dist/abis/uniV3.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uniV3.d.ts","sourceRoot":"","sources":["../../src/abis/uniV3.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsCnB,CAAC;AAIX,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiCrB,CAAC"}