@gearbox-protocol/sdk 3.0.0-vfour.21 → 3.0.0-vfour.211

package/dist/cjs/dev/index.d.ts

@@ -1,5 +1,26 @@
-import { Address, Block, Hex, Prettify, Client, Transport, Chain, TestActions, PublicClient, WalletClient, TestRpcSchema } from 'viem';
-import { GearboxSDK, CreditAccountData, ILogger, CreditFactory } from '../sdk';
+import { Address, TestRpcSchema, Hex, Block, Prettify, Client, Transport, Chain, TestActions, PublicClient, WalletClient } from 'viem';
+import { SDKConstruct, CreditAccountsService, CreditAccountData, GearboxSDK, ILogger, Unarray, AddressMap, PriceFeedTreeNode, CreditManagerState } from '../sdk';
+import { AbiParametersToPrimitiveTypes, ExtractAbiFunction } from 'abitype';
+
+interface AccountOpenerOptions {
+    faucet?: Address;
+}
+interface TargetAccount {
+    creditManager: Address;
+    collateral: Address;
+    leverage?: number;
+    slippage?: number;
+}
+declare class AccountOpener extends SDKConstruct {
+    #private;
+    constructor(service: CreditAccountsService, options?: AccountOpenerOptions);
+    get borrower(): Address;
+    /**
+     * Tries to open account with underlying only in each CM
+     */
+    openCreditAccounts(targets: TargetAccount[]): Promise<CreditAccountData[]>;
+    getOpenedAccounts(): Promise<CreditAccountData[]>;
+}
 
 /**
  * Given credit accounts, calculates new liquidation thresholds that needs to be set to drop account health factor a bit to make it eligible for partial liquidation
@@ -39,6 +60,7 @@ type AnvilRPCSchema = [
     }
 ];
 type AnvilActions = {
+    anvilNodeInfo: () => Promise<AnvilNodeInfo>;
     isAnvil: () => Promise<boolean>;
     evmMineDetailed: (
     /**
@@ -60,6 +82,12 @@ declare function createAnvilClient({ chain, transport, }: AnvilClientConfig): An
  * @returns
  */
 declare function isAnvil(client: Client<any, any, any, AnvilRPCSchema, any>): Promise<boolean>;
+/**
+ * Anvil node info
+ * @param client
+ * @returns
+ */
+declare function anvilNodeInfo(client: Client<any, any, any, AnvilRPCSchema, any>): Promise<AnvilNodeInfo>;
 /**
  * Safely tries to mine block with given timestamp
  * @param client
@@ -68,12 +96,327 @@ declare function isAnvil(client: Client<any, any, any, AnvilRPCSchema, any>): Pr
  */
 declare function evmMineDetailed(client: Client<any, any, any, AnvilRPCSchema, any>, timestamp: bigint | number): Promise<Block<Hex> | undefined>;
 
+declare const iPriceFeedStoreAbi: readonly [{
+    readonly type: "function";
+    readonly name: "addPriceFeed";
+    readonly inputs: readonly [{
+        readonly name: "priceFeed";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "stalenessPeriod";
+        readonly type: "uint32";
+        readonly internalType: "uint32";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "allowPriceFeed";
+    readonly inputs: readonly [{
+        readonly name: "token";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "priceFeed";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "contractType";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "forbidPriceFeed";
+    readonly inputs: readonly [{
+        readonly name: "token";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "priceFeed";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "getAllowanceTimestamp";
+    readonly inputs: readonly [{
+        readonly name: "token";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "priceFeed";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getKnownPriceFeeds";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getKnownTokens";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getPriceFeeds";
+    readonly inputs: readonly [{
+        readonly name: "token";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getStalenessPeriod";
+    readonly inputs: readonly [{
+        readonly name: "priceFeed";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint32";
+        readonly internalType: "uint32";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getTokenPriceFeedsMap";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "tuple[]";
+        readonly internalType: "struct ConnectedPriceFeed[]";
+        readonly components: readonly [{
+            readonly name: "token";
+            readonly type: "address";
+            readonly internalType: "address";
+        }, {
+            readonly name: "priceFeeds";
+            readonly type: "address[]";
+            readonly internalType: "address[]";
+        }];
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "isAllowedPriceFeed";
+    readonly inputs: readonly [{
+        readonly name: "token";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "priceFeed";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "owner";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "setStalenessPeriod";
+    readonly inputs: readonly [{
+        readonly name: "priceFeed";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "stalenessPeriod";
+        readonly type: "uint32";
+        readonly internalType: "uint32";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "version";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "event";
+    readonly name: "AddPriceFeed";
+    readonly inputs: readonly [{
+        readonly name: "priceFeed";
+        readonly type: "address";
+        readonly indexed: false;
+        readonly internalType: "address";
+    }, {
+        readonly name: "stalenessPeriod";
+        readonly type: "uint32";
+        readonly indexed: false;
+        readonly internalType: "uint32";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "AllowPriceFeed";
+    readonly inputs: readonly [{
+        readonly name: "token";
+        readonly type: "address";
+        readonly indexed: false;
+        readonly internalType: "address";
+    }, {
+        readonly name: "priceFeed";
+        readonly type: "address";
+        readonly indexed: false;
+        readonly internalType: "address";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "ForbidPriceFeed";
+    readonly inputs: readonly [{
+        readonly name: "token";
+        readonly type: "address";
+        readonly indexed: false;
+        readonly internalType: "address";
+    }, {
+        readonly name: "priceFeed";
+        readonly type: "address";
+        readonly indexed: false;
+        readonly internalType: "address";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "SetStalenessPeriod";
+    readonly inputs: readonly [{
+        readonly name: "priceFeed";
+        readonly type: "address";
+        readonly indexed: false;
+        readonly internalType: "address";
+    }, {
+        readonly name: "stalenessPeriod";
+        readonly type: "uint32";
+        readonly indexed: false;
+        readonly internalType: "uint32";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "error";
+    readonly name: "CallerIsNotOwnerException";
+    readonly inputs: readonly [{
+        readonly name: "caller";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "PriceFeedAlreadyAddedException";
+    readonly inputs: readonly [{
+        readonly name: "priceFeed";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "PriceFeedIsNotAllowedException";
+    readonly inputs: readonly [{
+        readonly name: "token";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "priceFeed";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "PriceFeedNotKnownException";
+    readonly inputs: readonly [{
+        readonly name: "priceFeed";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+}];
+
+type ConnectedPriceFeed = Unarray<AbiParametersToPrimitiveTypes<ExtractAbiFunction<typeof iPriceFeedStoreAbi, "getTokenPriceFeedsMap">["outputs"]>[0]>;
+declare class PriceFeedStore extends SDKConstruct {
+    #private;
+    constructor(sdk: GearboxSDK);
+    load(update?: boolean): Promise<AddressMap<PriceFeedTreeNode[]>>;
+}
+
+interface SDKExampleOptions {
+    addressProvider?: string;
+    addressProviderJson?: string;
+    marketConfigurators: Address[];
+    anvilUrl?: string;
+    outFile?: string;
+}
+declare class SDKExample {
+    #private;
+    constructor(logger?: ILogger);
+    run(opts: SDKExampleOptions): Promise<void>;
+    get sdk(): GearboxSDK;
+}
+
+interface SetLTsCMSlice {
+    creditConfigurator: Address;
+    address: Address;
+}
 /**
  * Helper function to set liquidation thresholds on credit manager via anvil impersonation
  * @param sdk
  * @param cm
  * @param newLTs
  */
-declare function setLTs(sdk: GearboxSDK, cm: CreditFactory, newLTs: Record<Address, number>, logger?: ILogger): Promise<void>;
+declare function setLTs(anvil: AnvilClient, cm: SetLTsCMSlice, newLTs: Record<Address, number>, logger?: ILogger): Promise<void>;
+
+type ZeroLTCMSlice = Pick<CreditManagerState, "creditConfigurator" | "feeInterest" | "liquidationDiscount" | "feeLiquidationExpired" | "liquidationDiscountExpired" | "feeLiquidation" | "name" | "underlying" | "baseParams">;
+declare function setLTZero(anvil: AnvilClient, cm: ZeroLTCMSlice, logger?: ILogger): Promise<void>;
 
-export { type AnvilActions, type AnvilClient, type AnvilClientConfig, calcLiquidatableLTs, createAnvilClient, evmMineDetailed, isAnvil, setLTs };
+export { AccountOpener, type AccountOpenerOptions, type AnvilActions, type AnvilClient, type AnvilClientConfig, type AnvilNodeInfo, type AnvilRPCSchema, type ConnectedPriceFeed, PriceFeedStore, SDKExample, type SDKExampleOptions, type SetLTsCMSlice, type TargetAccount, anvilNodeInfo, calcLiquidatableLTs, createAnvilClient, evmMineDetailed, isAnvil, setLTZero, setLTs };