@spicenet-io/spiceflow-core 0.9.0 → 0.10.0-private-rpc.0

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/index.cjs

@@ -422,7 +422,7 @@ var CHAINS = {
     delegateContract: "0x5884Bff4876C979271E65D2feA8D0CF3bF6E6CcC",
     escrowContract: "0x93ee466f920e1b4961f85749001f03aAd868eF0E",
     blockExplorer: "https://etherscan.io",
-    rpcUrl: "https://eth-mainnet.g.alchemy.com/v2/alch_4ehgbBF6bx-U6loLSFRIy",
+    rpcUrl: "https://tx-submission-api.spicenet.io/rpc/1",
     logo: logo_eth
   },
   8453: {
@@ -434,7 +434,7 @@ var CHAINS = {
     delegateContract: "0x5884Bff4876C979271E65D2feA8D0CF3bF6E6CcC",
     escrowContract: "0xd3F8f177BB3d7dfD883d7c232f3093EdD61C3De9",
     blockExplorer: "https://basescan.org",
-    rpcUrl: "https://base-mainnet.g.alchemy.com/v2/alch_4ehgbBF6bx-U6loLSFRIy",
+    rpcUrl: "https://tx-submission-api.spicenet.io/rpc/8453",
     logo: logo_base
   },
   42161: {
@@ -446,7 +446,7 @@ var CHAINS = {
     delegateContract: "0x262E1A689555dA5209113A056d0d164EF8355395",
     escrowContract: "0x47d6DB10d99b1E0A074B1467407C7A53B68e1147",
     blockExplorer: "https://arbiscan.io",
-    rpcUrl: "https://arb-mainnet.g.alchemy.com/v2/alch_4ehgbBF6bx-U6loLSFRIy",
+    rpcUrl: "https://tx-submission-api.spicenet.io/rpc/42161",
     logo: logo_arb
   },
   4114: {
@@ -458,7 +458,7 @@ var CHAINS = {
     delegateContract: "0x5884Bff4876C979271E65D2feA8D0CF3bF6E6CcC",
     escrowContract: "0x3677113f10d82acFEeDd22dF5c7cFD58736111ee",
     blockExplorer: "https://explorer.mainnet.citrea.xyz",
-    rpcUrl: "https://citrea-mainnet.g.alchemy.com/v2/alch_4ehgbBF6bx-U6loLSFRIy",
+    rpcUrl: "https://tx-submission-api.spicenet.io/rpc/4114",
     logo: logo_citrea,
     wrappedNativeTokenAddress: "0x3100000000000000000000000000000000000006"
   },

package/dist/index.js

@@ -334,7 +334,7 @@ var CHAINS = {
     delegateContract: "0x5884Bff4876C979271E65D2feA8D0CF3bF6E6CcC",
     escrowContract: "0x93ee466f920e1b4961f85749001f03aAd868eF0E",
     blockExplorer: "https://etherscan.io",
-    rpcUrl: "https://eth-mainnet.g.alchemy.com/v2/alch_4ehgbBF6bx-U6loLSFRIy",
+    rpcUrl: "https://tx-submission-api.spicenet.io/rpc/1",
     logo: logo_eth
   },
   8453: {
@@ -346,7 +346,7 @@ var CHAINS = {
     delegateContract: "0x5884Bff4876C979271E65D2feA8D0CF3bF6E6CcC",
     escrowContract: "0xd3F8f177BB3d7dfD883d7c232f3093EdD61C3De9",
     blockExplorer: "https://basescan.org",
-    rpcUrl: "https://base-mainnet.g.alchemy.com/v2/alch_4ehgbBF6bx-U6loLSFRIy",
+    rpcUrl: "https://tx-submission-api.spicenet.io/rpc/8453",
     logo: logo_base
   },
   42161: {
@@ -358,7 +358,7 @@ var CHAINS = {
     delegateContract: "0x262E1A689555dA5209113A056d0d164EF8355395",
     escrowContract: "0x47d6DB10d99b1E0A074B1467407C7A53B68e1147",
     blockExplorer: "https://arbiscan.io",
-    rpcUrl: "https://arb-mainnet.g.alchemy.com/v2/alch_4ehgbBF6bx-U6loLSFRIy",
+    rpcUrl: "https://tx-submission-api.spicenet.io/rpc/42161",
     logo: logo_arb
   },
   4114: {
@@ -370,7 +370,7 @@ var CHAINS = {
     delegateContract: "0x5884Bff4876C979271E65D2feA8D0CF3bF6E6CcC",
     escrowContract: "0x3677113f10d82acFEeDd22dF5c7cFD58736111ee",
     blockExplorer: "https://explorer.mainnet.citrea.xyz",
-    rpcUrl: "https://citrea-mainnet.g.alchemy.com/v2/alch_4ehgbBF6bx-U6loLSFRIy",
+    rpcUrl: "https://tx-submission-api.spicenet.io/rpc/4114",
     logo: logo_citrea,
     wrappedNativeTokenAddress: "0x3100000000000000000000000000000000000006"
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spicenet-io/spiceflow-core",
-  "version": "0.9.0",
+  "version": "0.10.0-private-rpc.0",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",
@@ -19,7 +19,7 @@
     "docs:clean": "rimraf docs",
     "docs:serve": "bunx http-server docs -p 3000 --silent",
     "prepare": "husky || true",
-    "prepack": "bun run build"
+    "prepack": "bun run build && bun test tests/rpc-defaults.test.ts"
   },
   "exports": {
     ".": {