@gibs/bridge-sdk 1.18.0 → 1.20.0

package/dist/referral.js

@@ -1,80 +1,5 @@
-/**
- * Referral configuration — the one place to set who gets paid.
- *
- * This module exists so the payout address is a single named edit rather than a
- * constant buried among API urls. It deliberately imports nothing but a type, so
- * the interface can read the address without pulling in a quote builder.
- */
-/**
- * Gibs Finance's own integrator identifier with LI.FI and Relay. LI.FI pays its
- * integrator share against this string — the payout account is configured on
- * LI.FI's side, which is why LI.FI needs no address here and Relay does.
- *
- * This is Gibs Finance's identity, not a setting for other consumers. The
- * Relay API key that used to live beside it moved into the Gibs interface's
- * own configuration (`packages/ui/src/lib/config.ts`): this package ships no
- * key. Pass your own identifiers on each request — see the README.
- */
 export const referralIntegrator = 'gibs.finance';
-/**
- * Resolves one attribution field (a LI.FI `integrator`, a Relay `referrer`)
- * from a caller's override and this package's default for it.
- *
- * Three states, not two:
- * - `undefined` (left out): the package default — which may itself be
- *   `undefined`, meaning the field is not sent.
- * - `null`: the field is OMITTED from the request. Never sent as `''`: Relay
- *   reads any `referrer`, an empty one included, as "a referrer was supplied".
- * - a string: sent as-is.
- *
- * @param override - the caller's value for the field
- * @param packageDefault - the value used when the caller leaves the field out
- * @returns the value to send, or undefined to omit the field
- */
 export const resolveAttribution = (override, packageDefault) => (override === null ? undefined : (override ?? packageDefault));
-/**
- * Gibs Finance's payout address for Relay application fees.
- *
- * NO BUILDER APPLIES IT. A Relay request carries an `appFees` entry only when
- * the caller passes `relayAppFee`. The Gibs interface passes this address
- * explicitly; any other caller passes its own, or nothing.
- *
- * Set to the owner's receiving wallet. Setting it back to `null` is a working
- * state rather than a broken one, and is the way to stop collecting: Relay
- * rejects a fee entry that names no recipient, so the fee is omitted from the
- * request entirely and nothing is charged. Every consumer already reads it this
- * way — see {@link referralIsCollectable}.
- *
- * The literal is stored CHECKSUMMED (mixed case). That is not decoration: the
- * mixed case IS the checksum, so a typo in the address fails `getAddress`
- * instead of silently paying a wrong-but-valid account. Verified against viem's
- * `getAddress` before being written here.
- *
- * One address serves every chain: Relay pays application fees on the DESTINATION
- * chain, and every destination this app bridges to is Ethereum-style, so an
- * ordinary Ethereum address receives from all of them.
- */
 export const relayReferralRecipient = '0xAF2ce0189f46f5663715b0b9ED2a10eA924AB9B0';
-/**
- * The application fee the Gibs interface charges, in basis points. Ten basis
- * points is one tenth of one percent. The interface can override it per
- * provider in stored settings; this is the value a reader who has never touched
- * the setting gets.
- *
- * NO BUILDER APPLIES IT. It reaches a request only when a caller passes it as
- * `relayAppFee.basisPoints` (Relay) or converts it to `lifiFee` (LI.FI).
- */
 export const defaultReferralFeeBasisPoints = 10n;
-/**
- * Whether a referral fee will ACTUALLY be collected, as opposed to merely being
- * switched on.
- *
- * The distinction is the point of this helper. Relay's fee needs three things to
- * be true at once, and the interface used to show a percentage whenever the
- * first was true — so the fee row read "0.10%" while the missing recipient meant
- * nothing was charged at all. Ask this rather than reading `enabled` alone.
- *
- * @param options - the switch state, the fee size, and the payout address
- * @returns true only when a fee will reach a recipient
- */
 export const referralIsCollectable = ({ enabled, basisPoints, recipient, }) => enabled && basisPoints > 0n && recipient !== null;

package/dist/relay-currencies.js

@@ -1,14 +1,4 @@
-/**
- * Relay currencies endpoint. Anonymous access works at the same 50-requests-per-
- * minute tier as the quote endpoint; used to discover the source tokens a
- * non-Ethereum origin chain (Solana, Bitcoin) can bridge from.
- */
 export const relayCurrenciesUrl = 'https://api.relay.link/currencies/v2';
-/**
- * Builds the Relay currencies request body.
- *
- * @returns the request body, or null when no chain ids are supplied
- */
 export const buildRelayCurrenciesRequest = ({ chainIds, limit, }) => {
     if (chainIds.length === 0) {
         return null;
@@ -21,20 +11,7 @@ const asRecord = (value) => {
     }
     return value;
 };
-/**
- * Relay's own chain registry — the provider's word on which chains it
- * supports AT ALL, distinct from `/currencies/v2` (which chains currently
- * have priced currencies). A chain absent here can never be asked about, on
- * `/currencies/v2` or `/quote` alike; see `parseRelayChains`.
- */
 export const relayChainsUrl = 'https://api.relay.link/chains';
-/**
- * Normalizes a `GET /chains` response body to the chain ids Relay lists.
- * Mirrors `parseLifiChains` (`consolidated-quote.ts`) for LI.FI's own chain
- * list: read the provider's own registry, never a hand-written exclusion.
- *
- * @returns the chain ids Relay lists, or null when the payload shape is unexpected
- */
 export const parseRelayChains = (payload) => {
     const body = asRecord(payload);
     if (body === null || !Array.isArray(body.chains)) {
@@ -49,14 +26,6 @@ export const parseRelayChains = (payload) => {
     }
     return ids;
 };
-/**
- * Maps Relay's flat `/currencies/v2` array onto the shared `Token` shape. A
- * Relay currency's `address` is already a string (a Solana mint or a Bitcoin
- * native address), so no widening is needed. Malformed entries are skipped
- * rather than failing the whole list.
- *
- * @returns the tokens, or an empty list when the payload is not an array
- */
 export const parseRelayCurrencies = (payload) => {
     if (!Array.isArray(payload)) {
         return [];

package/dist/relay-depository.js

@@ -1,82 +1,57 @@
 import { getAddress } from 'viem';
-/**
- * Relay's deposit contract (its "depository") on each Ethereum-style chain:
- * the ONLY address a Relay origin deposit may be sent to, and the only
- * address it may ask the reader to approve.
- *
- * WHY A FIXED TABLE. A quote that names its own spender cannot be trusted to
- * name an honest one: a compromised quote host could name any contract. This
- * table ships with the code and changes only through a release.
- *
- * SOURCE. Relay's Chains API, `GET https://api.relay.link/chains`, field
- * `chains[].protocol.v2.depository`, read 2026-10-07 for every chain whose
- * `vmType` is `evm`. Relay's documentation says its depository addresses are
- * published only through that API
- * (https://docs.relay.link/references/protocol/addresses). A live quote the
- * same day (Ethereum USDC to Base, `POST /quote/v2`) approved and deposited to
- * exactly the Ethereum entry below.
- *
- * NOT THE `contracts` BLOCK. The same API also lists `relayReceiver`,
- * `approvalProxy` and `erc20Router` under `chains[].contracts`. The live
- * quote used none of them, so they are left out: an address the quote does
- * not use is not one this table should accept.
- *
- * A CHAIN NOT LISTED IS REFUSED. If Relay adds a chain or moves a depository,
- * deposits there are refused until this table is updated.
- */
 const common = getAddress('0x4cd00e387622c35bddb9b4c962c136462338bc31');
 const alternate = getAddress('0x59916da825d2d2ec1bf878d71c88826f6633ecca');
 export const relayDepositoryByChainId = new Map([
-    [1, common], // ethereum
-    [10, common], // optimism
-    [25, alternate], // cronos
-    [56, common], // bsc
-    [100, common], // gnosis
-    [130, common], // unichain
-    [137, common], // polygon
-    [143, common], // monad
-    [146, common], // sonic
-    [169, common], // manta-pacific
-    [196, common], // xlayer
-    [288, common], // boba
-    [324, common], // zksync
-    [360, common], // shape
-    [480, common], // world-chain
-    [747, common], // flow-evm
-    [988, common], // stable
-    [999, common], // hyperevm
-    [1088, alternate], // metis
-    [1135, common], // lisk
-    [1868, common], // soneium
-    [2020, common], // ronin
-    [2741, common], // abstract
-    [2818, common], // morph
-    [4217, common], // tempo
-    [4326, common], // megaeth
-    [4663, common], // robinhood
-    [5000, alternate], // mantle
-    [5031, common], // somnia
-    [5042, common], // arc
-    [5330, common], // superseed
-    [8453, common], // base
-    [9745, common], // plasma
-    [33139, common], // apechain
-    [34443, common], // mode
-    [42018, common], // mythos
-    [42161, common], // arbitrum
-    [42220, common], // celo
-    [43114, common], // avalanche
-    [48900, common], // zircuit
-    [57073, common], // ink
-    [59144, alternate], // linea
-    [60808, common], // bob
-    [80094, common], // berachain
-    [81457, common], // blast
-    [97477, common], // doma
-    [98866, common], // plume
-    [534352, common], // scroll
-    [685689, common], // gensyn
-    [747474, common], // katana
-    [5064014, common], // ethereal
-    [7777777, common], // zora
+    [1, common],
+    [10, common],
+    [25, alternate],
+    [56, common],
+    [100, common],
+    [130, common],
+    [137, common],
+    [143, common],
+    [146, common],
+    [169, common],
+    [196, common],
+    [288, common],
+    [324, common],
+    [360, common],
+    [480, common],
+    [747, common],
+    [988, common],
+    [999, common],
+    [1088, alternate],
+    [1135, common],
+    [1868, common],
+    [2020, common],
+    [2741, common],
+    [2818, common],
+    [4217, common],
+    [4326, common],
+    [4663, common],
+    [5000, alternate],
+    [5031, common],
+    [5042, common],
+    [5330, common],
+    [8453, common],
+    [9745, common],
+    [33139, common],
+    [34443, common],
+    [42018, common],
+    [42161, common],
+    [42220, common],
+    [43114, common],
+    [48900, common],
+    [57073, common],
+    [59144, alternate],
+    [60808, common],
+    [80094, common],
+    [81457, common],
+    [97477, common],
+    [98866, common],
+    [534352, common],
+    [685689, common],
+    [747474, common],
+    [5064014, common],
+    [7777777, common],
 ]);