@gearbox-protocol/sdk 14.12.0-next.74 → 14.12.0-next.76

package/dist/types/sdk/accounts/bots/PeripheryCompressorV310Contract.d.ts

@@ -0,0 +1,236 @@
+import { OnchainSDK } from "../../OnchainSDK.js";
+import { BaseContract } from "../../base/BaseContract.js";
+import "../../base/index.js";
+import { ConnectedBotsCall } from "./types.js";
+import { Address } from "viem";
+//#region src/sdk/accounts/bots/PeripheryCompressorV310Contract.d.ts
+declare const abi: readonly [{
+  readonly type: "constructor";
+  readonly inputs: readonly [{
+    readonly name: "addressProvider_";
+    readonly type: "address";
+    readonly internalType: "address";
+  }];
+  readonly stateMutability: "nonpayable";
+}, {
+  readonly type: "function";
+  readonly name: "addressProvider";
+  readonly inputs: readonly [];
+  readonly outputs: readonly [{
+    readonly name: "";
+    readonly type: "address";
+    readonly internalType: "address";
+  }];
+  readonly stateMutability: "view";
+}, {
+  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: "getBots";
+  readonly inputs: readonly [{
+    readonly name: "marketConfigurator";
+    readonly type: "address";
+    readonly internalType: "address";
+  }];
+  readonly outputs: readonly [{
+    readonly name: "botStates";
+    readonly type: "tuple[]";
+    readonly internalType: "struct BotState[]";
+    readonly components: readonly [{
+      readonly name: "baseParams";
+      readonly type: "tuple";
+      readonly internalType: "struct BaseParams";
+      readonly components: readonly [{
+        readonly name: "addr";
+        readonly type: "address";
+        readonly internalType: "address";
+      }, {
+        readonly name: "version";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+      }, {
+        readonly name: "contractType";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+      }, {
+        readonly name: "serializedParams";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+      }];
+    }, {
+      readonly name: "requiredPermissions";
+      readonly type: "uint192";
+      readonly internalType: "uint192";
+    }];
+  }];
+  readonly stateMutability: "view";
+}, {
+  readonly type: "function";
+  readonly name: "getConnectedBots";
+  readonly inputs: readonly [{
+    readonly name: "marketConfigurator";
+    readonly type: "address";
+    readonly internalType: "address";
+  }, {
+    readonly name: "creditAccount";
+    readonly type: "address";
+    readonly internalType: "address";
+  }];
+  readonly outputs: readonly [{
+    readonly name: "botStates";
+    readonly type: "tuple[]";
+    readonly internalType: "struct ConnectedBotState[]";
+    readonly components: readonly [{
+      readonly name: "baseParams";
+      readonly type: "tuple";
+      readonly internalType: "struct BaseParams";
+      readonly components: readonly [{
+        readonly name: "addr";
+        readonly type: "address";
+        readonly internalType: "address";
+      }, {
+        readonly name: "version";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+      }, {
+        readonly name: "contractType";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+      }, {
+        readonly name: "serializedParams";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+      }];
+    }, {
+      readonly name: "requiredPermissions";
+      readonly type: "uint192";
+      readonly internalType: "uint192";
+    }, {
+      readonly name: "creditAccount";
+      readonly type: "address";
+      readonly internalType: "address";
+    }, {
+      readonly name: "permissions";
+      readonly type: "uint192";
+      readonly internalType: "uint192";
+    }, {
+      readonly name: "forbidden";
+      readonly type: "bool";
+      readonly internalType: "bool";
+    }];
+  }];
+  readonly stateMutability: "view";
+}, {
+  readonly type: "function";
+  readonly name: "getZappers";
+  readonly inputs: readonly [{
+    readonly name: "marketConfigurator";
+    readonly type: "address";
+    readonly internalType: "address";
+  }, {
+    readonly name: "pool";
+    readonly type: "address";
+    readonly internalType: "address";
+  }];
+  readonly outputs: readonly [{
+    readonly name: "zappers";
+    readonly type: "tuple[]";
+    readonly internalType: "struct ZapperState[]";
+    readonly components: readonly [{
+      readonly name: "baseParams";
+      readonly type: "tuple";
+      readonly internalType: "struct BaseParams";
+      readonly components: readonly [{
+        readonly name: "addr";
+        readonly type: "address";
+        readonly internalType: "address";
+      }, {
+        readonly name: "version";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+      }, {
+        readonly name: "contractType";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+      }, {
+        readonly name: "serializedParams";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+      }];
+    }, {
+      readonly name: "tokenIn";
+      readonly type: "tuple";
+      readonly internalType: "struct TokenData";
+      readonly components: readonly [{
+        readonly name: "addr";
+        readonly type: "address";
+        readonly internalType: "address";
+      }, {
+        readonly name: "symbol";
+        readonly type: "string";
+        readonly internalType: "string";
+      }, {
+        readonly name: "name";
+        readonly type: "string";
+        readonly internalType: "string";
+      }, {
+        readonly name: "decimals";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+      }];
+    }, {
+      readonly name: "tokenOut";
+      readonly type: "tuple";
+      readonly internalType: "struct TokenData";
+      readonly components: readonly [{
+        readonly name: "addr";
+        readonly type: "address";
+        readonly internalType: "address";
+      }, {
+        readonly name: "symbol";
+        readonly type: "string";
+        readonly internalType: "string";
+      }, {
+        readonly name: "name";
+        readonly type: "string";
+        readonly internalType: "string";
+      }, {
+        readonly name: "decimals";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+      }];
+    }];
+  }];
+  readonly stateMutability: "view";
+}, {
+  readonly type: "function";
+  readonly name: "version";
+  readonly inputs: readonly [];
+  readonly outputs: readonly [{
+    readonly name: "";
+    readonly type: "uint256";
+    readonly internalType: "uint256";
+  }];
+  readonly stateMutability: "view";
+}];
+type abi = typeof abi;
+declare class PeripheryCompressorV310Contract extends BaseContract<abi> {
+  constructor(sdk: OnchainSDK, address: Address);
+  /**
+   * Descriptor of a `getConnectedBots` call on this compressor.
+   *
+   * @param marketConfigurator - Configurator that governs the account's market.
+   * @param creditAccount - Credit account to list the connected bots of.
+   **/
+  connectedBotsCall(marketConfigurator: Address, creditAccount: Address): ConnectedBotsCall;
+}
+//#endregion
+export { PeripheryCompressorV310Contract };

package/dist/types/sdk/accounts/bots/abi.d.ts

@@ -0,0 +1,18 @@
+//#region src/sdk/accounts/bots/abi.d.ts
+/**
+ * Minimal bot interface: the permissions a bot needs to operate on a credit
+ * account, which the SDK reads when the caller does not specify them.
+ **/
+declare const iBotAbi: readonly [{
+  readonly type: "function";
+  readonly name: "requiredPermissions";
+  readonly inputs: readonly [];
+  readonly outputs: readonly [{
+    readonly name: "";
+    readonly type: "uint192";
+    readonly internalType: "uint192";
+  }];
+  readonly stateMutability: "view";
+}];
+//#endregion
+export { iBotAbi };

package/dist/types/sdk/accounts/bots/index.d.ts

@@ -0,0 +1,4 @@
+import { AccountToCheck, BotStatusCall, BotsDirectResponse, CMSlice, ConnectedBotsCall, ConnectedBotsPerAccount, GetConnectedBotsResponse, GetConnectedBotsResult, GetConnectedMigrationBotsResult, MulticallWithFailure, SetBotProps, SetBotResult } from "./types.js";
+import { AccountBotsService } from "./AccountBotsService.js";
+import { PeripheryCompressorV310Contract } from "./PeripheryCompressorV310Contract.js";
+export { AccountBotsService, AccountToCheck, BotStatusCall, BotsDirectResponse, CMSlice, ConnectedBotsCall, ConnectedBotsPerAccount, GetConnectedBotsResponse, GetConnectedBotsResult, GetConnectedMigrationBotsResult, MulticallWithFailure, PeripheryCompressorV310Contract, SetBotProps, SetBotResult };

package/dist/types/sdk/accounts/bots/types.d.ts

@@ -0,0 +1,143 @@
+import { iBotListV310Abi } from "../../../abi/310/generated.js";
+import { peripheryCompressorAbi } from "../../../abi/compressors/peripheryCompressor.js";
+import { ConnectedBotData } from "../../base/types.js";
+import { RouterCASlice } from "../../router/types.js";
+import "../../router/index.js";
+import { CreditAccountOperationResult, CreditManagerOperationResult } from "../types.js";
+import "../../base/index.js";
+import { Address, ContractFunctionParameters } from "viem";
+//#region src/sdk/accounts/bots/types.d.ts
+/**
+ * @internal
+ * Descriptor of a `getConnectedBots` call on the periphery compressor, so that
+ * it can be batched with calls to other contracts.
+ **/
+type ConnectedBotsCall = ContractFunctionParameters<typeof peripheryCompressorAbi, "pure" | "view", "getConnectedBots">;
+/**
+ * @internal
+ * Descriptor of a `getBotStatus` call on a bot list, so that it can be batched
+ * with calls to other contracts.
+ **/
+type BotStatusCall = ContractFunctionParameters<typeof iBotListV310Abi, "pure" | "view", "getBotStatus">;
+/**
+ * @internal
+ * Result of a `multicall` with `allowFailure: true`.
+ **/
+type MulticallWithFailure<T> = ({
+  error?: undefined;
+  result: T;
+  status: "success";
+} | {
+  error: Error;
+  result?: undefined;
+  status: "failure";
+})[];
+/**
+ * @internal
+ * Raw responses of a bot list's `getBotStatus`.
+ **/
+type BotsDirectResponse = MulticallWithFailure<readonly [bigint, boolean, boolean] | readonly [bigint, boolean]>;
+/**
+ * Credit account and credit manager address pair, used for batch queries such as connected bot lookups.
+ **/
+type AccountToCheck = {
+  /**
+   * Address of the credit account.
+   **/
+  creditAccount: Address;
+  /**
+   * Address of the credit manager that manages this account.
+   **/
+  creditManager: Address;
+};
+/**
+ * Minimal credit manager data an operation can be performed on, when it does
+ * not target a specific credit account.
+ **/
+interface CMSlice {
+  creditManager: Address;
+  creditFacade: Address;
+  type: "creditManager";
+}
+/**
+ * Props for {@link AccountBotsService.setBot}.
+ **/
+interface SetBotProps {
+  /**
+   * Address of a bot that is being updated
+   */
+  botAddress: Address;
+  /**
+   * Permissions to set for the bot
+   */
+  permissions: bigint | null;
+  /**
+   * Minimal credit account data {@link RouterCASlice} on which operation is performed; if omitted, credit manager data is used
+   * Minimal credit manager data {@link CMSlice} on which operation is performed; used only if credit account is omitted
+   * At least one of credit account or credit manager must be provided
+   */
+  targetContract: (RouterCASlice & {
+    type: "creditAccount";
+  }) | CMSlice;
+}
+/**
+ * Multicall result of querying connected bots across multiple credit accounts.
+ **/
+type GetConnectedBotsResult = Array<{
+  error?: undefined;
+  result: readonly ConnectedBotData[];
+  status: "success";
+} | {
+  error: Error;
+  result?: undefined;
+  status: "failure";
+}>;
+/**
+ * Result of querying a migration bot's status across credit accounts, or `undefined` if no migration bot was provided.
+ **/
+type GetConnectedMigrationBotsResult = {
+  result: ({
+    error: Error;
+    result?: undefined;
+    status: "failure";
+  } | {
+    error?: undefined;
+    result: readonly [bigint, boolean, boolean] | readonly [bigint, boolean];
+    status: "success";
+  })[];
+  botAddress: Address;
+} | undefined;
+/**
+ * Statuses of the queried bots on one credit account, in the order the bots
+ * were passed in.
+ **/
+interface ConnectedBotsPerAccount {
+  result: BotsDirectResponse;
+}
+/**
+ * Result of {@link AccountBotsService.getConnectedBots}.
+ **/
+interface GetConnectedBotsResponse {
+  /**
+   * Bots the periphery compressor reports for each checked account, in the
+   * order the accounts were passed in.
+   **/
+  legacy: GetConnectedBotsResult;
+  /**
+   * Status of the legacy migration bot on each checked account, or
+   * `undefined` when no migration bot was passed in.
+   **/
+  legacyMigration: GetConnectedMigrationBotsResult;
+  /**
+   * Statuses of the additionally requested bots, one entry per checked
+   * account.
+   **/
+  additionalBots: Array<ConnectedBotsPerAccount>;
+}
+/**
+ * Result of {@link AccountBotsService.setBot}: a full transaction when the bot
+ * is set on a credit account, calls only when it is set on a credit manager.
+ **/
+type SetBotResult = CreditAccountOperationResult | CreditManagerOperationResult;
+//#endregion
+export { AccountToCheck, BotStatusCall, BotsDirectResponse, CMSlice, ConnectedBotsCall, ConnectedBotsPerAccount, GetConnectedBotsResponse, GetConnectedBotsResult, GetConnectedMigrationBotsResult, MulticallWithFailure, SetBotProps, SetBotResult };

package/dist/types/sdk/accounts/credit-account-compressor/CreditAccountCompressor.d.ts

@@ -0,0 +1,60 @@
+import { CreditAccountData } from "../../base/types.js";
+import { StrategyPosition } from "../../../model/positions.js";
+import "../../../model/index.js";
+import { GetCreditAccountsOptions, ListStrategyPositionsProps } from "./types.js";
+import { SDKConstruct } from "../../base/SDKConstruct.js";
+import "../../base/index.js";
+import { Address } from "viem";
+//#region src/sdk/accounts/credit-account-compressor/CreditAccountCompressor.d.ts
+/**
+ * Reads credit accounts of the current chain.
+ *
+ * Stitches the credit account compressor together with the RWA factories (for
+ * accounts owned via an investor EOA) and with the withdrawal compressor (for
+ * assets that are on their way out of an account), and describes the result
+ * either as raw account data or as {@link StrategyPosition}s.
+ *
+ * TODO: create and deploy new compressor contract onchain to avoid all this stitching
+ **/
+declare class CreditAccountCompressor extends SDKConstruct {
+  #private;
+  /**
+   * Reads data of a single credit account.
+   *
+   * When the compressor cannot value the account with current prices, the read
+   * is retried with price feed updates applied.
+   *
+   * @param account - Credit account address.
+   * @param blockNumber - Block to read at, defaults to the latest block.
+   * @returns Account data, or `undefined` if the account does not exist.
+   **/
+  getCreditAccountData(account: Address, blockNumber?: bigint): Promise<CreditAccountData<true> | undefined>;
+  /**
+   * Reads all credit accounts matching the options, sorted by health factor
+   * ascending.
+   *
+   * @param options - {@link GetCreditAccountsOptions}
+   * @param blockNumber - Block to read at, defaults to the latest block.
+   **/
+  getCreditAccounts(options?: GetCreditAccountsOptions, blockNumber?: bigint): Promise<CreditAccountData[]>;
+  /**
+   * Reads all credit accounts of a borrower, sorted by health factor
+   * ascending.
+   *
+   * Covers accounts the borrower owns directly and RWA accounts they own as an
+   * investor, which are owned on-chain by an RWA factory.
+   *
+   * @param borrower - Wallet address.
+   * @param options - {@link GetCreditAccountsOptions}
+   * @param blockNumber - Block to read at, defaults to the latest block.
+   **/
+  getBorrowerCreditAccounts(borrower: Address, options?: GetCreditAccountsOptions, blockNumber?: bigint): Promise<CreditAccountData<true>[]>;
+  /**
+   * Describes all credit accounts of a wallet as strategy positions.
+   *
+   * @param props - {@link ListStrategyPositionsProps}
+   **/
+  listPositions(props: ListStrategyPositionsProps): Promise<StrategyPosition[]>;
+}
+//#endregion
+export { CreditAccountCompressor };