@gearbox-protocol/sdk 3.0.0-vfourabi.7 → 3.0.0-vfourabi.8

package/dist/types/sdk/GearboxSDK.d.ts

@@ -0,0 +1,139 @@
+import type { Address, Hex } from "viem";
+import type { BaseContract } from "./base";
+import { TokensMeta } from "./base";
+import type { ConnectionOptions, NetworkOptions, TransportOptions } from "./chain";
+import { Provider } from "./chain";
+import type { IAddressProviderContract } from "./core";
+import { BotListContract, GearStakingContract } from "./core";
+import { MarketRegister } from "./market/MarketRegister";
+import { PriceFeedRegister } from "./market/pricefeeds";
+import type { IGearboxSDKPlugin } from "./plugins";
+import { RouterV3Contract } from "./router";
+import type { GearboxState, GearboxStateHuman, ILogger, MultiCall } from "./types";
+import { AddressMap } from "./utils";
+export interface SDKOptions {
+    /**
+     * If not set, address provider address is determinted automatically from networkType
+     */
+    addressProvider?: Address;
+    /**
+     * Market configurators
+     */
+    marketConfigurators: Address[];
+    /**
+     * Attach and load state at this specific block number
+     */
+    blockNumber?: bigint | number;
+    /**
+     * Fixed redstone historic timestamp in ms
+     * Set to true to enable redstone historical mode using timestamp from attach block
+     */
+    redstoneHistoricTimestamp?: number | true;
+    /**
+     * Override redstone gateways. Can be used to set caching proxies, to avoid rate limiting
+     */
+    redstoneGateways?: string[];
+    /**
+     * Will skip updateable prices on attach and sync
+     * Makes things faster when your service is not intereseted in prices
+     */
+    ignoreUpdateablePrices?: boolean;
+    /**
+     * Plugins to extends SDK functionality
+     */
+    plugins?: IGearboxSDKPlugin[];
+    /**
+     * Bring your own logger
+     */
+    logger?: ILogger;
+}
+export interface SyncStateOptions {
+    blockNumber: bigint;
+    timestamp: bigint;
+}
+export type SDKHooks = {
+    syncState: [];
+};
+export declare class GearboxSDK {
+    #private;
+    readonly logger?: ILogger;
+    readonly plugins: ReadonlyArray<IGearboxSDKPlugin>;
+    /**
+     * Interest rate models can be reused across chain (and SDK operates on chain level)
+     * TODO: use whatever interface is necessary for InterestRateModels
+     */
+    readonly interestRateModels: AddressMap<BaseContract<readonly unknown[]>>;
+    /**
+     * All price feeds known to sdk, without oracle-related data (stalenessPeriod, main/reserve, etc.)
+     */
+    readonly priceFeeds: PriceFeedRegister;
+    /**
+     * All contracts known to sdk
+     */
+    readonly contracts: AddressMap<BaseContract<any>>;
+    /**
+     * Token metadata such as symbol and decimals
+     */
+    readonly tokensMeta: TokensMeta;
+    addHook: <K extends "syncState">(hookName: K, fn: (...args: SDKHooks[K]) => void | Promise<void>) => void;
+    removeHook: <K extends "syncState">(hookName: K, fn: (...args: SDKHooks[K]) => void | Promise<void>) => void;
+    static attach(options: SDKOptions & Partial<NetworkOptions> & ConnectionOptions & TransportOptions): Promise<GearboxSDK>;
+    private constructor();
+    /**
+     * Converts contract call into some human-friendly string
+     * @param address
+     * @param calldata
+     * @returns
+     */
+    parseFunctionData(address: Address, calldata: Hex): string;
+    /**
+     * Converts multicalls into some human-friendly strings
+     * @param address
+     * @param calldata
+     * @returns
+     */
+    parseMultiCall(calls: MultiCall[]): string[];
+    /**
+     * Return args, function, type and address name from contract call
+     * @param address
+     * @param calldata
+     * @returns
+     */
+    parseFunctionDataToObject(address: Address, calldata: Hex): {
+        address: `0x${string}`;
+        type: string;
+        args: any[];
+        functionName: any;
+    } | null;
+    /**
+     * Converts multicalls into call info
+     * @param address
+     * @param calldata
+     * @returns
+     */
+    parseMultiCallToObject(calls: MultiCall[]): ({
+        address: `0x${string}`;
+        type: string;
+        args: any[];
+        functionName: any;
+    } | null)[];
+    stateHuman(raw?: boolean): GearboxStateHuman;
+    get state(): GearboxState;
+    tvl(): Promise<void>;
+    /**
+     * Reloads markets states based on events from last processed block to new block (defaults to latest block)
+     * @param opts
+     * @returns
+     */
+    syncState(opts?: SyncStateOptions): Promise<void>;
+    get provider(): Provider;
+    get currentBlock(): bigint;
+    get timestamp(): bigint;
+    get gear(): Address;
+    get addressProvider(): IAddressProviderContract;
+    get botListContract(): BotListContract;
+    get gearStakingContract(): GearStakingContract;
+    get marketRegister(): MarketRegister;
+    get router(): RouterV3Contract;
+}
+//# sourceMappingURL=GearboxSDK.d.ts.map

package/dist/types/sdk/GearboxSDK.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GearboxSDK.d.ts","sourceRoot":"","sources":["../../../src/sdk/GearboxSDK.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAGzC,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,gBAAgB,EACjB,MAAM,SAAS,CAAC;AACjB,OAAO,EAAmB,QAAQ,EAAE,MAAM,SAAS,CAAC;AASpD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,QAAQ,CAAC;AACvD,OAAO,EACL,eAAe,EACf,mBAAmB,EAEpB,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC5C,OAAO,KAAK,EACV,YAAY,EACZ,iBAAiB,EACjB,OAAO,EACP,SAAS,EACV,MAAM,SAAS,CAAC;AACjB,OAAO,EAAE,UAAU,EAAY,MAAM,SAAS,CAAC;AAI/C,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,mBAAmB,EAAE,OAAO,EAAE,CAAC;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC9B;;;OAGG;IACH,yBAAyB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC5B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;OAEG;IACH,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAiBD,MAAM,WAAW,gBAAgB;IAC/B,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;CACnB;AAGD,MAAM,MAAM,QAAQ,GAAG;IACrB,SAAS,EAAE,EAAE,CAAC;CACf,CAAC;AAEF,qBAAa,UAAU;;IAuBrB,SAAgB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjC,SAAgB,OAAO,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC;IAE1D;;;OAGG;IACH,SAAgB,kBAAkB,+CAE9B;IACJ;;OAEG;IACH,SAAgB,UAAU,EAAE,iBAAiB,CAAC;IAC9C;;OAEG;IACH,SAAgB,SAAS,gCAGvB;IACF;;OAEG;IACH,SAAgB,UAAU,aAA2C;IAE9D,OAAO,mGAAyC;IAChD,UAAU,mGAA4C;WAEzC,MAAM,CACxB,OAAO,EAAE,UAAU,GACjB,OAAO,CAAC,cAAc,CAAC,GACvB,iBAAiB,GACjB,gBAAgB,GACjB,OAAO,CAAC,UAAU,CAAC;IA+CtB,OAAO;IAuFP;;;;;OAKG;IACI,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,GAAG,MAAM;IAQjE;;;;;OAKG;IACI,cAAc,CAAC,KAAK,EAAE,SAAS,EAAE,GAAG,MAAM,EAAE;IAMnD;;;;;OAKG;IACI,yBAAyB,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG;;;;;;IAahE;;;;;OAKG;IACI,sBAAsB,CAAC,KAAK,EAAE,SAAS,EAAE;;;;;;IAMzC,UAAU,CAAC,GAAG,UAAO,GAAG,iBAAiB;IAchD,IAAW,KAAK,IAAI,YAAY,CAM/B;IAEY,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;IAMjC;;;;OAIG;IACU,SAAS,CAAC,IAAI,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IA8C9D,IAAW,QAAQ,IAAI,QAAQ,CAE9B;IAED,IAAW,YAAY,IAAI,MAAM,CAKhC;IAED,IAAW,SAAS,IAAI,MAAM,CAK7B;IAED,IAAW,IAAI,IAAI,OAAO,CAKzB;IAED,IAAW,eAAe,IAAI,wBAAwB,CAKrD;IAED,IAAW,eAAe,IAAI,eAAe,CAK5C;IAED,IAAW,mBAAmB,IAAI,mBAAmB,CAKpD;IAED,IAAW,cAAc,IAAI,cAAc,CAK1C;IAED,IAAW,MAAM,IAAI,gBAAgB,CAKpC;CACF"}

package/dist/types/sdk/abi/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./oracles";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/sdk/abi/index.d.ts.map

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