@bgd-labs/toolbox 0.0.1 → 0.0.2

package/dist/index.d.mts

@@ -1,4 +1,5 @@
-import { Address, Hex } from 'viem';
+import { IPayloadsControllerCore_ABI, IGovernanceCore_ABI } from '@bgd-labs/aave-address-book/abis';
+import { GetContractReturnType, Client, Hex, TestClient, Address, WalletClient } from 'viem';
 
 /**
  * In solidity it is a quite common practice to encode bit variables in bitmaps opposed to bool structs.
@@ -19,6 +20,15 @@ declare function bitmapToIndexes(bitmap: bigint): number[];
  * @returns
  */
 declare function getBits(uint256: bigint, startBit: bigint, _endBit: bigint): bigint;
+/**
+ * Sets the bits in a bigint
+ * @param input
+ * @param startBit inclusive
+ * @param endBit inclusive
+ * @param value the value to replace
+ * @returns
+ */
+declare function setBits(input: bigint, startBit: bigint, endBit: bigint, replaceValue: bigint | number): bigint;
 
 /**
  * The userConfiguration on aave is stored as an alteranting bitmap.
@@ -32,6 +42,160 @@ declare function decodeUserConfiguration(userConfiguration: bigint): {
     collateralAssetIds: number[];
 };
 
+type ReserveConfiguration = {
+    ltv: bigint;
+    liquidationThreshold: bigint;
+    liquidationBonus: bigint;
+    decimals: bigint;
+    active: boolean;
+    frozen: boolean;
+    borrowingEnabled: boolean;
+    paused: boolean;
+    borrowingInIsolation: boolean;
+    siloedBorrowingEnabled: boolean;
+    flashloaningEnabled: boolean;
+    reserveFactor: bigint;
+    borrowCap: bigint;
+    supplyCap: bigint;
+    liquidationProtocolFee: bigint;
+    unbackedMintCap: bigint;
+    debtCeiling: bigint;
+    virtualAccountingEnabled: boolean;
+};
+/**
+ * ReserveConfiguration is a tightly packed struct that contains the configuration of a reserve
+ * @param data
+ * @returns the decoded ReserveConfiguration
+ */
+declare function decodeReserveConfiguration(data: bigint): ReserveConfiguration;
+declare function decodeReserveConfigurationV2(data: bigint): {
+    ltv: bigint;
+    liquidationThreshold: bigint;
+    liquidationBonus: bigint;
+    decimals: bigint;
+    active: boolean;
+    frozen: boolean;
+    borrowingEnabled: boolean;
+    stableBorrowingEnabled: boolean;
+    reserveFactor: bigint;
+};
+
+declare const SECONDS_PER_YEAR = 31536000n;
+declare const LTV_PRECISION = 4n;
+
+interface CalculateCompoundedInterestRequest {
+    rate: bigint;
+    currentTimestamp: number;
+    lastUpdateTimestamp: number;
+}
+declare function calculateCompoundedInterest({ rate, currentTimestamp, lastUpdateTimestamp, }: CalculateCompoundedInterestRequest): bigint;
+interface LinearInterestRequest {
+    rate: bigint;
+    currentTimestamp: number;
+    lastUpdateTimestamp: number;
+}
+declare function calculateLinearInterest({ rate, currentTimestamp, lastUpdateTimestamp, }: LinearInterestRequest): bigint;
+interface NormalizedIncomeRequest {
+    rate: bigint;
+    index: bigint;
+    lastUpdateTimestamp: number;
+    currentTimestamp: number;
+}
+declare function getNormalizedIncome({ rate, index, lastUpdateTimestamp, currentTimestamp, }: NormalizedIncomeRequest): bigint;
+declare function getNormalizedDebt({ rate, index, currentTimestamp, lastUpdateTimestamp, }: NormalizedIncomeRequest): bigint;
+interface CurrentBalanceRequest {
+    scaledBalance: bigint;
+    index: bigint;
+    rate: bigint;
+    lastUpdateTimestamp: number;
+    currentTimestamp: number;
+}
+declare function getCurrentLiquidityBalance({ scaledBalance, index, rate, lastUpdateTimestamp, currentTimestamp, }: CurrentBalanceRequest): bigint;
+declare function getCurrentDebtBalance({ index, scaledBalance, rate, lastUpdateTimestamp, currentTimestamp, }: CurrentBalanceRequest): bigint;
+interface HealthFactorFromBalanceRequest {
+    collateralBalanceMarketReferenceCurrency: bigint;
+    borrowBalanceMarketReferenceCurrency: bigint;
+    averageLiquidationThreshold: bigint;
+}
+declare function calculateHealthFactorFromBalances({ borrowBalanceMarketReferenceCurrency, collateralBalanceMarketReferenceCurrency, averageLiquidationThreshold, }: HealthFactorFromBalanceRequest): bigint;
+interface AvailableBorrowsMarketReferenceCurrencyRequest {
+    collateralBalanceMarketReferenceCurrency: bigint;
+    borrowBalanceMarketReferenceCurrency: bigint;
+    currentLtv: bigint;
+}
+declare function calculateAvailableBorrowsMarketReferenceCurrency({ collateralBalanceMarketReferenceCurrency, borrowBalanceMarketReferenceCurrency, currentLtv, }: AvailableBorrowsMarketReferenceCurrencyRequest): bigint;
+interface MarketReferenceCurrencyAndUsdBalanceRequest {
+    balance: bigint;
+    priceInMarketReferenceCurrency: bigint;
+    marketReferenceCurrencyDecimals: number;
+    decimals: number;
+    marketReferencePriceInUsdNormalized: bigint;
+}
+interface MarketReferenceAndUsdBalanceResponse {
+    marketReferenceCurrencyBalance: bigint;
+    usdBalance: bigint;
+}
+/**
+ * @returns non humanized/normalized values for usd/marketReference
+ */
+declare function getMarketReferenceCurrencyAndUsdBalance({ balance, priceInMarketReferenceCurrency, marketReferenceCurrencyDecimals, decimals, marketReferencePriceInUsdNormalized, }: MarketReferenceCurrencyAndUsdBalanceRequest): MarketReferenceAndUsdBalanceResponse;
+
+declare const WAD: bigint;
+declare const HALF_WAD: bigint;
+declare const RAY: bigint;
+declare const HALF_RAY: bigint;
+declare const WAD_RAY_RATIO: bigint;
+declare function rayMul(a: bigint, b: bigint): bigint;
+declare function rayDiv(a: bigint, b: bigint): bigint;
+declare function rayToWad(a: bigint): bigint;
+declare function wadToRay(a: bigint): bigint;
+declare function wadDiv(a: bigint, b: bigint): bigint;
+
+declare enum PayloadState {
+    None = 0,
+    Created = 1,
+    Queued = 2,
+    Executed = 3,
+    Cancelled = 4,
+    Expired = 5
+}
+declare const HUMAN_READABLE_PAYLOAD_STATE: {
+    0: string;
+    1: string;
+    2: string;
+    3: string;
+    4: string;
+    5: string;
+};
+type PayloadsControllerContract = GetContractReturnType<typeof IPayloadsControllerCore_ABI, Client>;
+declare function getPayloadsController<T extends Client>(client: T, address: Hex): PayloadsControllerContract;
+declare function makePayloadExecutableOnTestClient(client: TestClient, payloadsController: Address, payloadId: number): Promise<void>;
+declare function getNonFinalizedPayloads<T extends Client>(client: T, payloadsController: Address): Promise<number[]>;
+
+declare enum ProposalState {
+    Null = 0,// proposal does not exists
+    Created = 1,// created, waiting for a cooldown to initiate the balances snapshot
+    Active = 2,// balances snapshot set, voting in progress
+    Queued = 3,// voting results submitted, but proposal is under grace period when guardian can cancel it
+    Executed = 4,// results sent to the execution chain(s)
+    Failed = 5,// voting was not successful
+    Cancelled = 6,// got cancelled by guardian, or because proposition power of creator dropped below allowed minimum
+    Expired = 7
+}
+declare const HUMAN_READABLE_PROPOSAL_STATE: {
+    0: string;
+    1: string;
+    2: string;
+    3: string;
+    4: string;
+    5: string;
+    6: string;
+    7: string;
+};
+type GovernanceContract = GetContractReturnType<typeof IGovernanceCore_ABI, Client>;
+declare function getGovernance<T extends Client>(client: T, address: Hex): GovernanceContract;
+declare function makeProposalExecutableOnTestClient(client: TestClient, governance: Address, proposalId: bigint): Promise<void>;
+
 type ExplorerConfig = {
     api: string;
     explorer: string;
@@ -81,6 +245,61 @@ declare function parseApiSourceCode(sourceCode: string): {
     }>;
 };
 
+/**
+ * While tenderly is a fenomanal tool for testing, it is not always easy to use as there are minor bugs and small nuances to consider everywhere.
+ * This is a simple wrapper around the tenderly APIs.
+ */
+
+type TenderlyConfig = {
+    accountSlug: string;
+    projectSlug: string;
+    accessToken: string;
+};
+type Tenderly_createVnetParams = {
+    slug: string;
+    displayName: string;
+    baseChainId: number;
+    forkChainId: number;
+    blockNumber?: Hex;
+};
+type Tenderly_createVnetParamsResponse = {
+    id: string;
+    slug: string;
+    display_name: number;
+    fork_config: {
+        network_id: number;
+        block_number: Hex;
+    };
+    virtual_network_config: {
+        chain_config: {
+            chain_id: number;
+        };
+        accounts: {
+            address: string;
+        }[];
+    };
+    rpcs: [
+        {
+            url: string;
+            name: "Admin RPC";
+        },
+        {
+            url: string;
+            name: "Public RPC";
+        }
+    ];
+};
+declare function tenderly_createVnet({ slug, displayName, baseChainId, forkChainId, blockNumber, }: Tenderly_createVnetParams, { accessToken, accountSlug, projectSlug }: TenderlyConfig): Promise<{
+    vnet: Tenderly_createVnetParamsResponse;
+    testClient: TestClient;
+    walletClient: WalletClient;
+    simulate: (body: any) => Promise<Response>;
+    delete: () => Promise<Response>;
+}>;
+
+declare const erc1967_ImplementationSlot = "0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc";
+declare const erc1967_AdminSlot = "0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103";
+
 declare function diffCode(codeBefore: string, codeAfter: string): Promise<Record<string, string>>;
 
-export { type ExplorerConfig, bitmapToIndexes, decodeUserConfiguration, diffCode, getBits, getExplorer, getSourceCode, parseApiSourceCode };
+export { type ExplorerConfig, type GovernanceContract, HALF_RAY, HALF_WAD, HUMAN_READABLE_PAYLOAD_STATE, HUMAN_READABLE_PROPOSAL_STATE, LTV_PRECISION, PayloadState, type PayloadsControllerContract, ProposalState, RAY, type ReserveConfiguration, SECONDS_PER_YEAR, type Tenderly_createVnetParamsResponse, WAD, WAD_RAY_RATIO, bitmapToIndexes, calculateAvailableBorrowsMarketReferenceCurrency, calculateCompoundedInterest, calculateHealthFactorFromBalances, calculateLinearInterest, decodeReserveConfiguration, decodeReserveConfigurationV2, decodeUserConfiguration, diffCode, erc1967_AdminSlot, erc1967_ImplementationSlot, getBits, getCurrentDebtBalance, getCurrentLiquidityBalance, getExplorer, getGovernance, getMarketReferenceCurrencyAndUsdBalance, getNonFinalizedPayloads, getNormalizedDebt, getNormalizedIncome, getPayloadsController, getSourceCode, makePayloadExecutableOnTestClient, makeProposalExecutableOnTestClient, parseApiSourceCode, rayDiv, rayMul, rayToWad, setBits, tenderly_createVnet, wadDiv, wadToRay };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import { Address, Hex } from 'viem';
+import { IPayloadsControllerCore_ABI, IGovernanceCore_ABI } from '@bgd-labs/aave-address-book/abis';
+import { GetContractReturnType, Client, Hex, TestClient, Address, WalletClient } from 'viem';
 
 /**
  * In solidity it is a quite common practice to encode bit variables in bitmaps opposed to bool structs.
@@ -19,6 +20,15 @@ declare function bitmapToIndexes(bitmap: bigint): number[];
  * @returns
  */
 declare function getBits(uint256: bigint, startBit: bigint, _endBit: bigint): bigint;
+/**
+ * Sets the bits in a bigint
+ * @param input
+ * @param startBit inclusive
+ * @param endBit inclusive
+ * @param value the value to replace
+ * @returns
+ */
+declare function setBits(input: bigint, startBit: bigint, endBit: bigint, replaceValue: bigint | number): bigint;
 
 /**
  * The userConfiguration on aave is stored as an alteranting bitmap.
@@ -32,6 +42,160 @@ declare function decodeUserConfiguration(userConfiguration: bigint): {
     collateralAssetIds: number[];
 };
 
+type ReserveConfiguration = {
+    ltv: bigint;
+    liquidationThreshold: bigint;
+    liquidationBonus: bigint;
+    decimals: bigint;
+    active: boolean;
+    frozen: boolean;
+    borrowingEnabled: boolean;
+    paused: boolean;
+    borrowingInIsolation: boolean;
+    siloedBorrowingEnabled: boolean;
+    flashloaningEnabled: boolean;
+    reserveFactor: bigint;
+    borrowCap: bigint;
+    supplyCap: bigint;
+    liquidationProtocolFee: bigint;
+    unbackedMintCap: bigint;
+    debtCeiling: bigint;
+    virtualAccountingEnabled: boolean;
+};
+/**
+ * ReserveConfiguration is a tightly packed struct that contains the configuration of a reserve
+ * @param data
+ * @returns the decoded ReserveConfiguration
+ */
+declare function decodeReserveConfiguration(data: bigint): ReserveConfiguration;
+declare function decodeReserveConfigurationV2(data: bigint): {
+    ltv: bigint;
+    liquidationThreshold: bigint;
+    liquidationBonus: bigint;
+    decimals: bigint;
+    active: boolean;
+    frozen: boolean;
+    borrowingEnabled: boolean;
+    stableBorrowingEnabled: boolean;
+    reserveFactor: bigint;
+};
+
+declare const SECONDS_PER_YEAR = 31536000n;
+declare const LTV_PRECISION = 4n;
+
+interface CalculateCompoundedInterestRequest {
+    rate: bigint;
+    currentTimestamp: number;
+    lastUpdateTimestamp: number;
+}
+declare function calculateCompoundedInterest({ rate, currentTimestamp, lastUpdateTimestamp, }: CalculateCompoundedInterestRequest): bigint;
+interface LinearInterestRequest {
+    rate: bigint;
+    currentTimestamp: number;
+    lastUpdateTimestamp: number;
+}
+declare function calculateLinearInterest({ rate, currentTimestamp, lastUpdateTimestamp, }: LinearInterestRequest): bigint;
+interface NormalizedIncomeRequest {
+    rate: bigint;
+    index: bigint;
+    lastUpdateTimestamp: number;
+    currentTimestamp: number;
+}
+declare function getNormalizedIncome({ rate, index, lastUpdateTimestamp, currentTimestamp, }: NormalizedIncomeRequest): bigint;
+declare function getNormalizedDebt({ rate, index, currentTimestamp, lastUpdateTimestamp, }: NormalizedIncomeRequest): bigint;
+interface CurrentBalanceRequest {
+    scaledBalance: bigint;
+    index: bigint;
+    rate: bigint;
+    lastUpdateTimestamp: number;
+    currentTimestamp: number;
+}
+declare function getCurrentLiquidityBalance({ scaledBalance, index, rate, lastUpdateTimestamp, currentTimestamp, }: CurrentBalanceRequest): bigint;
+declare function getCurrentDebtBalance({ index, scaledBalance, rate, lastUpdateTimestamp, currentTimestamp, }: CurrentBalanceRequest): bigint;
+interface HealthFactorFromBalanceRequest {
+    collateralBalanceMarketReferenceCurrency: bigint;
+    borrowBalanceMarketReferenceCurrency: bigint;
+    averageLiquidationThreshold: bigint;
+}
+declare function calculateHealthFactorFromBalances({ borrowBalanceMarketReferenceCurrency, collateralBalanceMarketReferenceCurrency, averageLiquidationThreshold, }: HealthFactorFromBalanceRequest): bigint;
+interface AvailableBorrowsMarketReferenceCurrencyRequest {
+    collateralBalanceMarketReferenceCurrency: bigint;
+    borrowBalanceMarketReferenceCurrency: bigint;
+    currentLtv: bigint;
+}
+declare function calculateAvailableBorrowsMarketReferenceCurrency({ collateralBalanceMarketReferenceCurrency, borrowBalanceMarketReferenceCurrency, currentLtv, }: AvailableBorrowsMarketReferenceCurrencyRequest): bigint;
+interface MarketReferenceCurrencyAndUsdBalanceRequest {
+    balance: bigint;
+    priceInMarketReferenceCurrency: bigint;
+    marketReferenceCurrencyDecimals: number;
+    decimals: number;
+    marketReferencePriceInUsdNormalized: bigint;
+}
+interface MarketReferenceAndUsdBalanceResponse {
+    marketReferenceCurrencyBalance: bigint;
+    usdBalance: bigint;
+}
+/**
+ * @returns non humanized/normalized values for usd/marketReference
+ */
+declare function getMarketReferenceCurrencyAndUsdBalance({ balance, priceInMarketReferenceCurrency, marketReferenceCurrencyDecimals, decimals, marketReferencePriceInUsdNormalized, }: MarketReferenceCurrencyAndUsdBalanceRequest): MarketReferenceAndUsdBalanceResponse;
+
+declare const WAD: bigint;
+declare const HALF_WAD: bigint;
+declare const RAY: bigint;
+declare const HALF_RAY: bigint;
+declare const WAD_RAY_RATIO: bigint;
+declare function rayMul(a: bigint, b: bigint): bigint;
+declare function rayDiv(a: bigint, b: bigint): bigint;
+declare function rayToWad(a: bigint): bigint;
+declare function wadToRay(a: bigint): bigint;
+declare function wadDiv(a: bigint, b: bigint): bigint;
+
+declare enum PayloadState {
+    None = 0,
+    Created = 1,
+    Queued = 2,
+    Executed = 3,
+    Cancelled = 4,
+    Expired = 5
+}
+declare const HUMAN_READABLE_PAYLOAD_STATE: {
+    0: string;
+    1: string;
+    2: string;
+    3: string;
+    4: string;
+    5: string;
+};
+type PayloadsControllerContract = GetContractReturnType<typeof IPayloadsControllerCore_ABI, Client>;
+declare function getPayloadsController<T extends Client>(client: T, address: Hex): PayloadsControllerContract;
+declare function makePayloadExecutableOnTestClient(client: TestClient, payloadsController: Address, payloadId: number): Promise<void>;
+declare function getNonFinalizedPayloads<T extends Client>(client: T, payloadsController: Address): Promise<number[]>;
+
+declare enum ProposalState {
+    Null = 0,// proposal does not exists
+    Created = 1,// created, waiting for a cooldown to initiate the balances snapshot
+    Active = 2,// balances snapshot set, voting in progress
+    Queued = 3,// voting results submitted, but proposal is under grace period when guardian can cancel it
+    Executed = 4,// results sent to the execution chain(s)
+    Failed = 5,// voting was not successful
+    Cancelled = 6,// got cancelled by guardian, or because proposition power of creator dropped below allowed minimum
+    Expired = 7
+}
+declare const HUMAN_READABLE_PROPOSAL_STATE: {
+    0: string;
+    1: string;
+    2: string;
+    3: string;
+    4: string;
+    5: string;
+    6: string;
+    7: string;
+};
+type GovernanceContract = GetContractReturnType<typeof IGovernanceCore_ABI, Client>;
+declare function getGovernance<T extends Client>(client: T, address: Hex): GovernanceContract;
+declare function makeProposalExecutableOnTestClient(client: TestClient, governance: Address, proposalId: bigint): Promise<void>;
+
 type ExplorerConfig = {
     api: string;
     explorer: string;
@@ -81,6 +245,61 @@ declare function parseApiSourceCode(sourceCode: string): {
     }>;
 };
 
+/**
+ * While tenderly is a fenomanal tool for testing, it is not always easy to use as there are minor bugs and small nuances to consider everywhere.
+ * This is a simple wrapper around the tenderly APIs.
+ */
+
+type TenderlyConfig = {
+    accountSlug: string;
+    projectSlug: string;
+    accessToken: string;
+};
+type Tenderly_createVnetParams = {
+    slug: string;
+    displayName: string;
+    baseChainId: number;
+    forkChainId: number;
+    blockNumber?: Hex;
+};
+type Tenderly_createVnetParamsResponse = {
+    id: string;
+    slug: string;
+    display_name: number;
+    fork_config: {
+        network_id: number;
+        block_number: Hex;
+    };
+    virtual_network_config: {
+        chain_config: {
+            chain_id: number;
+        };
+        accounts: {
+            address: string;
+        }[];
+    };
+    rpcs: [
+        {
+            url: string;
+            name: "Admin RPC";
+        },
+        {
+            url: string;
+            name: "Public RPC";
+        }
+    ];
+};
+declare function tenderly_createVnet({ slug, displayName, baseChainId, forkChainId, blockNumber, }: Tenderly_createVnetParams, { accessToken, accountSlug, projectSlug }: TenderlyConfig): Promise<{
+    vnet: Tenderly_createVnetParamsResponse;
+    testClient: TestClient;
+    walletClient: WalletClient;
+    simulate: (body: any) => Promise<Response>;
+    delete: () => Promise<Response>;
+}>;
+
+declare const erc1967_ImplementationSlot = "0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc";
+declare const erc1967_AdminSlot = "0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103";
+
 declare function diffCode(codeBefore: string, codeAfter: string): Promise<Record<string, string>>;
 
-export { type ExplorerConfig, bitmapToIndexes, decodeUserConfiguration, diffCode, getBits, getExplorer, getSourceCode, parseApiSourceCode };
+export { type ExplorerConfig, type GovernanceContract, HALF_RAY, HALF_WAD, HUMAN_READABLE_PAYLOAD_STATE, HUMAN_READABLE_PROPOSAL_STATE, LTV_PRECISION, PayloadState, type PayloadsControllerContract, ProposalState, RAY, type ReserveConfiguration, SECONDS_PER_YEAR, type Tenderly_createVnetParamsResponse, WAD, WAD_RAY_RATIO, bitmapToIndexes, calculateAvailableBorrowsMarketReferenceCurrency, calculateCompoundedInterest, calculateHealthFactorFromBalances, calculateLinearInterest, decodeReserveConfiguration, decodeReserveConfigurationV2, decodeUserConfiguration, diffCode, erc1967_AdminSlot, erc1967_ImplementationSlot, getBits, getCurrentDebtBalance, getCurrentLiquidityBalance, getExplorer, getGovernance, getMarketReferenceCurrencyAndUsdBalance, getNonFinalizedPayloads, getNormalizedDebt, getNormalizedIncome, getPayloadsController, getSourceCode, makePayloadExecutableOnTestClient, makeProposalExecutableOnTestClient, parseApiSourceCode, rayDiv, rayMul, rayToWad, setBits, tenderly_createVnet, wadDiv, wadToRay };