@katanaperps/katana-perps-sdk 0.0.0-placeholder

package/dist/bridge/utils.d.ts

@@ -0,0 +1,140 @@
+import type { BridgeTarget } from '#types/enums/request';
+export declare const BridgeMainnetLayerZeroEndpointIds: (30362 | 30110 | 30211 | 30106 | 30184 | 30102 | 30101 | 30111 | 30235 | 30214 | 30290)[];
+export type BridgeLayerZeroEndpointIdsMainnet = (typeof BridgeMainnetLayerZeroEndpointIds)[number];
+export declare function isBridgeMainnetLayerZeroEndpointId(layerZeroEndpointId: number): layerZeroEndpointId is BridgeLayerZeroEndpointIdsMainnet;
+export declare const BridgeTestnetLayerZeroEndpointIds: (40161 | 40231)[];
+export type BridgeLayerZeroEndpointIdsTestnet = (typeof BridgeTestnetLayerZeroEndpointIds)[number];
+export declare function isBridgeTestnetLayerZeroEndpointId(layerZeroEndpointId: number): layerZeroEndpointId is BridgeLayerZeroEndpointIdsTestnet;
+/**
+ * Get a bridge config with strict typing to allow narrowing on the
+ * `config.supported` boolean
+ *
+ * @example
+ * ```typescript
+ * const config = getBridgeTargetConfig(BridgeTarget.STARGATE_ARBITRUM, true);
+ * ```
+ */
+export declare function getBridgeTargetConfig<T extends BridgeTarget, S extends true | false>(bridgeTarget: T, sandbox: S): {
+    readonly target: "katana.katana";
+    readonly isSupported: true;
+    readonly evmChainId: 64002;
+    readonly layerZeroEndpointId: 40282;
+    readonly layerzeroOFTAddress: "0x54a04EfABCBd81A0488E4a9Ad22264E04A48329B";
+    readonly tokenDecimals: 6;
+    readonly usdcAddress: "0x54a04EfABCBd81A0488E4a9Ad22264E04A48329B";
+} | {
+    readonly target: "stargate.berachain";
+    readonly evmChainId: 11155111;
+    readonly layerZeroEndpointId: 40161;
+    readonly layerzeroOFTAddress: "0x21F1caDDBED3Cd50e6B30644459BFB80c367076c";
+    readonly tokenDecimals: 6;
+    readonly usdcAddress: "0x2F6F07CDcf3588944Bf4C42aC74ff24bF56e7590";
+} | {
+    readonly target: "stargate.arbitrum";
+    readonly evmChainId: 421614;
+    readonly layerZeroEndpointId: 40231;
+    readonly layerzeroOFTAddress: "0x543BdA7c6cA4384FE90B1F5929bb851F52888983";
+    readonly tokenDecimals: 6;
+    readonly usdcAddress: "0x3253a335E7bFfB4790Aa4C25C4250d206E9b9773";
+} | {
+    readonly "katana.katana": {
+        readonly target: "katana.katana";
+        readonly evmChainId: 747474;
+        readonly layerZeroEndpointId: 30375;
+        readonly layerzeroOFTAddress: "0x0000000000000000000000000000000000000000";
+        readonly tokenDecimals: 6;
+        readonly usdcAddress: "0x203a662b0bd271a6ed5a60edfbd04bfce608fd36";
+    };
+    readonly "stargate.berachain": {
+        readonly target: "stargate.berachain";
+        readonly evmChainId: 80094;
+        readonly layerZeroEndpointId: 30362;
+        readonly layerzeroOFTAddress: "0xAF54BE5B6eEc24d6BFACf1cce4eaF680A8239398";
+        readonly tokenDecimals: 6;
+        readonly usdcAddress: "0x549943e04f40284185054145c6E4e9568C1D3241";
+    };
+    readonly "stargate.arbitrum": {
+        readonly target: "stargate.arbitrum";
+        readonly evmChainId: 42161;
+        readonly layerZeroEndpointId: 30110;
+        readonly layerzeroOFTAddress: "0xe8CDF27AcD73a434D661C84887215F7598e7d0d3";
+        readonly tokenDecimals: 6;
+        readonly usdcAddress: "0xaf88d065e77c8cC2239327C5EDb3A432268e5831";
+    };
+    readonly "stargate.aurora": {
+        readonly target: "stargate.aurora";
+        readonly evmChainId: 1313161554;
+        readonly layerZeroEndpointId: 30211;
+        readonly layerzeroOFTAddress: "0x81F6138153d473E8c5EcebD3DC8Cd4903506B075";
+        readonly tokenDecimals: 6;
+        readonly usdcAddress: "0x368EBb46ACa6b8D0787C96B2b20bD3CC3F2c45F7";
+    };
+    readonly "stargate.avalanche": {
+        readonly target: "stargate.avalanche";
+        readonly evmChainId: 43114;
+        readonly layerZeroEndpointId: 30106;
+        readonly layerzeroOFTAddress: "0x5634c4a5FEd09819E3c46D86A965Dd9447d86e47";
+        readonly tokenDecimals: 6;
+        readonly usdcAddress: "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E";
+    };
+    readonly "stargate.base": {
+        readonly target: "stargate.base";
+        readonly evmChainId: 8453;
+        readonly layerZeroEndpointId: 30184;
+        readonly layerzeroOFTAddress: "0x27a16dc786820B16E5c9028b75B99F6f604b5d26";
+        readonly tokenDecimals: 6;
+        readonly usdcAddress: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913";
+    };
+    readonly "stargate.bnb": {
+        readonly target: "stargate.bnb";
+        readonly evmChainId: 56;
+        readonly layerZeroEndpointId: 30102;
+        readonly layerzeroOFTAddress: "0x962Bd449E630b0d928f308Ce63f1A21F02576057";
+        readonly tokenDecimals: 18;
+        readonly usdcAddress: "0x8AC76a51cc950d9822D68b83fE1Ad97B32Cd580d";
+    };
+    readonly "stargate.ethereum": {
+        readonly target: "stargate.ethereum";
+        readonly evmChainId: 1;
+        readonly layerZeroEndpointId: 30101;
+        readonly layerzeroOFTAddress: "0xc026395860Db2d07ee33e05fE50ed7bD583189C7";
+        readonly tokenDecimals: 6;
+        readonly usdcAddress: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48";
+    };
+    readonly "stargate.optimism": {
+        readonly target: "stargate.optimism";
+        readonly evmChainId: 10;
+        readonly layerZeroEndpointId: 30111;
+        readonly layerzeroOFTAddress: "0xcE8CcA271Ebc0533920C83d39F417ED6A0abB7D0";
+        readonly tokenDecimals: 6;
+        readonly usdcAddress: "0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85";
+    };
+    readonly "stargate.rari": {
+        readonly target: "stargate.rari";
+        readonly evmChainId: 1380012617;
+        readonly layerZeroEndpointId: 30235;
+        readonly layerzeroOFTAddress: "0x875bee36739e7Ce6b60E056451c556a88c59b086";
+        readonly tokenDecimals: 6;
+        readonly usdcAddress: "0xFbDa5F676cB37624f28265A144A48B0d6e87d3b6";
+    };
+    readonly "stargate.scroll": {
+        readonly target: "stargate.scroll";
+        readonly evmChainId: 534352;
+        readonly layerZeroEndpointId: 30214;
+        readonly layerzeroOFTAddress: "0x3Fc69CC4A842838bCDC9499178740226062b14E4";
+        readonly tokenDecimals: 6;
+        readonly usdcAddress: "0x06eFdBFf2a14a7c8E15944D1F4A48F9F95F663A4";
+    };
+    readonly "stargate.taiko": {
+        readonly target: "stargate.taiko";
+        readonly evmChainId: 167000;
+        readonly layerZeroEndpointId: 30290;
+        readonly layerzeroOFTAddress: "0x77C71633C34C3784ede189d74223122422492a0f";
+        readonly tokenDecimals: 6;
+        readonly usdcAddress: "0x19e26B0638bf63aa9fa4d14c6baF8D52eBE86C5C";
+    };
+}[T];
+export declare function bridgeTargetForLayerZeroEndpointId(layerZeroEndpointId: number, sandbox: boolean): "stargate.berachain" | "stargate.arbitrum" | "stargate.aurora" | "stargate.avalanche" | "stargate.base" | "stargate.bnb" | "stargate.ethereum" | "stargate.optimism" | "stargate.rari" | "stargate.scroll" | "stargate.taiko" | null;
+export declare function loadExchangeLayerZeroAddressFromApiIfNeeded(exchangeLayerZeroAdapterAddress?: string): Promise<string>;
+export declare function loadStargateBridgeForwarderContractAddressFromApiIfNeeded(stargateBridgeForwarderContractAddress?: string): Promise<string>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/bridge/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/bridge/utils.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEzD,eAAO,MAAM,iCAAiC,2FAI5C,CAAC;AAEH,MAAM,MAAM,iCAAiC,GAC3C,CAAC,OAAO,iCAAiC,CAAC,CAAC,MAAM,CAAC,CAAC;AAErD,wBAAgB,kCAAkC,CAChD,mBAAmB,EAAE,MAAM,GAC1B,mBAAmB,IAAI,iCAAiC,CAI1D;AAED,eAAO,MAAM,iCAAiC,mBAI5C,CAAC;AAEH,MAAM,MAAM,iCAAiC,GAC3C,CAAC,OAAO,iCAAiC,CAAC,CAAC,MAAM,CAAC,CAAC;AAErD,wBAAgB,kCAAkC,CAChD,mBAAmB,EAAE,MAAM,GAC1B,mBAAmB,IAAI,iCAAiC,CAI1D;AAED;;;;;;;;GAQG;AACH,wBAAgB,qBAAqB,CACnC,CAAC,SAAS,YAAY,EACtB,CAAC,SAAS,IAAI,GAAG,KAAK,EACtB,YAAY,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAY5B;AAED,wBAAgB,kCAAkC,CAChD,mBAAmB,EAAE,MAAM,EAC3B,OAAO,EAAE,OAAO,wOAYjB;AAED,wBAAsB,2CAA2C,CAC/D,+BAA+B,CAAC,EAAE,MAAM,GACvC,OAAO,CAAC,MAAM,CAAC,CAOjB;AAED,wBAAsB,yDAAyD,CAC7E,sCAAsC,CAAC,EAAE,MAAM,GAC9C,OAAO,CAAC,MAAM,CAAC,CAOjB"}

package/dist/bridge/utils.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadStargateBridgeForwarderContractAddressFromApiIfNeeded = exports.loadExchangeLayerZeroAddressFromApiIfNeeded = exports.bridgeTargetForLayerZeroEndpointId = exports.getBridgeTargetConfig = exports.isBridgeTestnetLayerZeroEndpointId = exports.BridgeTestnetLayerZeroEndpointIds = exports.isBridgeMainnetLayerZeroEndpointId = exports.BridgeMainnetLayerZeroEndpointIds = void 0;
+const ethers_1 = require("ethers");
+const config_1 = require("#bridge/config");
+exports.BridgeMainnetLayerZeroEndpointIds = Object.values(config_1.BridgeConfigByLayerZeroEndpointId.mainnet).map((value) => {
+    return value.layerZeroEndpointId;
+});
+function isBridgeMainnetLayerZeroEndpointId(layerZeroEndpointId) {
+    return exports.BridgeMainnetLayerZeroEndpointIds.includes(layerZeroEndpointId);
+}
+exports.isBridgeMainnetLayerZeroEndpointId = isBridgeMainnetLayerZeroEndpointId;
+exports.BridgeTestnetLayerZeroEndpointIds = Object.values(config_1.BridgeConfigByLayerZeroEndpointId.testnet).map((value) => {
+    return value.layerZeroEndpointId;
+});
+function isBridgeTestnetLayerZeroEndpointId(layerZeroEndpointId) {
+    return exports.BridgeTestnetLayerZeroEndpointIds.includes(layerZeroEndpointId);
+}
+exports.isBridgeTestnetLayerZeroEndpointId = isBridgeTestnetLayerZeroEndpointId;
+/**
+ * Get a bridge config with strict typing to allow narrowing on the
+ * `config.supported` boolean
+ *
+ * @example
+ * ```typescript
+ * const config = getBridgeTargetConfig(BridgeTarget.STARGATE_ARBITRUM, true);
+ * ```
+ */
+function getBridgeTargetConfig(bridgeTarget, sandbox) {
+    const targetConfig = sandbox ?
+        config_1.BridgeConfig.testnet[bridgeTarget]
+        : config_1.BridgeConfig.mainnet[bridgeTarget];
+    if (!targetConfig) {
+        throw new Error(`Unsupported bridge target ${bridgeTarget} ${sandbox ? 'testnet' : 'mainnet'}`);
+    }
+    return targetConfig;
+}
+exports.getBridgeTargetConfig = getBridgeTargetConfig;
+function bridgeTargetForLayerZeroEndpointId(layerZeroEndpointId, sandbox) {
+    if (sandbox && isBridgeTestnetLayerZeroEndpointId(layerZeroEndpointId)) {
+        return config_1.BridgeConfigByLayerZeroEndpointId.testnet[layerZeroEndpointId]
+            .target;
+    }
+    if (!sandbox && isBridgeMainnetLayerZeroEndpointId(layerZeroEndpointId)) {
+        return config_1.BridgeConfigByLayerZeroEndpointId.mainnet[layerZeroEndpointId]
+            .target;
+    }
+    return null;
+}
+exports.bridgeTargetForLayerZeroEndpointId = bridgeTargetForLayerZeroEndpointId;
+async function loadExchangeLayerZeroAddressFromApiIfNeeded(exchangeLayerZeroAdapterAddress) {
+    if (exchangeLayerZeroAdapterAddress) {
+        return exchangeLayerZeroAdapterAddress;
+    }
+    // No bridge adapters currently supported
+    return ethers_1.ethers.ZeroAddress;
+}
+exports.loadExchangeLayerZeroAddressFromApiIfNeeded = loadExchangeLayerZeroAddressFromApiIfNeeded;
+async function loadStargateBridgeForwarderContractAddressFromApiIfNeeded(stargateBridgeForwarderContractAddress) {
+    if (stargateBridgeForwarderContractAddress) {
+        return stargateBridgeForwarderContractAddress;
+    }
+    // No bridge adapters currently supported
+    return ethers_1.ethers.ZeroAddress;
+}
+exports.loadStargateBridgeForwarderContractAddressFromApiIfNeeded = loadStargateBridgeForwarderContractAddressFromApiIfNeeded;

package/dist/bridge/withdraw.d.ts

@@ -0,0 +1,42 @@
+import { ethers } from 'ethers';
+import { BridgeTarget } from '#types/enums/request';
+/**
+ * Decoded Bridge Payload
+ */
+export type DecodedWithdrawalBridgeAdapterPayload = {
+    layerZeroEndpointId: number;
+};
+/**
+ * Encoded withdrawal bridge payload
+ */
+export type EncodedWithdrawalBridgeAdapterPayload = string;
+export declare const withdrawalBridgeAdapterPayloadLength = 4;
+/**
+ * Decode an ABI-encoded hex string representing bridged withdrawal parameters
+ */
+export declare function decodeWithdrawalBridgeAdapterPayload(payload: EncodedWithdrawalBridgeAdapterPayload): DecodedWithdrawalBridgeAdapterPayload;
+/**
+ * ABI-encode bridged withdrawal parameters
+ */
+export declare function encodeWithdrawalBridgeAdapterPayload({ layerZeroEndpointId, }: DecodedWithdrawalBridgeAdapterPayload): EncodedWithdrawalBridgeAdapterPayload;
+/**
+ * Returns the encoded `bridgeAdapterPayload`
+ */
+export declare function getEncodedWithdrawalPayloadForBridgeTarget(bridgeTarget: BridgeTarget, sandbox?: boolean): EncodedWithdrawalBridgeAdapterPayload;
+/**
+ * Estimate the quantity of tokens delivered to the target chain via bridged withdrawal
+ */
+export declare function estimateBridgeWithdrawQuantity(parameters: {
+    exchangeLayerZeroAdapterAddress: string;
+    stargateForwarderAddress: string;
+    payload: string;
+    quantityInDecimal: string;
+}, providers: {
+    berachain: ethers.Provider;
+    katana: ethers.Provider;
+}, sandbox: boolean): Promise<{
+    estimatedWithdrawQuantityInDecimal: string;
+    minimumWithdrawQuantityInDecimal: string;
+    willSucceed: boolean;
+}>;
+//# sourceMappingURL=withdraw.d.ts.map

package/dist/bridge/withdraw.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"withdraw.d.ts","sourceRoot":"","sources":["../../src/bridge/withdraw.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAKhC,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAQpD;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,mBAAmB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qCAAqC,GAAG,MAAM,CAAC;AAE3D,eAAO,MAAM,oCAAoC,IAAI,CAAC;AAEtD;;GAEG;AACH,wBAAgB,oCAAoC,CAClD,OAAO,EAAE,qCAAqC,GAC7C,qCAAqC,CAOvC;AAED;;GAEG;AACH,wBAAgB,oCAAoC,CAAC,EACnD,mBAAmB,GACpB,EAAE,qCAAqC,GAAG,qCAAqC,CAK/E;AAED;;GAEG;AACH,wBAAgB,0CAA0C,CACxD,YAAY,EAAE,YAAY,EAC1B,OAAO,UAAQ,GACd,qCAAqC,CAMvC;AAED;;GAEG;AACH,wBAAsB,8BAA8B,CAClD,UAAU,EAAE;IACV,+BAA+B,EAAE,MAAM,CAAC;IACxC,wBAAwB,EAAE,MAAM,CAAC;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,iBAAiB,EAAE,MAAM,CAAC;CAC3B,EAED,SAAS,EAAE;IACT,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC;CACzB,EACD,OAAO,EAAE,OAAO,GACf,OAAO,CAAC;IACT,kCAAkC,EAAE,MAAM,CAAC;IAC3C,gCAAgC,EAAE,MAAM,CAAC;IACzC,WAAW,EAAE,OAAO,CAAC;CACtB,CAAC,CAsED"}

package/dist/bridge/withdraw.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.estimateBridgeWithdrawQuantity = exports.getEncodedWithdrawalPayloadForBridgeTarget = exports.encodeWithdrawalBridgeAdapterPayload = exports.decodeWithdrawalBridgeAdapterPayload = exports.withdrawalBridgeAdapterPayloadLength = void 0;
+const ethers_1 = require("ethers");
+const _pipmath_1 = require("#pipmath");
+const ExchangeLayerZeroAdapter_v3__factory_1 = require("#typechain-types/factories/ExchangeLayerZeroAdapter_v3__factory");
+const request_1 = require("#types/enums/request");
+const config_1 = require("./config");
+const utils_1 = require("./utils");
+exports.withdrawalBridgeAdapterPayloadLength = 4; // uint32(4)
+/**
+ * Decode an ABI-encoded hex string representing bridged withdrawal parameters
+ */
+function decodeWithdrawalBridgeAdapterPayload(payload) {
+    return {
+        layerZeroEndpointId: parseInt(ethers_1.ethers.AbiCoder.defaultAbiCoder().decode(['uint32'], payload)[0], 10),
+    };
+}
+exports.decodeWithdrawalBridgeAdapterPayload = decodeWithdrawalBridgeAdapterPayload;
+/**
+ * ABI-encode bridged withdrawal parameters
+ */
+function encodeWithdrawalBridgeAdapterPayload({ layerZeroEndpointId, }) {
+    return ethers_1.ethers.AbiCoder.defaultAbiCoder().encode(['uint32'], [layerZeroEndpointId]);
+}
+exports.encodeWithdrawalBridgeAdapterPayload = encodeWithdrawalBridgeAdapterPayload;
+/**
+ * Returns the encoded `bridgeAdapterPayload`
+ */
+function getEncodedWithdrawalPayloadForBridgeTarget(bridgeTarget, sandbox = false) {
+    const targetConfig = (0, utils_1.getBridgeTargetConfig)(bridgeTarget, sandbox);
+    return encodeWithdrawalBridgeAdapterPayload({
+        layerZeroEndpointId: targetConfig.layerZeroEndpointId,
+    });
+}
+exports.getEncodedWithdrawalPayloadForBridgeTarget = getEncodedWithdrawalPayloadForBridgeTarget;
+/**
+ * Estimate the quantity of tokens delivered to the target chain via bridged withdrawal
+ */
+async function estimateBridgeWithdrawQuantity(parameters, providers, sandbox) {
+    const { layerZeroEndpointId: targetEndpointId } = decodeWithdrawalBridgeAdapterPayload(parameters.payload);
+    const exchangeBridgeAdapter = ExchangeLayerZeroAdapter_v3__factory_1.ExchangeLayerZeroAdapter_v3__factory.connect(parameters.exchangeLayerZeroAdapterAddress, providers.katana);
+    const [estimatedWithdrawQuantityInAssetUnits, minimumWithdrawQuantityInAssetUnits, poolDecimals,] = await exchangeBridgeAdapter.estimateWithdrawQuantityInAssetUnits(
+    // Funds must always be withdrawn to Berachain first regardless of final target
+    (sandbox ? config_1.BridgeConfig.testnet : config_1.BridgeConfig.mainnet)[request_1.BridgeTarget.LAYERZERO_BERACHAIN].layerZeroEndpointId, (0, _pipmath_1.decimalToPip)(parameters.quantityInDecimal));
+    const estimatedWithdrawQuantityInDecimal = (0, _pipmath_1.assetUnitsToDecimal)(estimatedWithdrawQuantityInAssetUnits, Number(poolDecimals));
+    const minimumWithdrawQuantityInDecimal = (0, _pipmath_1.assetUnitsToDecimal)(minimumWithdrawQuantityInAssetUnits, Number(poolDecimals));
+    const target = (0, utils_1.bridgeTargetForLayerZeroEndpointId)(targetEndpointId, sandbox);
+    if (!target || !(0, utils_1.getBridgeTargetConfig)(target, sandbox)) {
+        throw new Error(`Unsupported Layerzero Endpoint ID ${targetEndpointId}`);
+    }
+    /*
+    // If the final target is not Berachain, an bridge tx is needed via the forwarder
+    if (target !== BridgeTarget.LAYERZERO_BERACHAIN) {
+      const stargateForwarder = StargateForwarder_v2__factory.connect(
+        parameters.stargateForwarderAddress,
+        providers.berachain,
+      );
+  
+      const [
+        estimatedForwardedQuantityInAssetUnits,
+        minimumForwardedQuantityInAssetUnits,
+        forwardedPoolDecimals,
+      ] = await stargateForwarder.loadEstimatedForwardedQuantityInAssetUnits(
+        targetEndpointId,
+        decimalToPip(estimatedWithdrawQuantityInDecimal),
+      );
+      estimatedWithdrawQuantityInDecimal = assetUnitsToDecimal(
+        estimatedForwardedQuantityInAssetUnits,
+        Number(forwardedPoolDecimals),
+      );
+      minimumWithdrawQuantityInDecimal = assetUnitsToDecimal(
+        minimumForwardedQuantityInAssetUnits,
+        Number(forwardedPoolDecimals),
+      );
+    }
+   */
+    const willSucceed = BigInt(estimatedWithdrawQuantityInAssetUnits) >=
+        BigInt(minimumWithdrawQuantityInAssetUnits);
+    return {
+        estimatedWithdrawQuantityInDecimal,
+        minimumWithdrawQuantityInDecimal,
+        willSucceed,
+    };
+}
+exports.estimateBridgeWithdrawQuantity = estimateBridgeWithdrawQuantity;

package/dist/client/index.d.ts

@@ -0,0 +1,4 @@
+export * from '#client/rest/index';
+export * from '#client/orderBook/index';
+export * from '#client/webSocket/index';
+//# sourceMappingURL=index.d.ts.map

package/dist/client/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC"}

package/dist/client/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("#client/rest/index"), exports);
+tslib_1.__exportStar(require("#client/orderBook/index"), exports);
+tslib_1.__exportStar(require("#client/webSocket/index"), exports);

package/dist/client/orderBook/index.d.ts

@@ -0,0 +1,2 @@
+export * from '#client/orderBook/realTime';
+//# sourceMappingURL=index.d.ts.map

package/dist/client/orderBook/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/orderBook/index.ts"],"names":[],"mappings":"AAAA,cAAc,4BAA4B,CAAC"}

package/dist/client/orderBook/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("#client/orderBook/realTime"), exports);

package/dist/client/orderBook/realTime.d.ts

@@ -0,0 +1,180 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import { RestPublicClient } from '#client/rest/public';
+import { OrderBookRealTimeClientEvent } from '#types/enums/index';
+import type * as katanaPerps from '#index';
+/**
+ * Orderbook Client Options
+ *
+ * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/OrderBookRealTimeClient.html)
+ */
+export interface OrderBookRealTimeClientOptions {
+    /**
+     * Optionally provide an `apiKey` for increased rate limiting
+     */
+    apiKey?: string;
+    /**
+     * Controls whether the production or sandbox endpoints will be used
+     */
+    sandbox?: boolean;
+    /**
+     * Optionally provide a custom url to use when making Katana Perps REST API requests.
+     *
+     * - Will override the {@link sandbox} option when given.
+     */
+    baseRestApiURL?: string;
+    /**
+     * Optionally provide a custom WebSocket API URL to use when connecting to
+     * the Katana Perps WebSocket API.
+     *
+     * - Will override the {@link sandbox} option when given.
+     */
+    baseWebSocketURL?: string;
+    marketsResponse?: katanaPerps.RestResponseGetMarkets;
+}
+/**
+ * Orderbook API client
+ *
+ * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/OrderBookRealTimeClient.html)
+ * @see options  {@link OrderBookRealTimeClientOptions}
+ * @see events   {@link OrderBookRealTimeClientEvent}
+ *
+ * @category API Clients
+ *
+ * @example
+ * ```typescript
+ * import {
+ *  OrderBookRealTimeClient,
+ *  OrderBookRealTimeClientEvent,
+ *  type L2OrderBook
+ * } from '@katanaperps/katana-perps-sdk';
+ *
+ * // type is just to show it will match the form string-string.
+ * // actual type will be typed as string
+ * type MarketSymbol = `${string}-${string}`;
+ *
+ * const LIMIT = 10;
+ * const MARKETS: MarketSymbol[] = ['BTC-USD'];
+ *
+ * const client = new OrderBookRealTimeClient({
+ *   sandbox: true,
+ * });
+ *
+ * client.start(MARKETS);
+ *
+ * const orderbooksMap = new Map<MarketSymbol, L2OrderBook>()
+ *
+ * async function handleOrderBookLevel2(market: MarketSymbol) {
+ *   const levelTwoOrderBook = await client.getOrderBookL2(market, LIMIT);
+ *
+ *   orderbooksMap.set(market, levelTwoOrderBook)
+ *
+ *   console.log('Updated OrderBook for market: ', market, levelTwoOrderBook);
+ * }
+ *
+ * client.on(OrderBookRealTimeClientEvent.ready, () => {
+ *  MARKETS.forEach(market => {
+ *    handleOrderBookLevel2(market)
+ *  })
+ * });
+ *
+ * client.on(OrderBookRealTimeClientEvent.l2, handleOrderBookLevel2);
+ * ```
+ */
+export declare class OrderBookRealTimeClient extends EventEmitter<{
+    [OrderBookRealTimeClientEvent.ready]: [market: string];
+    [OrderBookRealTimeClientEvent.connected]: [];
+    [OrderBookRealTimeClientEvent.disconnected]: [];
+    [OrderBookRealTimeClientEvent.error]: [error: Error];
+    [OrderBookRealTimeClientEvent.l1]: [market: string];
+    [OrderBookRealTimeClientEvent.l2]: [market: string];
+    [OrderBookRealTimeClientEvent.sync]: [market: string];
+}> {
+    private readonly l1OrderBooks;
+    private readonly l2OrderBooks;
+    private readonly l2OrderBookUpdates;
+    private markets;
+    private readonly marketsByAssetSymbol;
+    /**
+     * When creating an {@link OrderBookRealTimeClient}, a public client is automatically
+     * created and can be used based to make additional public requests if needed.
+     *
+     * - Can be utilized to fetch public data instead of creating both clients.
+     *
+     * @category Accessors
+     */
+    readonly public: RestPublicClient;
+    private marketsResponse;
+    private isTickSizesLoaded;
+    private readonly tickSizesByMarket;
+    private readonly webSocketClient;
+    private webSocketConnectionListenersConfigured;
+    private webSocketResponseListenerConfigured;
+    /**
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/OrderBookRealTimeClient.html)
+     *
+     * @category Constructor
+     */
+    constructor(options?: OrderBookRealTimeClientOptions);
+    /**
+     * Loads initial state from REST API and begin listening to orderbook updates.
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/OrderBookRealTimeClient.html#start)
+     *
+     * @category Connection Management
+     */
+    start(markets: string[], marketsResponse?: katanaPerps.RestResponseGetMarkets): Promise<void>;
+    /**
+     * Stop the order book client, and reset internal state.
+     * Call this when you are no longer using the client, to release memory and network resources.
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/OrderBookRealTimeClient.html#stop)
+     *
+     * @category Connection Management
+     */
+    stop(): void;
+    getMaximumTickSizeUnderSpread(market: string): Promise<bigint>;
+    /**
+     * Load the current state of the level 1 orderbook for this market.
+     *
+     * @param tickSize
+     *   Minimum price movement expressed in pips (10^-8), defaults to market setting
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/OrderBookRealTimeClient.html#getOrderBookL1)
+     * @see response {@link RestResponseGetOrderBookLevel1}
+     *
+     * @category Requests
+     */
+    getOrderBookL1(market: string, tickSize?: bigint | undefined): Promise<katanaPerps.RestResponseGetOrderBookLevel1>;
+    /**
+     * Load the current state of the level 2 orderbook for this market.
+     *
+     * @param limit
+     *   Total number of price levels (bids + asks) to return
+     *   - Between 2 and 1000
+     *   - Defaults to `100`
+     * @param tickSize
+     *   Minimum price movement expressed in pips (10^-8), defaults to market setting
+     *
+     * @see typedoc  [Reference Documentation](https://sdk-js-docs-v1-perps.katana.network/classes/OrderBookRealTimeClient.html#getOrderBookL2)
+     * @see response {@link RestResponseGetOrderBookLevel2}
+     *
+     * @category Requests
+     */
+    getOrderBookL2(market: string, limit?: number, tickSize?: bigint | undefined): Promise<katanaPerps.RestResponseGetOrderBookLevel2>;
+    private getOrderBooks;
+    private applyOrderBookUpdates;
+    private synchronizeFromRestApi;
+    private loadLevel2;
+    private loadTickSizes;
+    private mapTokensToMarkets;
+    private resetInternalState;
+    private setupInternalWebSocket;
+    private subscribe;
+    private unsubscribe;
+    private webSocketHandleConnect;
+    private webSocketHandleDisconnect;
+    private webSocketHandleError;
+    private webSocketHandleResponse;
+}
+//# sourceMappingURL=realTime.d.ts.map

package/dist/client/orderBook/realTime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"realTime.d.ts","sourceRoot":"","sources":["../../../src/client/orderBook/realTime.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAMtC,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAUvD,OAAO,EAEL,4BAA4B,EAE7B,MAAM,oBAAoB,CAAC;AAE5B,OAAO,KAAK,KAAK,WAAW,MAAM,QAAQ,CAAC;AAI3C;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,WAAW,CAAC,sBAAsB,CAAC;CACtD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,qBAAa,uBAAwB,SAAQ,YAAY,CAAC;IACxD,CAAC,4BAA4B,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvD,CAAC,4BAA4B,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC;IAC7C,CAAC,4BAA4B,CAAC,YAAY,CAAC,EAAE,EAAE,CAAC;IAChD,CAAC,4BAA4B,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC,4BAA4B,CAAC,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC,4BAA4B,CAAC,EAAE,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC,4BAA4B,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACvD,CAAC;IACA,OAAO,CAAC,QAAQ,CAAC,YAAY,CACjB;IAEZ,OAAO,CAAC,QAAQ,CAAC,YAAY,CACjB;IAEZ,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAG/B;IAEJ,OAAO,CAAC,OAAO,CAAgB;IAE/B,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAkC;IAEvE;;;;;;;OAOG;IAEH,SAAgB,MAAM,EAAE,gBAAgB,CAAC;IAEzC,OAAO,CAAC,eAAe,CACX;IAEZ,OAAO,CAAC,iBAAiB,CAAS;IAElC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAkC;IAEpE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAkB;IAElD,OAAO,CAAC,sCAAsC,CAAS;IAEvD,OAAO,CAAC,mCAAmC,CAAS;IAEpD;;;;OAIG;gBACS,OAAO,GAAE,8BAAmC;IAuBxD;;;;;;OAMG;IACU,KAAK,CAChB,OAAO,EAAE,MAAM,EAAE,EACjB,eAAe,CAAC,EAAE,WAAW,CAAC,sBAAsB;IAWtD;;;;;;;OAOG;IACI,IAAI;IAQE,6BAA6B,CAAC,MAAM,EAAE,MAAM;IAWzD;;;;;;;;;;OAUG;IACU,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS;IAMzE;;;;;;;;;;;;;;OAcG;IACU,cAAc,CACzB,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,MAAM,EACd,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS;YAQjB,aAAa;YAeb,qBAAqB;YA0DrB,sBAAsB;YA+BtB,UAAU;YAiBV,aAAa;IAgB3B,OAAO,CAAC,kBAAkB;IAc1B,OAAO,CAAC,kBAAkB;IAW1B,OAAO,CAAC,sBAAsB;IAW9B,OAAO,CAAC,SAAS;IAOjB,OAAO,CAAC,WAAW;YAML,sBAAsB;IAapC,OAAO,CAAC,yBAAyB;IAOjC,OAAO,CAAC,oBAAoB;YAOd,uBAAuB;CAWtC"}