@gobob/bob-sdk 4.3.6 → 4.3.8

package/dist/gateway/types/defiLlama.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=defiLlama.js.map

package/dist/gateway/types/defiLlama.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defiLlama.js","sourceRoot":"","sources":["../../../src/gateway/types/defiLlama.ts"],"names":[],"mappings":""}

package/dist/gateway/types/index.d.ts

@@ -0,0 +1,11 @@
+export * from './bitcoin';
+export * from './crosschain-swap';
+export * from './defiLlama';
+export * from './layerzero';
+export * from './offramp';
+export * from './onramp';
+export * from './order';
+export * from './quote';
+export * from './strategy';
+export * from './token';
+export * from './utils';

package/dist/gateway/types/index.js

@@ -0,0 +1,28 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./bitcoin"), exports);
+__exportStar(require("./crosschain-swap"), exports);
+__exportStar(require("./defiLlama"), exports);
+__exportStar(require("./layerzero"), exports);
+__exportStar(require("./offramp"), exports);
+__exportStar(require("./onramp"), exports);
+__exportStar(require("./order"), exports);
+__exportStar(require("./quote"), exports);
+__exportStar(require("./strategy"), exports);
+__exportStar(require("./token"), exports);
+__exportStar(require("./utils"), exports);
+//# sourceMappingURL=index.js.map

package/dist/gateway/types/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/gateway/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,oDAAkC;AAClC,8CAA4B;AAC5B,8CAA4B;AAC5B,4CAA0B;AAC1B,2CAAyB;AACzB,0CAAwB;AACxB,0CAAwB;AACxB,6CAA2B;AAC3B,0CAAwB;AACxB,0CAAwB"}

package/dist/gateway/types/layerzero.d.ts

@@ -0,0 +1,90 @@
+import { Hex } from 'viem';
+interface LayerZeroMessagePathway {
+    srcEid: number;
+    dstEid: number;
+    sender: LayerZeroMessageSender;
+    receiver: LayerZeroMessageReceiver;
+    id: string;
+    nonce: number;
+}
+interface LayerZeroMessageSender {
+    address: string;
+    id: string;
+    name: string;
+    chain: string;
+}
+interface LayerZeroMessageReceiver {
+    address: string;
+    id: string;
+    name: string;
+    chain: string;
+}
+interface LayerZeroMessageSource {
+    status: string;
+    tx: LayerZeroMessageTx;
+}
+export interface LayerZeroLzCompose {
+    status: string;
+}
+interface LayerZeroMessageDestination {
+    tx: LayerZeroMessageTx;
+    status: string;
+    lzCompose: LayerZeroLzCompose;
+}
+interface LayerZeroMessageTx {
+    txHash: string;
+    blockHash: string;
+    blockNumber: string;
+    blockTimestamp: number;
+    from: string;
+    payload: string;
+    readinessTimestamp: number;
+}
+export type LayerZeroMessageWallet = {
+    pathway: LayerZeroMessagePathway;
+    source: LayerZeroMessageSource;
+    destination: LayerZeroMessageDestination;
+};
+export type LayerZeroMessagesWalletResponse = {
+    data: Array<LayerZeroMessageWallet>;
+};
+export type LayerZeroSendParam = {
+    dstEid: number;
+    to: Hex;
+    amountLD: bigint;
+    minAmountLD: bigint;
+    extraOptions: Hex;
+    composeMsg: Hex;
+    oftCmd: Hex;
+};
+export type LayerZeroChainInfo = {
+    name: string;
+    eid?: string;
+    oftAddress: string;
+    nativeChainId?: number;
+};
+export type LayerZeroDeploymentsMetadataResponse = {
+    [chainKey: string]: {
+        deployments?: [
+            {
+                version: number;
+                eid: string;
+            }
+        ];
+        chainKey: string;
+        chainDetails?: {
+            nativeChainId: number;
+        };
+    };
+};
+export type LayerZeroTokenDeploymentsResponse = {
+    [chainKey: string]: {
+        address: string;
+    };
+};
+export interface LayerZeroQuoteParamsExt {
+    l0ChainId?: number | null;
+    l0OriginFinalityBuffer?: number | bigint;
+    l0DestinationFinalityBuffer?: number | bigint;
+}
+export {};

package/dist/gateway/types/layerzero.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=layerzero.js.map

package/dist/gateway/types/layerzero.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"layerzero.js","sourceRoot":"","sources":["../../../src/gateway/types/layerzero.ts"],"names":[],"mappings":""}

package/dist/gateway/types/offramp.d.ts

@@ -0,0 +1,96 @@
+import { Address } from 'viem';
+import { offrampCaller } from '../abi';
+import { BaseExecuteQuoteParams } from './quote';
+import { GatewayOrderType } from './order';
+export type OfframpGatewayCreateQuoteResponse = {
+    amountToLock: string;
+    minimumFeesToPay: string;
+    gateway: Address;
+};
+export type OfframpOrderStatus = 'Active' | 'Accepted' | 'Processed' | 'Refunded';
+export interface OfframpFeeBreakdown {
+    overallFeeSats: number;
+    inclusionFeeSats: number;
+    protocolFeeSats: number;
+    affiliateFeeSats: number;
+    fastestFeeRate: number;
+    gasFee?: bigint;
+}
+export interface OfframpQuote {
+    amountLockInSat: number;
+    amountReceiveInSat: number;
+    deadline: number;
+    registryAddress: Address;
+    token: Address;
+    feeBreakdown: OfframpFeeBreakdown;
+}
+export interface OfframpLiquidity {
+    token: Address;
+    maxOrderAmount: bigint;
+    totalOfframpLiquidity: bigint;
+}
+export type OfframpCreateOrderParams = {
+    quote: OfframpQuote;
+    feeBreakdown: OfframpFeeBreakdown;
+    offrampABI: typeof offrampCaller;
+    offrampFunctionName: 'createOrder';
+    offrampArgs: [
+        {
+            satAmountToLock: bigint;
+            satFeesMax: bigint;
+            creationDeadline: bigint;
+            outputScript: `0x${string}`;
+            token: Address;
+            owner: Address;
+        }
+    ];
+};
+export type OfframpOrder = {
+    orderId: bigint;
+    token: Address;
+    satAmountLocked: bigint;
+    satFeesMax: bigint;
+    status: OfframpOrderStatus;
+    orderTimestamp: number;
+    submitOrderEvmTx: string | null;
+    refundedEvmTx: string | null;
+    btcTx: string | null;
+    shouldFeesBeBumped: boolean;
+    canOrderBeUnlocked: boolean;
+    offrampRegistryAddress: Address;
+};
+export type OnchainOfframpOrderDetails = {
+    orderId: bigint;
+    token: Address;
+    satAmountLocked: bigint;
+    satFeesMax: bigint;
+    owner: Address;
+    solverOwner: Address | null;
+    solverRecipient: Address | null;
+    outputScript: string;
+    status: OfframpOrderStatus;
+    orderTimestamp: number;
+};
+export interface OfframpRawOrder {
+    orderId: string;
+    token: string;
+    satAmountLocked: string;
+    satFeesMax: string;
+    status: string;
+    orderTimestamp: string;
+    btcTx: string | null;
+    submitOrderEvmTx: string | null;
+    shouldFeesBeBumped: boolean;
+    refundedEvmTx: string | null;
+}
+export type OfframpExecuteQuoteParams<T = {}> = BaseExecuteQuoteParams<T> & {
+    type: GatewayOrderType.Offramp;
+    data: OfframpQuote;
+};
+export interface BumpFeeParams {
+    orderId: bigint;
+}
+export interface UnlockOrderParams {
+    orderId: bigint;
+    receiver: Address;
+}

package/dist/gateway/types/offramp.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=offramp.js.map

package/dist/gateway/types/offramp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"offramp.js","sourceRoot":"","sources":["../../../src/gateway/types/offramp.ts"],"names":[],"mappings":""}

package/dist/gateway/types/onramp.d.ts

@@ -0,0 +1,96 @@
+import { Address } from 'viem';
+import { EsploraClient } from '../../esplora';
+import { GatewayOrderType, OrderDetails, OrderDetailsRaw } from './order';
+import { GatewayTokensInfo, Token } from './token';
+import { BaseExecuteQuoteParams } from './quote';
+export interface OnrampFeeBreakdownRaw {
+    overallFeeSats: number;
+    protocolFeeSats: number;
+    affiliateFeeSats: number;
+    executionFeeWei: string;
+    l1DataFeeWei: string;
+}
+export type OnrampFeeBreakdown = Omit<OnrampFeeBreakdownRaw, 'executionFeeWei' | 'l1DataFeeWei'> & {
+    executionFeeWei: bigint;
+    l1DataFeeWei: bigint;
+};
+export type OnrampQuote = {
+    gatewayAddress: Address;
+    baseTokenAddress: Address;
+    dustThreshold: number;
+    satoshis: number;
+    outputSatoshis: number;
+    fee: number;
+    bitcoinAddress: string;
+    txProofDifficultyFactor: number;
+    strategyAddress?: Address;
+    orderDetails: OrderDetails;
+    feeBreakdown: OnrampFeeBreakdown;
+};
+interface TokenReceived {
+    amount: string;
+    tokenAddress: Address;
+}
+export interface OnrampOrderResponse {
+    gatewayAddress: Address;
+    baseTokenAddress: Address;
+    txid: string;
+    status: boolean;
+    timestamp: number;
+    tokens: string;
+    satoshis: number;
+    fee: number;
+    txProofDifficultyFactor: number;
+    strategyAddress: Address | null;
+    satsToConvertToEth: number;
+    outputEthAmount: string | null;
+    outputTokenAddress: Address | null;
+    outputTokenAmount: string | null;
+    txHash: string | null;
+    orderDetails: OrderDetailsRaw | null;
+    layerzeroDstEid: number | null;
+    tokensReceived: TokenReceived[] | null;
+    strategyFailed: boolean | null;
+}
+export type OnrampOrderStatusData = {
+    confirmations: number;
+};
+export type OnrampOrderStatus = {
+    confirmed: false;
+    pending?: never;
+    success?: never;
+    data: OnrampOrderStatusData;
+} | {
+    confirmed?: never;
+    pending: true;
+    success?: never;
+    data: OnrampOrderStatusData;
+} | {
+    confirmed?: never;
+    pending?: never;
+    success: boolean;
+    data: OnrampOrderStatusData;
+};
+export type OnrampOrder = Omit<OnrampOrderResponse, 'satsToConvertToEth' | 'orderDetails' | 'tokensReceived' | 'outputTokenAddress' | 'outputTokenAmount'> & {
+    gasRefill: number;
+    orderDetails?: OrderDetails;
+} & {
+    getTokenAddress(): string | undefined;
+    getToken(): Token | undefined;
+    getTokenAmount(): string | number | null;
+    getConfirmations(esploraClient: EsploraClient, latestHeight?: number): Promise<number>;
+    getStatus(esploraClient: EsploraClient, latestHeight?: number): Promise<OnrampOrderStatus>;
+    getOutputTokens(): {
+        amount: string;
+        token: Token;
+    }[];
+    getTokens(): {
+        amount: string | number;
+        token: Token;
+    }[];
+} & GatewayTokensInfo;
+export type OnrampExecuteQuoteParams<T = {}> = BaseExecuteQuoteParams<T> & {
+    type: GatewayOrderType.Onramp;
+    data: OnrampQuote & GatewayTokensInfo;
+};
+export {};

package/dist/gateway/types/onramp.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=onramp.js.map

package/dist/gateway/types/onramp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"onramp.js","sourceRoot":"","sources":["../../../src/gateway/types/onramp.ts"],"names":[],"mappings":""}

package/dist/gateway/types/order.d.ts

@@ -0,0 +1,77 @@
+import { Address, Hex } from 'viem';
+import { OnrampOrder } from './onramp';
+import { OfframpOrder } from './offramp';
+import { CrossChainOrder } from './crosschain-swap';
+export type OrderDetailsRaw = {
+    version: string;
+    data: {
+        ethAmountToReceive: string;
+        satsToSwapToEth: number;
+        ethTransferGasLimit: string;
+        strategyGasLimit: string;
+        totalUserGasLimit: string;
+        userGasPriceLimit: string;
+        l1DataFee: string;
+        extraSatsFee: string | null;
+        extraSatsFeeRecipient: Address | null;
+    };
+};
+export type OrderDetails = {
+    version: string;
+    data: {
+        ethAmountToReceive: bigint;
+        satsToSwapToEth: number;
+        ethTransferGasLimit: bigint;
+        strategyGasLimit: bigint;
+        totalUserGasLimit: bigint;
+        userGasPriceLimit: bigint;
+        l1DataFee: bigint;
+        extraSatsFee: bigint | null;
+        extraSatsFeeRecipient: Address | null;
+    };
+};
+export type GatewayCreateOrderRequest = {
+    gatewayAddress: Address;
+    strategyAddress?: Address;
+    satsToConvertToEth: number;
+    userAddress: Address;
+    gatewayExtraData?: Hex;
+    strategyExtraData?: Hex;
+    satoshis: number;
+    campaignId?: string;
+    orderDetails?: OrderDetails;
+};
+export type GatewayCreateOrderRequestPayload = {
+    gatewayAddress: Address;
+    strategyAddress?: Address;
+    userAddress: Address;
+    gatewayExtraData?: Hex;
+    strategyExtraData?: Hex;
+    satoshis: number;
+    campaignId?: string;
+    orderDetails?: OrderDetailsRaw;
+};
+export type GatewayCreateOrderResponse = {
+    uuid: string;
+    opReturnHash: string;
+};
+export type GatewayStartOrder = GatewayCreateOrderResponse & {
+    bitcoinAddress: string;
+    satoshis: number;
+    psbtBase64?: string;
+};
+export declare enum GatewayOrderType {
+    Onramp = "onramp",
+    Offramp = "offramp",
+    CrossChainSwap = "crosschain-swap"
+}
+export type GatewayOrder = {
+    type: GatewayOrderType.Onramp;
+    order: OnrampOrder;
+} | {
+    type: GatewayOrderType.Offramp;
+    order: OfframpOrder;
+} | {
+    type: GatewayOrderType.CrossChainSwap;
+    order: CrossChainOrder;
+};

package/dist/gateway/types/order.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GatewayOrderType = void 0;
+var GatewayOrderType;
+(function (GatewayOrderType) {
+    GatewayOrderType["Onramp"] = "onramp";
+    GatewayOrderType["Offramp"] = "offramp";
+    GatewayOrderType["CrossChainSwap"] = "crosschain-swap";
+})(GatewayOrderType || (exports.GatewayOrderType = GatewayOrderType = {}));
+//# sourceMappingURL=order.js.map

package/dist/gateway/types/order.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"order.js","sourceRoot":"","sources":["../../../src/gateway/types/order.ts"],"names":[],"mappings":";;;AAkFA,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IACxB,qCAAiB,CAAA;IACjB,uCAAmB,CAAA;IACnB,sDAAkC,CAAA;AACtC,CAAC,EAJW,gBAAgB,gCAAhB,gBAAgB,QAI3B"}

package/dist/gateway/types/quote.d.ts

@@ -0,0 +1,34 @@
+import { Hex } from 'viem';
+import { Optional } from './utils';
+import { OnrampExecuteQuoteParams } from './onramp';
+import { OfframpExecuteQuoteParams } from './offramp';
+import { CrossChainSwapQuoteParams } from './crosschain-swap';
+type ChainSlug = string | number;
+type TokenSymbol = string;
+export interface GatewayQuoteParams {
+    fromChain: ChainSlug;
+    toChain: ChainSlug;
+    fromToken: TokenSymbol;
+    toToken: TokenSymbol;
+    fromUserAddress: string;
+    toUserAddress: string;
+    amount: number | string | bigint;
+    maxSlippage?: number;
+    affiliateId?: string;
+    type?: 'swap' | 'deposit' | 'withdraw' | 'claim';
+    fee?: number;
+    feeRate?: number;
+    gasRefill?: bigint;
+    fromUserPublicKey?: string;
+    strategyAddress?: string;
+    campaignId?: string;
+    message?: Hex;
+}
+export type GetQuoteParams<T = {}> = Optional<GatewayQuoteParams & T, 'fromUserAddress'>;
+export type BaseExecuteQuoteParams<T = {}> = {
+    finalOutputSats: number;
+    finalFeeSats: number;
+    params: GetQuoteParams;
+} & T;
+export type ExecuteQuoteParams<T = {}> = OnrampExecuteQuoteParams<T> | OfframpExecuteQuoteParams<T> | CrossChainSwapQuoteParams<T>;
+export {};

package/dist/gateway/{types.js → types/quote.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=types.js.map
+//# sourceMappingURL=quote.js.map

package/dist/gateway/types/quote.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"quote.js","sourceRoot":"","sources":["../../../src/gateway/types/quote.ts"],"names":[],"mappings":""}

package/dist/gateway/types/strategy.d.ts

@@ -0,0 +1,64 @@
+import { Address } from 'viem';
+interface GatewayToken {
+    symbol: string;
+    address: string;
+    logo: string;
+    decimals: number;
+    chain: string;
+}
+type GatewayIntegrationType = 'bridge' | 'dex' | 'staking' | 'lending';
+interface GatewayIntegration {
+    type: GatewayIntegrationType;
+    slug: string;
+    name: string;
+    logo: string;
+    monetization: boolean;
+}
+type GatewayStrategyType = 'deposit' | 'withdraw' | 'claim' | 'router' | 'bridge';
+type GatewayChainType = 'evm' | 'ibc' | 'solana' | 'multiversx' | 'bitcoin' | 'ton' | 'tron';
+interface GatewayChain {
+    id: string;
+    chainId: number;
+    slug: string;
+    name: string;
+    logo: string;
+    type: GatewayChainType;
+    singleChainSwap: boolean;
+    singleChainStaking: boolean;
+    nativeToken?: GatewayToken;
+    txExplorer?: string;
+    tokenExplorer?: string;
+    rpcUrl?: string;
+}
+export interface GatewayStrategyContract {
+    id: string;
+    type: GatewayStrategyType;
+    address: Address;
+    method: string;
+    chain: GatewayChain;
+    integration: GatewayIntegration;
+    inputToken: GatewayToken;
+    outputToken: GatewayToken | null;
+}
+export type StrategyParams = {
+    strategyAddress: Address;
+    token: Address;
+    sender: Address;
+    receiver: Address;
+    amount: bigint;
+    amountOutMin: bigint;
+};
+export interface GatewayStrategy {
+    strategyAddress: string;
+    strategyName: string;
+    strategyType: 'staking' | 'lending';
+    projectName: string;
+    projectLogo?: string;
+    inputTokenAddress: string;
+    outputTokenAddress?: string;
+}
+export interface StrategyAssetState {
+    address: Address | 'usd';
+    totalUnderlying: bigint;
+}
+export {};

package/dist/gateway/types/strategy.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=strategy.js.map

package/dist/gateway/types/strategy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"strategy.js","sourceRoot":"","sources":["../../../src/gateway/types/strategy.ts"],"names":[],"mappings":""}

package/dist/gateway/types/token.d.ts

@@ -0,0 +1,24 @@
+import { Address } from 'viem';
+export interface Token {
+    chainId: number;
+    address: Address;
+    name: string;
+    symbol: string;
+    decimals: number;
+    logoURI: string;
+}
+export interface PointsIncentive {
+    id: string;
+    name: string;
+}
+export interface EnrichedToken extends Token {
+    tvl: number;
+    apyBase: number;
+    apyReward: number;
+    rewardTokens: Token[];
+    points: PointsIncentive[];
+}
+export type GatewayTokensInfo = {
+    baseToken: Token;
+    outputToken?: Token;
+};

package/dist/gateway/types/token.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=token.js.map

package/dist/gateway/types/token.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"token.js","sourceRoot":"","sources":["../../../src/gateway/types/token.ts"],"names":[],"mappings":""}

package/dist/gateway/types/utils.d.ts

@@ -0,0 +1 @@
+export type Optional<T, K extends keyof T> = Omit<T, K> & Partial<T>;

package/dist/gateway/types/utils.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=utils.js.map

package/dist/gateway/types/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/gateway/types/utils.ts"],"names":[],"mappings":""}

package/dist/gateway/{utils.d.ts → utils/common.d.ts}

@@ -1,7 +1,6 @@
-import { Chain as ViemChain } from 'viem';
-import { GatewayCreateOrderRequest, OfframpOrderStatus, OnrampFeeBreakdown, OnrampFeeBreakdownRaw, OrderDetails, OrderDetailsRaw } from './types';
-import { Address, Hex } from 'viem';
 import * as bitcoin from 'bitcoinjs-lib';
+import { Address, Hex, Chain as ViemChain } from 'viem';
+import { GatewayCreateOrderRequest, OfframpOrderStatus, OnrampFeeBreakdown, OnrampFeeBreakdownRaw, OrderDetails, OrderDetailsRaw } from '../types';
 export declare function calculateOpReturnHash(req: GatewayCreateOrderRequest): `0x${string}`;
 export declare function toHexScriptPubKey(userAddress: string, network: bitcoin.Network): string;
 export declare function isHexPrefixed(str: string): boolean;
@@ -6893,5 +6892,5 @@ export declare function convertOnrampFeeBreakdown(order: OnrampFeeBreakdownRaw):
 export declare function parseBtc(btc: string): bigint;
 export declare function formatBtc(btc: bigint): string;
 export declare function getChainConfig(fromChain: string | number): ViemChain;
-export declare function computeAllowanceSlot(user: Address, offrampRegistryAddress: Address, tokenAllowanceSlot: bigint): Hex;
+export declare function computeAllowanceSlot(owner: Address, spender: Address, tokenAllowanceSlot: bigint): Hex;
 export declare function computeBalanceSlot(user: Address, balancesMappingSlot: bigint): Hex;