@gibs/bridge-sdk 1.19.0 → 1.20.0

package/dist/swap-venues.js

@@ -1,24 +1,7 @@
 import { defaultSwapVenues } from './config.js';
-/**
- * Merges caller venues over {@link defaultSwapVenues}. A chain present in
- * `overrides` replaces the default list for that chain. A chain absent from
- * `overrides` keeps its default list. An empty list switches swaps off on
- * that chain. Neither input is changed; the result is frozen.
- *
- * @param overrides - the caller's venues, or undefined for the defaults
- * @returns the venues to use
- */
 export const resolveSwapVenues = (overrides) => {
     if (overrides === undefined)
         return defaultSwapVenues;
     return Object.freeze({ ...defaultSwapVenues, ...overrides });
 };
-/**
- * Finds the venue on a chain that has the given router.
- *
- * @param venues - the venues to search
- * @param chainId - the numeric chain id
- * @param router - the router address, in any letter case
- * @returns the venue, or null when the chain has no venue with that router
- */
 export const findSwapVenue = (venues, chainId, router) => venues[chainId]?.find((venue) => venue.router.toLowerCase() === router.toLowerCase()) ?? null;

package/dist/ton-connect.js

@@ -1,56 +1,10 @@
-/**
- * Executing a deposit on The Open Network, as pure data, with no TON library.
- *
- * This module imports nothing outside the package, so it loads anywhere: a
- * browser, Node, or a React Native app under Hermes, with no `Buffer` and no
- * polyfill. It uses only `atob` and `btoa`, which Hermes provides. The one TON
- * helper that needs `@ton/core`, the TEP-467 message hash, lives in
- * `@gibs/bridge-sdk/ton` instead.
- *
- * Relay describes a deposit as a list of internal messages carrying `to`,
- * `value`, `body` and a `bounce` flag. A connected wallet, however, is driven
- * through the TON Connect protocol, whose request shape is different in one way
- * that silently loses money:
- *
- * **TON Connect has no per-message `bounce` field.** A wallet derives whether a
- * message bounces from the FORM OF THE ADDRESS — the bounceable `EQ…` prefix or
- * the non-bounceable `UQ…` one. Passing Relay's address through unchanged while
- * dropping its `bounce: false` therefore sends a deposit to the bounceable form,
- * and the depository bounces the funds straight back to the sender. The transfer
- * looks like it succeeded and the route never fills.
- *
- * {@link buildTonConnectRequest} folds `bounce` into the address so the flag
- * cannot be dropped on the way to a wallet.
- *
- * Kept free of transport and of clock reads so it is fully testable: nothing
- * here signs, fetches, or calls `Date.now`. The caller supplies the deadline and
- * performs the request.
- *
- * The rules encoded here are those of Relay's own wallet adapter, which is the
- * only reference implementation of this mapping.
- */
-/**
- * The TON Connect network identifier for mainnet. Relay bridges only mainnet, so
- * a request is always tagged with this.
- */
 export const tonConnectMainnetNetwork = '-239';
-/** How long a request stays valid by default, in seconds, matching Relay's adapter. */
 export const tonConnectDefaultValidForSeconds = 300;
-/** Address tag byte for the bounceable (`EQ…`) form. */
 const bounceableTag = 0x11;
-/** Address tag byte for the non-bounceable (`UQ…`) form. */
 const nonBounceableTag = 0x51;
-/** Bit set on the tag byte for testnet-only addresses (`kQ…` / `0Q…`). */
 const testnetTagFlag = 0x80;
-/** A friendly address is a 36-byte structure: tag, workchain, hash, checksum. */
 const friendlyAddressByteLength = 36;
-/** An account identifier is always 32 bytes, in every address form. */
 const accountHashByteLength = 32;
-/**
- * Cyclic redundancy check (16-bit, the XModem variant) over an address body.
- * The Open Network appends it to every friendly address, and a re-encoded
- * address whose checksum is not recomputed is rejected by wallets as malformed.
- */
 const checksum = (data) => {
     let remainder = 0;
     for (const byte of data) {
@@ -62,7 +16,6 @@ const checksum = (data) => {
     }
     return remainder;
 };
-/** Decodes the url-safe base64 alphabet the friendly address form uses. */
 const decodeBase64Url = (value) => {
     const standard = value.replaceAll('-', '+').replaceAll('_', '/');
     const padded = standard.padEnd(Math.ceil(standard.length / 4) * 4, '=');
@@ -74,7 +27,6 @@ const decodeBase64Url = (value) => {
         return null;
     }
 };
-/** Encodes bytes back into the url-safe, unpadded base64 form. */
 const encodeBase64Url = (bytes) => {
     let binary = '';
     for (const byte of bytes) {
@@ -100,7 +52,6 @@ const parseRawAddress = (value) => {
         }
         hash[index] = byte;
     }
-    // The raw form carries no network tag, so mainnet is the only safe assumption.
     return { workchain, hash, testOnly: false };
 };
 const parseFriendlyAddress = (value) => {
@@ -109,8 +60,6 @@ const parseFriendlyAddress = (value) => {
         return null;
     }
     const body = bytes.subarray(0, friendlyAddressByteLength - 2);
-    // Every index below is in range: the length was checked to be exactly
-    // `friendlyAddressByteLength` above, so the non-null assertions are sound.
     const stated = (bytes[friendlyAddressByteLength - 2] << 8) | bytes[friendlyAddressByteLength - 1];
     if (checksum(body) !== stated) {
         return null;
@@ -122,29 +71,12 @@ const parseFriendlyAddress = (value) => {
     }
     const workchainByte = bytes[1];
     return {
-        // The masterchain is workchain -1, which travels as the byte 0xff.
         workchain: workchainByte === 0xff ? -1 : workchainByte,
         hash: bytes.slice(2, 2 + accountHashByteLength),
         testOnly: (tag & testnetTagFlag) !== 0,
     };
 };
-/**
- * Parses either address form The Open Network uses.
- *
- * @param value - a friendly (`EQ…`/`UQ…`) or raw (`0:…`) address
- * @returns the address parts, or null when it is neither form or fails its checksum
- */
 export const parseTonAddress = (value) => value.includes(':') ? parseRawAddress(value) : parseFriendlyAddress(value);
-/**
- * Re-encodes an address into the friendly form matching a bounce setting.
- *
- * This is the whole point of the module: the bounce flag has nowhere else to
- * live in a TON Connect request, so it has to be carried by the address itself.
- *
- * @param address - the address in either form
- * @param options.bounceable - whether the message may bounce back to the sender
- * @returns the friendly address, or null when the input cannot be parsed
- */
 export const encodeTonAddress = (address, { bounceable }) => {
     const parsed = parseTonAddress(address);
     if (parsed === null) {
@@ -160,17 +92,6 @@ export const encodeTonAddress = (address, { bounceable }) => {
     bytes[friendlyAddressByteLength - 1] = stated & 0xff;
     return encodeBase64Url(bytes);
 };
-/**
- * Builds the TON Connect request for a deposit.
- *
- * @param deposit - the parsed origin deposit
- * @param options.validUntil - unix seconds after which the request expires.
- *   Supplied by the caller rather than read from a clock here so the transform
- *   stays pure; {@link tonConnectDefaultValidForSeconds} is the usual offset.
- * @returns the request, or null when the deposit carries no messages or any
- *   destination address cannot be re-encoded — never a request whose bounce
- *   setting has been silently dropped
- */
 export const buildTonConnectRequest = (deposit, { validUntil }) => {
     if (deposit.messages.length === 0) {
         return null;
@@ -178,8 +99,6 @@ export const buildTonConnectRequest = (deposit, { validUntil }) => {
     const messages = [];
     for (const message of deposit.messages) {
         const address = encodeTonAddress(message.to, { bounceable: message.bounce });
-        // Refuse rather than fall back to the unencoded address: the fallback is
-        // exactly the bounce-losing behaviour this module exists to prevent.
         if (address === null) {
             return null;
         }
@@ -189,7 +108,6 @@ export const buildTonConnectRequest = (deposit, { validUntil }) => {
             ...(message.body ? { payload: message.body } : {}),
         });
     }
-    // `messages[0]` is present: the empty case returned null above.
     const from = deposit.messages[0].from;
     return {
         validUntil,

package/dist/ton-execution.js

@@ -1,7 +1 @@
-/**
- * The original name of `@gibs/bridge-sdk/ton`, kept so existing imports work.
- *
- * @deprecated Import from `@gibs/bridge-sdk/ton` for the full TON surface, or
- * from `@gibs/bridge-sdk/ton-connect` for the helpers that need no TON library.
- */
 export * from './ton.js';

package/dist/ton.js

@@ -1,57 +1,16 @@
 import { Cell, beginCell, loadMessage, storeMessage } from '@ton/core';
-/**
- * Everything the bridge SDK offers for The Open Network, in one entry point.
- *
- * It re-exports the pure TON Connect helpers from `./ton-connect.js` and adds
- * {@link tonExternalMessageHash}, the only helper that needs `@ton/core`.
- *
- * Kept apart from the root entry point on purpose. `@ton/core` uses Node's
- * `Buffer`, and its `@ton/crypto` dependency resolves, under React Native, to a
- * build that requires `expo-crypto`. An application that bridges only between
- * Ethereum-style chains never imports this file, so it never pays for either.
- */
 export * from './ton-connect.js';
-/**
- * Derives the transaction identifier from a wallet's `sendTransaction` response.
- *
- * A wallet answers with a `boc`: the base64 bag-of-cells of the signed
- * external-in message it broadcast — NOT the resulting transaction, and NOT a
- * hash. The identifier explorers and indexers (toncenter, TonAPI) resolve a
- * transaction by is the hash of that external message, but it must be the
- * NORMALIZED hash of TEP-467, not the hash of the bytes the wallet happened to
- * send.
- *
- * The distinction is the whole point, and getting it wrong loses a resume record
- * for real funds. An external-in message can be serialized several equivalent
- * ways — a wallet may or may not include its own `src`, may set a non-zero
- * `import_fee`, may attach a `stateInit`, may store the body inline or as a
- * reference. The raw cell hash changes with each of those wallet-specific
- * choices, so it frequently does NOT match what an indexer keyed the same
- * transaction under. TEP-467 rebuilds the message with those variable fields
- * stripped (`src` to none, `import_fee` to zero, `init` dropped, body forced to a
- * reference) so the hash is stable across wallets and matches the indexers.
- *
- * @param boc - the wallet's base64 `boc` field from `sendTransaction`
- * @returns the 64-character hex normalized hash, or null when the input is not a
- *   parseable external-in message
- */
 export const tonExternalMessageHash = (boc) => {
     try {
         const message = loadMessage(Cell.fromBase64(boc).beginParse());
-        // Only an external-in message has a normalized form; an internal message or
-        // a bare cell is not the wallet's broadcast envelope and cannot be keyed.
         if (message.info.type !== 'external-in') {
             return null;
         }
         const normalized = {
             ...message,
-            // Dropped by TEP-467 so a wallet-attached stateInit does not move the hash.
             init: null,
-            // `src` to addr_none (undefined) and the fee to zero: both are the sender's
-            // to choose and neither is part of what identifies the message.
             info: { ...message.info, src: undefined, importFee: 0n },
         };
-        // `forceRef` stores the body as a reference, as the normalized form requires.
         return beginCell()
             .store(storeMessage(normalized, { forceRef: true }))
             .endCell()
@@ -59,7 +18,6 @@ export const tonExternalMessageHash = (boc) => {
             .toString('hex');
     }
     catch {
-        // A malformed base64 payload or a cell tree that is not a message at all.
         return null;
     }
 };

package/dist/tron-execution.js

@@ -1,69 +1,8 @@
-/**
- * Executing a deposit on Tron, as pure data.
- *
- * Relay does not return a broadcastable Tron transaction. It returns the
- * *parameters* of a `TriggerSmartContract` call — owner, contract, call value
- * and calldata — and nothing else. A Tron transaction additionally needs a
- * reference block, an expiration and a fee limit, none of which Relay supplies.
- * Those are produced by asking a full node to build the transaction, which is
- * what {@link buildTriggerSmartContractRequest} constructs the body for. The
- * node answers with an UNSIGNED transaction; the wallet signs it and a second
- * call broadcasts it.
- *
- * Three details of that exchange lose money or mislead if handled naively:
- *
- * **The `visible` flag defaults to true.** A node reads addresses as base58
- * unless told otherwise, but Relay returns them as hex with Tron's `41` prefix.
- * Omitting the flag therefore hands base58-parsing a hex string. The request
- * built here always states `visible: false` rather than relying on a default
- * that is the opposite of what the payload contains.
- *
- * **`fee_limit` is required and Relay omits it.** It caps the energy the caller
- * will pay for. Set too low, the call runs out of energy, reverts, and the
- * energy already burned is NOT refunded — the deposit fails and costs the user
- * anyway.
- *
- * **A rejected call still answers HTTP 200**, with the reason hex-encoded in
- * `result.message`. Reading the status code alone reports a failed deposit as a
- * success, and printing the message unmodified shows the user a wall of hex.
- * {@link tronErrorMessage} decodes it.
- *
- * Kept free of transport and of clock reads so it is fully testable: nothing
- * here signs, fetches, or calls `Date.now`. The caller performs the requests.
- */
-/** Path of the full-node endpoint that builds an unsigned contract call. */
 export const tronTriggerSmartContractPath = '/wallet/triggersmartcontract';
-/**
- * The fee limit used when a caller states none, in sun (1 TRX = 1,000,000 sun).
- *
- * Thirty TRX, matching Relay's own wallet adapter, which is the only reference
- * implementation of this deposit path. It is an upper bound rather than a
- * charge: unused energy is not taken, so the cost of setting it generously is
- * only that the wallet shows a larger worst case.
- */
 export const defaultTronFeeLimitSun = 30_000_000;
-/**
- * The largest fee limit a node accepts, in sun — 15,000 TRX. Documented as a
- * hard protocol cap, so a request above it is rejected outright rather than
- * clamped.
- */
 export const maximumTronFeeLimitSun = 15_000_000_000;
-/**
- * Tron's `41` address prefix, the hex form's equivalent of the base58 `T`.
- */
 const tronHexAddressPrefix = '41';
-/** A hex address is the prefix byte plus a twenty-byte account identifier. */
 const tronHexAddressLength = 42;
-/**
- * Normalizes a Tron hex address for comparison.
- *
- * Wallets and quotes disagree on casing, and Relay's payload is not guaranteed
- * to match what a wallet reports even when both name the same account.
- *
- * @param value - an address in Tron's `41`-prefixed hex form, in any casing,
- *   optionally written with a `0x` prefix
- * @returns the lowercase `41` form, or null when the value is not that form
- */
 export const normalizeTronHexAddress = (value) => {
     const withoutPrefix = value.trim().replace(/^0x/i, '').toLowerCase();
     if (withoutPrefix.length !== tronHexAddressLength) {
@@ -74,50 +13,13 @@ export const normalizeTronHexAddress = (value) => {
     }
     return /^[0-9a-f]+$/.test(withoutPrefix) ? withoutPrefix : null;
 };
-/**
- * Whether two Tron hex addresses name the same account.
- *
- * Used to check a deposit's owner against the connected wallet before signing.
- * A mismatch means the quote was built for a different account, and signing it
- * would spend from an account the user did not choose — or simply fail after
- * the user has already approved.
- *
- * @param left - an address in Tron's `41`-prefixed hex form
- * @param right - an address in the same form
- * @returns true only when both parse and name the same account
- */
 export const isSameTronAccount = (left, right) => {
     const normalizedLeft = normalizeTronHexAddress(left);
     const normalizedRight = normalizeTronHexAddress(right);
     return normalizedLeft !== null && normalizedLeft === normalizedRight;
 };
-/**
- * Strips the `0x` prefix Tron calldata never carries.
- *
- * Relay documents this field as bare hex, but its own adapter strips the prefix
- * defensively, and a prefixed value is parsed by a node as calldata beginning
- * with the bytes `0x` rather than being rejected — a silently wrong call.
- */
 const bareHex = (value) => value.replace(/^0x/i, '').toLowerCase();
-/**
- * Whether a numeric amount survives the trip through JSON as an exact integer.
- *
- * Sun amounts are 64-bit on the wire but JSON carries them as doubles, so a
- * large enough value would be silently rounded — into a different amount of
- * money than the one that was quoted.
- */
 const isExactInteger = (value) => value >= 0n && value <= BigInt(Number.MAX_SAFE_INTEGER);
-/**
- * Builds the body that asks a full node to construct the unsigned deposit.
- *
- * @param deposit - the parsed origin deposit
- * @param options.feeLimitSun - the energy spending cap in sun; defaults to
- *   {@link defaultTronFeeLimitSun}
- * @returns the request body, or null when the deposit names an address that is
- *   not Tron hex, carries a call value that cannot be represented exactly, or
- *   the fee limit is outside what a node accepts — never a body that would be
- *   built against a default `visible` the payload contradicts
- */
 export const buildTriggerSmartContractRequest = (deposit, { feeLimitSun = defaultTronFeeLimitSun } = {}) => {
     const ownerAddress = normalizeTronHexAddress(deposit.ownerAddress);
     const contractAddress = normalizeTronHexAddress(deposit.contractAddress);
@@ -139,14 +41,6 @@ export const buildTriggerSmartContractRequest = (deposit, { feeLimitSun = defaul
         visible: false,
     };
 };
-/**
- * Decodes a node's hex-encoded failure message.
- *
- * A node reports why it refused a call in `result.message`, hex-encoded — the
- * bytes `4e6f20636f6e7472616374…` rather than "No contract or not a valid smart
- * contract". Broadcast failures report plain text in the same field, so both
- * are handled and a value that is not hex is passed through unchanged.
- */
 const decodeTronMessage = (value) => {
     const trimmed = value.trim();
     if (trimmed.length === 0 || trimmed.length % 2 !== 0 || !/^[0-9a-fA-F]+$/.test(trimmed)) {
@@ -156,26 +50,16 @@ const decodeTronMessage = (value) => {
     for (let index = 0; index < trimmed.length; index += 2) {
         decoded += String.fromCharCode(Number.parseInt(trimmed.slice(index, index + 2), 16));
     }
-    // A hex string that decodes to control characters was a number, not a
-    // message — return the original rather than a string of unprintable bytes.
     return /^[\x20-\x7e]*$/.test(decoded) ? decoded : trimmed;
 };
 const asRecord = (value) => typeof value === 'object' && value !== null && !Array.isArray(value)
     ? value
     : null;
-/**
- * Extracts a node's failure reason from either endpoint's response.
- *
- * @param payload - the parsed response body
- * @returns the decoded message, or null when the response reports no failure
- */
 export const tronErrorMessage = (payload) => {
     const body = asRecord(payload);
     if (body === null) {
         return null;
     }
-    // The build endpoint nests its outcome under `result`; the broadcast endpoint
-    // reports at the top level.
     const nested = asRecord(body.result);
     const message = nested?.message ?? body.message;
     if (typeof message !== 'string') {
@@ -184,17 +68,6 @@ export const tronErrorMessage = (payload) => {
     const decoded = decodeTronMessage(message);
     return decoded.length === 0 ? null : decoded;
 };
-/**
- * Reads the unsigned transaction out of a build response.
- *
- * The response carries the transaction at the top level alongside a `result`
- * object stating whether the build succeeded, so the presence of a `txID` is
- * not on its own evidence of success.
- *
- * @param payload - the parsed `/wallet/triggersmartcontract` response
- * @returns the unsigned transaction to hand a wallet, or null when the node
- *   refused the call
- */
 export const readTriggerSmartContractResponse = (payload) => {
     const body = asRecord(payload);
     if (body === null) {
@@ -210,24 +83,6 @@ export const readTriggerSmartContractResponse = (payload) => {
     }
     return transaction;
 };
-/**
- * Reads the transaction identifier out of a broadcast response.
- *
- * GOTCHA: a rejected broadcast answers HTTP 200, and `result` is OMITTED rather
- * than set to false. Testing `result === false` therefore never fires, and
- * trusting the status code records a deposit that never entered a block. Only
- * an explicit `result: true` is accepted here.
- *
- * The identifier is read from `txid` where a node reports it, falling back to
- * the echoed transaction's `txID`. The two spellings differ by casing and by
- * position: a node answers `txid`, while a wallet library that echoes the
- * transaction it broadcast carries `txID` inside it. Accepting only the first
- * would report an accepted broadcast as a failure whenever the caller is one of
- * those libraries.
- *
- * @param payload - the parsed `/wallet/broadcasttransaction` response
- * @returns the transaction identifier, or null when the broadcast was refused
- */
 export const readBroadcastResponse = (payload) => {
     const body = asRecord(payload);
     if (body === null || body.result !== true) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gibs/bridge-sdk",
-  "version": "1.19.0",
+  "version": "1.20.0",
   "description": "Build and price cross-chain transfers between PulseChain, Ethereum, and Binance Smart Chain.",
   "keywords": [
     "ethereum",
@@ -1007,8 +1007,8 @@
     "test:live:near-intents": "../../scripts/near-intents-live.sh"
   },
   "dependencies": {
-    "@gibs/abis": "^1.19.0",
-    "@gibs/common": "^1.19.0",
+    "@gibs/abis": "^1.20.0",
+    "@gibs/common": "^1.20.0",
     "@ton/core": "^0.63.1",
     "@ton/crypto": "^3.3.0"
   },