@gearbox-protocol/sdk 3.0.0-vfour.132 → 3.0.0-vfour.134

package/dist/cjs/dev/index.cjs

@@ -4,6 +4,7 @@ var sdkGov = require('@gearbox-protocol/sdk-gov');
 var viem = require('viem');
 var accounts = require('viem/accounts');
 var sdk = require('../sdk');
+var promises = require('fs/promises');
 
 // src/dev/AccountOpener.ts
 function createAnvilClient({
@@ -366,6 +367,94 @@ async function calcLiquidatableLTs(sdk$1, ca, factor = 9990n, logger) {
   }
   return result;
 }
+var SDKExample = class {
+  #sdk;
+  #logger;
+  constructor(logger) {
+    this.#logger = logger;
+  }
+  async run(opts) {
+    const {
+      addressProvider: ap,
+      addressProviderJson,
+      marketConfigurator: mc,
+      marketConfiguratorJson,
+      anvilUrl = "http://127.0.0.1:8545",
+      outFile
+    } = opts;
+    const addressProvider = await this.#readConfigAddress(
+      "addressProvider",
+      ap,
+      addressProviderJson
+    );
+    const marketConfigurator = await this.#readConfigAddress(
+      "marketConfigurator",
+      mc,
+      marketConfiguratorJson
+    );
+    this.#sdk = await sdk.GearboxSDK.attach({
+      rpcURLs: [anvilUrl],
+      timeout: 48e4,
+      addressProvider,
+      logger: this.#logger,
+      ignoreUpdateablePrices: true,
+      marketConfigurators: [marketConfigurator]
+    });
+    const puTx = await this.#sdk.priceFeeds.getUpdatePriceFeedsTx([
+      marketConfigurator
+    ]);
+    const updater = viem.createWalletClient({
+      account: accounts.privateKeyToAccount(
+        "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"
+        // well-known anvil private key
+      ),
+      transport: viem.http(anvilUrl)
+    });
+    const publicClient = viem.createPublicClient({
+      transport: viem.http(anvilUrl)
+    });
+    const hash = await sdk.sendRawTx(updater, { tx: puTx });
+    await publicClient.waitForTransactionReceipt({ hash });
+    await this.#sdk.marketRegister.loadMarkets([marketConfigurator], true);
+    this.#logger?.info("attached sdk");
+    if (outFile) {
+      try {
+        await promises.writeFile(
+          outFile,
+          sdk.json_stringify(this.#sdk.stateHuman()),
+          "utf-8"
+        );
+      } catch (e) {
+        this.#logger?.error(`failed to write to ${outFile}: ${e}`);
+      }
+    }
+  }
+  async #readConfigAddress(name, value, file) {
+    let result = value;
+    if (!result) {
+      if (!file) {
+        throw new Error(`${name} is not specified`);
+      }
+      this.#logger?.debug(`reading ${name} json ${file}`);
+      const apFile = await promises.readFile(file, "utf-8").then(JSON.parse);
+      result = apFile[name];
+    }
+    if (!result) {
+      throw new Error(`${name} is not specified`);
+    }
+    if (!viem.isAddress(result)) {
+      throw new Error(`${name} is not a valid address: ${result}`);
+    }
+    this.#logger?.info(`using ${name} ${result}`);
+    return result;
+  }
+  get sdk() {
+    if (!this.#sdk) {
+      throw new Error("sdk is not attached");
+    }
+    return this.#sdk;
+  }
+};
 
 // src/dev/abi/v3.ts
 var iaclAbi = [
@@ -1875,6 +1964,7 @@ async function setLTZero(anvil, cm, logger) {
 }
 
 exports.AccountOpener = AccountOpener;
+exports.SDKExample = SDKExample;
 exports.anvilNodeInfo = anvilNodeInfo;
 exports.calcLiquidatableLTs = calcLiquidatableLTs;
 exports.createAnvilClient = createAnvilClient;

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

@@ -96,6 +96,21 @@ declare function anvilNodeInfo(client: Client<any, any, any, AnvilRPCSchema, any
  */
 declare function evmMineDetailed(client: Client<any, any, any, AnvilRPCSchema, any>, timestamp: bigint | number): Promise<Block<Hex> | undefined>;
 
+interface SDKExampleOptions {
+    addressProvider?: string;
+    addressProviderJson?: string;
+    marketConfigurator?: string;
+    marketConfiguratorJson?: string;
+    anvilUrl?: string;
+    outFile?: string;
+}
+declare class SDKExample {
+    #private;
+    constructor(logger?: ILogger);
+    run(opts: SDKExampleOptions): Promise<void>;
+    get sdk(): GearboxSDK;
+}
+
 /**
  * Helper function to set liquidation thresholds on credit manager via anvil impersonation
  * @param sdk
@@ -107,4 +122,4 @@ declare function setLTs(anvil: AnvilClient, cm: CreditManagerState, newLTs: Reco
 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 { AccountOpener, type AccountOpenerOptions, type AnvilActions, type AnvilClient, type AnvilClientConfig, type AnvilNodeInfo, type AnvilRPCSchema, type TargetAccount, anvilNodeInfo, calcLiquidatableLTs, createAnvilClient, evmMineDetailed, isAnvil, setLTZero, setLTs };
+export { AccountOpener, type AccountOpenerOptions, type AnvilActions, type AnvilClient, type AnvilClientConfig, type AnvilNodeInfo, type AnvilRPCSchema, SDKExample, type SDKExampleOptions, type TargetAccount, anvilNodeInfo, calcLiquidatableLTs, createAnvilClient, evmMineDetailed, isAnvil, setLTZero, setLTs };

package/dist/cjs/sdk/index.cjs

@@ -61617,7 +61617,7 @@ var GearboxSDK = class _GearboxSDK {
       networkType
     });
     logger?.debug(
-      { networkType, chainId, addressProvider },
+      { networkType, chainId, addressProvider, marketConfigurators },
       "attaching gearbox sdk"
     );
     return new _GearboxSDK({

package/dist/esm/dev/index.d.mts

@@ -1,5 +1,5 @@
 import { Address, TestRpcSchema, Hex, Block, Prettify, Client, Transport, Chain, TestActions, PublicClient, WalletClient } from 'viem';
-import { CreditAccountsService, CreditAccountData, GearboxSDK, ILogger, CreditManagerState } from '../sdk';
+import { CreditAccountsService, CreditAccountData, GearboxSDK, ILogger, CreditManagerState } from '../sdk/index.d.mts';
 
 interface AccountOpenerOptions {
     faucet?: Address;
@@ -96,6 +96,21 @@ declare function anvilNodeInfo(client: Client<any, any, any, AnvilRPCSchema, any
  */
 declare function evmMineDetailed(client: Client<any, any, any, AnvilRPCSchema, any>, timestamp: bigint | number): Promise<Block<Hex> | undefined>;
 
+interface SDKExampleOptions {
+    addressProvider?: string;
+    addressProviderJson?: string;
+    marketConfigurator?: string;
+    marketConfiguratorJson?: string;
+    anvilUrl?: string;
+    outFile?: string;
+}
+declare class SDKExample {
+    #private;
+    constructor(logger?: ILogger);
+    run(opts: SDKExampleOptions): Promise<void>;
+    get sdk(): GearboxSDK;
+}
+
 /**
  * Helper function to set liquidation thresholds on credit manager via anvil impersonation
  * @param sdk
@@ -107,4 +122,4 @@ declare function setLTs(anvil: AnvilClient, cm: CreditManagerState, newLTs: Reco
 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 { AccountOpener, type AccountOpenerOptions, type AnvilActions, type AnvilClient, type AnvilClientConfig, type AnvilNodeInfo, type AnvilRPCSchema, type TargetAccount, anvilNodeInfo, calcLiquidatableLTs, createAnvilClient, evmMineDetailed, isAnvil, setLTZero, setLTs };
+export { AccountOpener, type AccountOpenerOptions, type AnvilActions, type AnvilClient, type AnvilClientConfig, type AnvilNodeInfo, type AnvilRPCSchema, SDKExample, type SDKExampleOptions, type TargetAccount, anvilNodeInfo, calcLiquidatableLTs, createAnvilClient, evmMineDetailed, isAnvil, setLTZero, setLTs };

package/dist/esm/dev/index.mjs

@@ -1,7 +1,8 @@
 import { ADDRESS_0X0, formatBN } from '@gearbox-protocol/sdk-gov';
-import { createTestClient, publicActions, walletActions, toHex, isAddress, parseEther } from 'viem';
+import { createTestClient, publicActions, walletActions, toHex, isAddress, parseEther, createWalletClient, http, createPublicClient } from 'viem';
 import { privateKeyToAccount, generatePrivateKey } from 'viem/accounts';
-import { childLogger, sendRawTx, ierc20Abi, MAX_UINT256, iDegenNftv2Abi, PERCENTAGE_FACTOR, WAD } from '../sdk/index.mjs';
+import { childLogger, sendRawTx, ierc20Abi, MAX_UINT256, iDegenNftv2Abi, PERCENTAGE_FACTOR, GearboxSDK, json_stringify, WAD } from '../sdk/index.mjs';
+import { writeFile, readFile } from 'node:fs/promises';
 
 // src/dev/AccountOpener.ts
 function createAnvilClient({
@@ -364,6 +365,94 @@ async function calcLiquidatableLTs(sdk, ca, factor = 9990n, logger) {
   }
   return result;
 }
+var SDKExample = class {
+  #sdk;
+  #logger;
+  constructor(logger) {
+    this.#logger = logger;
+  }
+  async run(opts) {
+    const {
+      addressProvider: ap,
+      addressProviderJson,
+      marketConfigurator: mc,
+      marketConfiguratorJson,
+      anvilUrl = "http://127.0.0.1:8545",
+      outFile
+    } = opts;
+    const addressProvider = await this.#readConfigAddress(
+      "addressProvider",
+      ap,
+      addressProviderJson
+    );
+    const marketConfigurator = await this.#readConfigAddress(
+      "marketConfigurator",
+      mc,
+      marketConfiguratorJson
+    );
+    this.#sdk = await GearboxSDK.attach({
+      rpcURLs: [anvilUrl],
+      timeout: 48e4,
+      addressProvider,
+      logger: this.#logger,
+      ignoreUpdateablePrices: true,
+      marketConfigurators: [marketConfigurator]
+    });
+    const puTx = await this.#sdk.priceFeeds.getUpdatePriceFeedsTx([
+      marketConfigurator
+    ]);
+    const updater = createWalletClient({
+      account: privateKeyToAccount(
+        "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"
+        // well-known anvil private key
+      ),
+      transport: http(anvilUrl)
+    });
+    const publicClient = createPublicClient({
+      transport: http(anvilUrl)
+    });
+    const hash = await sendRawTx(updater, { tx: puTx });
+    await publicClient.waitForTransactionReceipt({ hash });
+    await this.#sdk.marketRegister.loadMarkets([marketConfigurator], true);
+    this.#logger?.info("attached sdk");
+    if (outFile) {
+      try {
+        await writeFile(
+          outFile,
+          json_stringify(this.#sdk.stateHuman()),
+          "utf-8"
+        );
+      } catch (e) {
+        this.#logger?.error(`failed to write to ${outFile}: ${e}`);
+      }
+    }
+  }
+  async #readConfigAddress(name, value, file) {
+    let result = value;
+    if (!result) {
+      if (!file) {
+        throw new Error(`${name} is not specified`);
+      }
+      this.#logger?.debug(`reading ${name} json ${file}`);
+      const apFile = await readFile(file, "utf-8").then(JSON.parse);
+      result = apFile[name];
+    }
+    if (!result) {
+      throw new Error(`${name} is not specified`);
+    }
+    if (!isAddress(result)) {
+      throw new Error(`${name} is not a valid address: ${result}`);
+    }
+    this.#logger?.info(`using ${name} ${result}`);
+    return result;
+  }
+  get sdk() {
+    if (!this.#sdk) {
+      throw new Error("sdk is not attached");
+    }
+    return this.#sdk;
+  }
+};
 
 // src/dev/abi/v3.ts
 var iaclAbi = [
@@ -1872,4 +1961,4 @@ async function setLTZero(anvil, cm, logger) {
   await anvil.stopImpersonatingAccount({ address: configuratorAddr });
 }
 
-export { AccountOpener, anvilNodeInfo, calcLiquidatableLTs, createAnvilClient, evmMineDetailed, isAnvil, setLTZero, setLTs };
+export { AccountOpener, SDKExample, anvilNodeInfo, calcLiquidatableLTs, createAnvilClient, evmMineDetailed, isAnvil, setLTZero, setLTs };

package/dist/esm/sdk/index.mjs

@@ -61615,7 +61615,7 @@ var GearboxSDK = class _GearboxSDK {
       networkType
     });
     logger?.debug(
-      { networkType, chainId, addressProvider },
+      { networkType, chainId, addressProvider, marketConfigurators },
       "attaching gearbox sdk"
     );
     return new _GearboxSDK({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/sdk",
-  "version": "3.0.0-vfour.132",
+  "version": "3.0.0-vfour.134",
   "description": "Gearbox SDK",
   "license": "MIT",
   "main": "./dist/cjs/sdk/index.cjs",