@gibs/bridge-sdk 1.6.27 → 1.6.34

package/README.md

@@ -0,0 +1,23 @@
+# Bridge Sdk
+
+tooling to help facilitate briding over omnibridges and apply a price to delivery
+
+these are low level tools so they will have to be put together carefully
+
+they are also in beta stages of development so things may simply change version to version
+
+to make things easier, versions are synced across packages
+
+## install
+```sh
+npm i --save @gibs/bridge-sdk
+```
+
+## usage
+
+```ts
+// global import
+import * as bridgeSDK from '@gibs/bridge-sdk'
+// or by file
+import * as abis from '@gibs/bridge-sdk/abis'
+```

package/dist/src/abis.d.ts

@@ -0,0 +1,356 @@
+/** the abi for the 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 [];
+}];
+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 [];
+}];
+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 [];
+}];
+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 [];
+}];
+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";
+    }];
+}];
+export declare const outputBridge: readonly [{
+    readonly name: "bridgeContract";
+    readonly type: "function";
+    readonly stateMutability: "view";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly type: "address";
+    }];
+}];
+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";
+    }];
+}];
+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 [];
+}];
+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 [];
+}];
+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[]";
+    }];
+}];
+export declare const feeDeliveryStruct: readonly [{
+    readonly type: "tuple";
+    readonly components: readonly [{
+        readonly type: "address";
+    }, {
+        readonly type: "uint256";
+    }, {
+        readonly type: "uint256";
+    }, {
+        readonly type: "uint256";
+    }];
+}];
+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 [];
+}];
+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 [];
+}];
+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

@@ -0,0 +1,54 @@
+import { parseAbi, parseAbiParameters } from 'viem';
+/** the abi for the 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',
+]);
+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',
+]);
+export const erc677 = parseAbi([
+    'function transferAndCall(address, uint256, bytes calldata) external',
+]);
+export const erc677ExtraInput = parseAbi([
+    'function transferAndCall(address, uint256, bytes calldata, address sender) external',
+]);
+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)',
+]);
+export const outputBridge = parseAbi(['function bridgeContract() external view returns(address)']);
+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)',
+]);
+export const nativeRouter = parseAbi([
+    'function wrapAndRelayTokens(address receiver) external payable',
+    'function relayTokensAndCall(address receiver, bytes calldata data) external payable',
+]);
+export const nativeRouterExtraInput = parseAbi([
+    'function wrapAndRelayTokens(address receiver, address sender) external payable',
+    'function relayTokensAndCall(address receiver, bytes calldata data, address sender) external payable',
+]);
+export const univ2Router = parseAbi([
+    'function getAmountsOut(uint256 amountIn, address[] calldata path) external view returns(uint256[] memory)',
+]);
+export const feeDeliveryStruct = parseAbiParameters('(address, uint256, uint256, uint256)');
+export const relayTokensDirect = parseAbi([
+    'function safeExecuteSignaturesWithAutoGasLimit(bytes calldata data, bytes calldata signatures) external',
+]);
+export const homeAmb = parseAbi([
+    'function submitSignature(bytes message, bytes signature) external',
+]);
+export const pair = parseAbi([
+    'function getReserves() view returns (uint112 reserve0, uint112 reserve1, uint32 blockTimestampLast)',
+]);

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

@@ -0,0 +1,78 @@
+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;
+    };
+};
+export declare const links: (({ chainId, target, address, client }: {
+    chainId: number;
+    target: Hex;
+    address: Hex;
+    client: PublicClient;
+}) => Promise<`0x${string}`[]>) & _.MemoizedFunction;
+export declare const tokenBridgeInfo: ({ bridgeKey, assetIn, isProd, fromChainClient, toChainClient, }: {
+    bridgeKey: BridgeKey;
+    assetIn: Token | null;
+    isProd: boolean;
+    fromChainClient: PublicClient;
+    toChainClient: PublicClient;
+}) => Promise<null | TokenBridgeInfo>;
+export type FetchResult = bigint[] | Hex;
+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;
+};
+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: Hex;
+    symbol: string;
+    chainId: number;
+} | null, unwrap?: boolean) => string;
+export type InputLoadFeeFor = {
+    pathway: Pathway;
+    fromChainClient: PublicClient;
+    toChainClient: PublicClient;
+};
+export type PathwayExtendableConfig = {
+    feeManager: Hex;
+    feeH2F: bigint;
+    feeF2H: bigint;
+};
+export declare const chainMulticall: (client: PublicClient) => any;
+export declare const loadBridgeFees: ({ pathway, fromChainClient, toChainClient }: InputLoadFeeFor) => Promise<PathwayExtendableConfig>;