@gibs/bridge-sdk 1.10.1 → 1.12.0

package/src/types.ts

@@ -1,48 +1,48 @@
-import type { Hex, Chain } from 'viem'
-import type { Chains, Provider } from './config.js'
+import type { Chain, Hex } from 'viem';
+import type { Chains, Provider } from './config.js';
 
 /** The per network bridge link */
 export type PerNetworkBridgeLink = {
-  tokenAddress: Hex
-}
+  tokenAddress: Hex;
+};
 /** The extensions for a token */
 export type Extensions = {
-  wrapped?: { address: Hex }
-  bridgeInfo?: Record<number, PerNetworkBridgeLink>
-}
+  wrapped?: { address: Hex };
+  bridgeInfo?: Record<number, PerNetworkBridgeLink>;
+};
 
 /** The metadata for a token */
 export type TokenMetadata = {
-  name: string
-  symbol: string
-  decimals: number
-}
+  name: string;
+  symbol: string;
+  decimals: number;
+};
 
 /** The token for a given asset */
 export type Token = TokenMetadata & {
-  address: string
-  chainId: number
-  logoURI: string | null
-  extensions?: Extensions
-}
+  address: string;
+  chainId: number;
+  logoURI: string | null;
+  extensions?: Extensions;
+};
 
 /** The token out for a given asset */
-export type TokenOut = Omit<Token, 'address'> & { address: string | null }
+export type TokenOut = Omit<Token, 'address'> & { address: string | null };
 
 /** The token list for a given asset */
 export type TokenList = {
-  tokens: Token[]
-}
+  tokens: Token[];
+};
 
 /** The bridge key for a given provider, from chain, and to chain */
-export type BridgeKey = [Provider, Chains, Chains]
+export type BridgeKey = [Provider, Chains, Chains];
 
 /** The visual chain for a given chain */
 export type VisualChain = Chain & {
-  chainId: Chains
-  logoURI: string
-  alt: string
-}
+  chainId: Chains;
+  logoURI: string;
+  alt: string;
+};
 
 /** The metadata for a chain */
-export type ChainsMetadata = Record<Chains, VisualChain>
+export type ChainsMetadata = Record<Chains, VisualChain>;

package/tsconfig.json

@@ -12,5 +12,6 @@
     "moduleDetection": "force",
     "moduleResolution": "nodenext"
   },
-  "include": ["src/**/*.ts", "src/**/*.js"]
+  "include": ["src/**/*.ts", "src/**/*.js"],
+  "exclude": ["src/**/*.test.ts", "src/**/*.spec.ts"]
 }

package/vitest.config.ts

@@ -0,0 +1,13 @@
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  test: {
+    globals: true,
+    environment: 'node',
+    coverage: {
+      provider: 'v8',
+      reporter: ['text', 'json', 'html'],
+      exclude: ['node_modules/**', 'dist/**', '**/*.config.ts', '**/*.d.ts'],
+    },
+  },
+});

package/dist/src/abis.d.ts

@@ -1,384 +0,0 @@
-/** the abi for the input bridge */
-export declare const inputBridge: readonly [{
-    readonly name: "minPerTx";
-    readonly type: "function";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [{
-        readonly type: "address";
-        readonly name: "token";
-    }];
-    readonly outputs: readonly [{
-        readonly type: "uint256";
-    }];
-}, {
-    readonly name: "foreignTokenAddress";
-    readonly type: "function";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [{
-        readonly type: "address";
-        readonly name: "token";
-    }];
-    readonly outputs: readonly [{
-        readonly type: "address";
-    }];
-}, {
-    readonly name: "homeTokenAddress";
-    readonly type: "function";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [{
-        readonly type: "address";
-        readonly name: "token";
-    }];
-    readonly outputs: readonly [{
-        readonly type: "address";
-    }];
-}, {
-    readonly name: "bridgedTokenAddress";
-    readonly type: "function";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [{
-        readonly type: "address";
-        readonly name: "token";
-    }];
-    readonly outputs: readonly [{
-        readonly type: "address";
-    }];
-}, {
-    readonly name: "nativeTokenAddress";
-    readonly type: "function";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [{
-        readonly type: "address";
-        readonly name: "token";
-    }];
-    readonly outputs: readonly [{
-        readonly type: "address";
-    }];
-}, {
-    readonly name: "feeManager";
-    readonly type: "function";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [];
-    readonly outputs: readonly [{
-        readonly type: "address";
-    }];
-}, {
-    readonly name: "relayTokensAndCall";
-    readonly type: "function";
-    readonly stateMutability: "nonpayable";
-    readonly inputs: readonly [{
-        readonly type: "address";
-        readonly name: "token";
-    }, {
-        readonly type: "address";
-        readonly name: "_receiver";
-    }, {
-        readonly type: "uint256";
-        readonly name: "_value";
-    }, {
-        readonly type: "bytes";
-        readonly name: "_data";
-    }];
-    readonly outputs: readonly [];
-}, {
-    readonly name: "relayTokens";
-    readonly type: "function";
-    readonly stateMutability: "nonpayable";
-    readonly inputs: readonly [{
-        readonly type: "address";
-        readonly name: "token";
-    }, {
-        readonly type: "address";
-        readonly name: "_receiver";
-    }, {
-        readonly type: "uint256";
-        readonly name: "_value";
-    }];
-    readonly outputs: readonly [];
-}];
-/** the abi for the input bridge with extra input for the sender origin (tokensex) */
-export declare const inputBridgeExtraInput: readonly [{
-    readonly name: "relayTokensAndCall";
-    readonly type: "function";
-    readonly stateMutability: "nonpayable";
-    readonly inputs: readonly [{
-        readonly type: "address";
-        readonly name: "token";
-    }, {
-        readonly type: "address";
-        readonly name: "_receiver";
-    }, {
-        readonly type: "uint256";
-        readonly name: "_value";
-    }, {
-        readonly type: "bytes";
-        readonly name: "_data";
-    }, {
-        readonly type: "address";
-        readonly name: "_senderOrigin";
-    }];
-    readonly outputs: readonly [];
-}, {
-    readonly name: "relayTokens";
-    readonly type: "function";
-    readonly stateMutability: "nonpayable";
-    readonly inputs: readonly [{
-        readonly type: "address";
-        readonly name: "token";
-    }, {
-        readonly type: "address";
-        readonly name: "_receiver";
-    }, {
-        readonly type: "uint256";
-        readonly name: "_value";
-    }, {
-        readonly type: "address";
-        readonly name: "_senderOrigin";
-    }];
-    readonly outputs: readonly [];
-}];
-/** the abi for erc677 tokens */
-export declare const erc677: readonly [{
-    readonly name: "transferAndCall";
-    readonly type: "function";
-    readonly stateMutability: "nonpayable";
-    readonly inputs: readonly [{
-        readonly type: "address";
-    }, {
-        readonly type: "uint256";
-    }, {
-        readonly type: "bytes";
-    }];
-    readonly outputs: readonly [];
-}];
-/** the abi for erc677 tokens bridge with extra input for the sender origin (tokensex) */
-export declare const erc677ExtraInput: readonly [{
-    readonly name: "transferAndCall";
-    readonly type: "function";
-    readonly stateMutability: "nonpayable";
-    readonly inputs: readonly [{
-        readonly type: "address";
-    }, {
-        readonly type: "uint256";
-    }, {
-        readonly type: "bytes";
-    }, {
-        readonly type: "address";
-        readonly name: "sender";
-    }];
-    readonly outputs: readonly [];
-}];
-/** the abi to read data from the output router */
-export declare const outputRouter: readonly [{
-    readonly name: "onTokenBridged";
-    readonly type: "function";
-    readonly stateMutability: "payable";
-    readonly inputs: readonly [{
-        readonly type: "address";
-        readonly name: "_token";
-    }, {
-        readonly type: "uint256";
-        readonly name: "_value";
-    }, {
-        readonly type: "bytes";
-        readonly name: "_data";
-    }];
-    readonly outputs: readonly [];
-}, {
-    readonly name: "WETH";
-    readonly type: "function";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [];
-    readonly outputs: readonly [{
-        readonly type: "address";
-    }];
-}, {
-    readonly name: "bridge";
-    readonly type: "function";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [];
-    readonly outputs: readonly [{
-        readonly type: "address";
-    }];
-}, {
-    readonly name: "safeExecuteSignaturesWithAutoGasLimit";
-    readonly type: "function";
-    readonly stateMutability: "payable";
-    readonly inputs: readonly [{
-        readonly type: "address";
-        readonly name: "runner";
-    }, {
-        readonly type: "bytes";
-        readonly name: "_data";
-    }, {
-        readonly type: "bytes";
-        readonly name: "_signatures";
-    }];
-    readonly outputs: readonly [];
-}];
-/** the abi for the output bridge */
-export declare const outputBridge: readonly [{
-    readonly name: "bridgeContract";
-    readonly type: "function";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [];
-    readonly outputs: readonly [{
-        readonly type: "address";
-    }];
-}];
-/** the abi for the fee manager */
-export declare const feeManager: readonly [{
-    readonly name: "HOME_TO_FOREIGN_FEE";
-    readonly type: "function";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [];
-    readonly outputs: readonly [{
-        readonly type: "bytes32";
-    }];
-}, {
-    readonly name: "FOREIGN_TO_HOME_FEE";
-    readonly type: "function";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [];
-    readonly outputs: readonly [{
-        readonly type: "bytes32";
-    }];
-}, {
-    readonly name: "getFee";
-    readonly type: "function";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [{
-        readonly type: "bytes32";
-    }, {
-        readonly type: "address";
-    }];
-    readonly outputs: readonly [{
-        readonly type: "uint256";
-    }];
-}];
-/** the abi for the native router */
-export declare const nativeRouter: readonly [{
-    readonly name: "wrapAndRelayTokens";
-    readonly type: "function";
-    readonly stateMutability: "payable";
-    readonly inputs: readonly [{
-        readonly type: "address";
-        readonly name: "receiver";
-    }];
-    readonly outputs: readonly [];
-}, {
-    readonly name: "relayTokensAndCall";
-    readonly type: "function";
-    readonly stateMutability: "payable";
-    readonly inputs: readonly [{
-        readonly type: "address";
-        readonly name: "receiver";
-    }, {
-        readonly type: "bytes";
-        readonly name: "data";
-    }];
-    readonly outputs: readonly [];
-}];
-/** the abi for the native router with extra input for the sender origin (tokensex) */
-export declare const nativeRouterExtraInput: readonly [{
-    readonly name: "wrapAndRelayTokens";
-    readonly type: "function";
-    readonly stateMutability: "payable";
-    readonly inputs: readonly [{
-        readonly type: "address";
-        readonly name: "receiver";
-    }, {
-        readonly type: "address";
-        readonly name: "sender";
-    }];
-    readonly outputs: readonly [];
-}, {
-    readonly name: "relayTokensAndCall";
-    readonly type: "function";
-    readonly stateMutability: "payable";
-    readonly inputs: readonly [{
-        readonly type: "address";
-        readonly name: "receiver";
-    }, {
-        readonly type: "bytes";
-        readonly name: "data";
-    }, {
-        readonly type: "address";
-        readonly name: "sender";
-    }];
-    readonly outputs: readonly [];
-}];
-/** the abi for the univ2 router */
-export declare const univ2Router: readonly [{
-    readonly name: "getAmountsOut";
-    readonly type: "function";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [{
-        readonly type: "uint256";
-        readonly name: "amountIn";
-    }, {
-        readonly type: "address[]";
-        readonly name: "path";
-    }];
-    readonly outputs: readonly [{
-        readonly type: "uint256[]";
-    }];
-}];
-/** the abi for the fee delivery struct */
-export declare const feeDeliveryStruct: readonly [{
-    readonly type: "tuple";
-    readonly components: readonly [{
-        readonly type: "address";
-    }, {
-        readonly type: "uint256";
-    }, {
-        readonly type: "uint256";
-    }, {
-        readonly type: "uint256";
-    }];
-}];
-/** the abi for the relay tokens direct */
-export declare const relayTokensDirect: readonly [{
-    readonly name: "safeExecuteSignaturesWithAutoGasLimit";
-    readonly type: "function";
-    readonly stateMutability: "nonpayable";
-    readonly inputs: readonly [{
-        readonly type: "bytes";
-        readonly name: "data";
-    }, {
-        readonly type: "bytes";
-        readonly name: "signatures";
-    }];
-    readonly outputs: readonly [];
-}];
-/** the abi for the home amb */
-export declare const homeAmb: readonly [{
-    readonly name: "submitSignature";
-    readonly type: "function";
-    readonly stateMutability: "nonpayable";
-    readonly inputs: readonly [{
-        readonly type: "bytes";
-        readonly name: "message";
-    }, {
-        readonly type: "bytes";
-        readonly name: "signature";
-    }];
-    readonly outputs: readonly [];
-}];
-/** the abi for the univ2 pair */
-export declare const pair: readonly [{
-    readonly name: "getReserves";
-    readonly type: "function";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [];
-    readonly outputs: readonly [{
-        readonly type: "uint112";
-        readonly name: "reserve0";
-    }, {
-        readonly type: "uint112";
-        readonly name: "reserve1";
-    }, {
-        readonly type: "uint32";
-        readonly name: "blockTimestampLast";
-    }];
-}];

package/dist/src/abis.js

@@ -1,68 +0,0 @@
-import { parseAbi, parseAbiParameters } from 'viem';
-/** the abi for the input bridge */
-export const inputBridge = parseAbi([
-    'function minPerTx(address token) external view returns(uint256)',
-    'function foreignTokenAddress(address token) external view returns(address)',
-    'function homeTokenAddress(address token) external view returns(address)',
-    'function bridgedTokenAddress(address token) external view returns(address)',
-    'function nativeTokenAddress(address token) external view returns(address)',
-    'function feeManager() external view returns(address)',
-    'function relayTokensAndCall(address token, address _receiver, uint256 _value, bytes memory _data) external',
-    'function relayTokens(address token, address _receiver, uint256 _value) external',
-]);
-/** the abi for the input bridge with extra input for the sender origin (tokensex) */
-export const inputBridgeExtraInput = parseAbi([
-    'function relayTokensAndCall(address token, address _receiver, uint256 _value, bytes memory _data, address _senderOrigin) external',
-    'function relayTokens(address token, address _receiver, uint256 _value, address _senderOrigin) external',
-]);
-/** the abi for erc677 tokens */
-export const erc677 = parseAbi([
-    'function transferAndCall(address, uint256, bytes calldata) external',
-]);
-/** the abi for erc677 tokens bridge with extra input for the sender origin (tokensex) */
-export const erc677ExtraInput = parseAbi([
-    'function transferAndCall(address, uint256, bytes calldata, address sender) external',
-]);
-/** the abi to read data from the output router */
-export const outputRouter = parseAbi([
-    'function onTokenBridged(address _token, uint256 _value, bytes memory _data) external payable',
-    'function WETH() external view returns(address)',
-    'function bridge() external view returns(address)',
-    'function safeExecuteSignaturesWithAutoGasLimit(address runner,bytes calldata _data,bytes calldata _signatures) external payable',
-]);
-/** the abi for the output bridge */
-export const outputBridge = parseAbi(['function bridgeContract() external view returns(address)']);
-/** the abi for the fee manager */
-export const feeManager = parseAbi([
-    'function HOME_TO_FOREIGN_FEE() public view returns(bytes32)',
-    'function FOREIGN_TO_HOME_FEE() public view returns(bytes32)',
-    'function getFee(bytes32, address) public view returns(uint256)',
-]);
-/** the abi for the native router */
-export const nativeRouter = parseAbi([
-    'function wrapAndRelayTokens(address receiver) external payable',
-    'function relayTokensAndCall(address receiver, bytes calldata data) external payable',
-]);
-/** the abi for the native router with extra input for the sender origin (tokensex) */
-export const nativeRouterExtraInput = parseAbi([
-    'function wrapAndRelayTokens(address receiver, address sender) external payable',
-    'function relayTokensAndCall(address receiver, bytes calldata data, address sender) external payable',
-]);
-/** the abi for the univ2 router */
-export const univ2Router = parseAbi([
-    'function getAmountsOut(uint256 amountIn, address[] calldata path) external view returns(uint256[] memory)',
-]);
-/** the abi for the fee delivery struct */
-export const feeDeliveryStruct = parseAbiParameters('(address, uint256, uint256, uint256)');
-/** the abi for the relay tokens direct */
-export const relayTokensDirect = parseAbi([
-    'function safeExecuteSignaturesWithAutoGasLimit(bytes calldata data, bytes calldata signatures) external',
-]);
-/** the abi for the home amb */
-export const homeAmb = parseAbi([
-    'function submitSignature(bytes message, bytes signature) external',
-]);
-/** the abi for the univ2 pair */
-export const pair = parseAbi([
-    'function getReserves() view returns (uint112 reserve0, uint112 reserve1, uint32 blockTimestampLast)',
-]);

package/dist/src/chain-info.d.ts

@@ -1,130 +0,0 @@
-import { type Hex, type PublicClient } from "viem";
-import { Chains, type Pathway } from "./config.js";
-import type { BridgeKey, Token } from "./types.js";
-import _ from "lodash";
-export type TokenBridgeInfo = {
-    originationChainId: Chains;
-    assetInAddress: Hex;
-    assetOutAddress: Hex | null;
-    toForeign?: {
-        home: Hex;
-        foreign: Hex | null;
-    };
-    toHome?: {
-        home: Hex | null;
-        foreign: Hex;
-    };
-};
-/**
- * Returns the bridged token address and native token address
- * @param chainId - the chain id being targeted
- * @param target - the target
- * @param address - the address
- * @param client - the client
- * @returns the bridged token address and native token address
- */
-export declare const links: (({ chainId, target, address, client }: {
-    chainId: number;
-    target: Hex;
-    address: Hex;
-    client: PublicClient;
-}) => Promise<[`0x${string}`, `0x${string}`]>) & _.MemoizedFunction;
-/**
- * Returns the token bridge info for the given bridge key, asset in, is prod, from chain client, and to chain client
- * @param bridgeKey - the bridge key
- * @param assetIn - the asset in
- * @param isProd - whether to use the production pathway
- * @param fromChainClient - the from chain client
- * @param toChainClient - the to chain client
- * @returns the token bridge info
- */
-export declare const tokenBridgeInfo: ({ bridgeKey, assetIn, isProd, fromChainClient, toChainClient, }: {
-    bridgeKey: BridgeKey;
-    assetIn: Token | null;
-    isProd: boolean;
-    fromChainClient: PublicClient;
-    toChainClient: PublicClient;
-}) => Promise<null | TokenBridgeInfo>;
-/** The result of reading the amount out from a router */
-export type FetchResult = bigint[] | Hex;
-/**
- * Fetch the price corrective for the given bridge key, asset out, measurement token, from chain client, to chain client, asset link, amount in, and is prod
- * @param bridgeKeyPartner - the bridge key partner
- * @param assetOut - the asset out
- * @param measurementToken - the measurement token
- * @param fromChainClient - the from chain client
- * @param toChainClient - the to chain client
- * @param assetLink - the asset link
- * @param amountIn - the amount in
- * @param isProd - whether to use the production pathway
- * @returns the price corrective
- */
-export declare const fetchPriceCorrective: ({ bridgeKeyPartner, assetOut, measurementToken, fromChainClient, toChainClient, assetLink, amountIn, isProd, }: {
-    bridgeKey: BridgeKey;
-    bridgeKeyPartner: BridgeKey;
-    measurementToken: Hex;
-    assetOut: Token;
-    fromChainClient: PublicClient;
-    toChainClient: PublicClient;
-    assetLink: TokenBridgeInfo;
-    amountIn: bigint;
-    isProd: boolean;
-}) => {
-    getPaymentToken: () => Promise<TokenBridgeInfo | null>;
-    getSwapResults: ({ paymentTokenResult, chain, uniV2Router, client, }: {
-        paymentTokenResult: TokenBridgeInfo;
-        chain: Chains;
-        client: PublicClient;
-        uniV2Router?: Hex;
-    }) => Promise<[FetchResult[], FetchResult[]]>;
-    reduceResults: ({ results, oneToken, }: {
-        results: [FetchResult[], ...[FetchResult[]]];
-        oneToken: bigint;
-    }) => bigint;
-};
-/**
- * Fetch the minimum bridge amount in for the given asset in, pathway, from public client, and to public client
- * @param assetIn - the asset in
- * @param pathway - the pathway
- * @param fromPublicClient - the from public client
- * @param toPublicClient - the to public client
- * @returns the minimum bridge amount in
- */
-export declare const minBridgeAmountIn: ({ assetIn, pathway, fromPublicClient, toPublicClient, }: {
-    assetIn: Token;
-    pathway: Pathway;
-    fromPublicClient: PublicClient;
-    toPublicClient: PublicClient;
-}) => Promise<bigint>;
-/** get the symbol of the native asset, unwrap it if it needs to be */
-export declare const nativeSymbol: (asset: {
-    address: string;
-    symbol: string;
-    chainId: number;
-} | null, unwrap?: boolean) => string;
-/** The input for loading the bridge fees */
-export type InputLoadFeeFor = {
-    pathway: Pathway;
-    fromChainClient: PublicClient;
-    toChainClient: PublicClient;
-};
-/** The fee configuration for a given pathway */
-export type PathwayExtendableConfig = {
-    feeManager: Hex;
-    feeH2F: bigint;
-    feeF2H: bigint;
-};
-/**
- * Returns the chain multicall for the given client
- * @param client - the client
- * @returns the chain multicall
- */
-export declare const chainMulticall: (client: PublicClient) => any;
-/**
- * Load the bridge fees for the given pathway, from chain client, and to chain client
- * @param pathway - the pathway
- * @param fromChainClient - the from chain client
- * @param toChainClient - the to chain client
- * @returns the bridge fees
- */
-export declare const loadBridgeFees: ({ pathway, fromChainClient, toChainClient }: InputLoadFeeFor) => Promise<PathwayExtendableConfig>;