@bgd-labs/toolbox 0.0.0

package/dist/index.d.mts

@@ -0,0 +1,88 @@
+import { Address, Hex } from 'viem';
+
+/**
+ * In solidity it is a quite common practice to encode bit variables in bitmaps opposed to bool structs.
+ * The reason for this is that solidity will pack one boolean per byte, while with a bitmap, one can pack one bit.. per bit.
+ * These utilities help with extracting the indexes of a given bitmap.
+ */
+/**
+ * Decodes a bitmap as an array of indexes.
+ * @param bitmap The bitmap
+ * @returns an array of indexes
+ */
+declare function bitmapToIndexes(bitmap: bigint): number[];
+/**
+ * Returns the selected bits of a uint256 as bigint
+ * @param uint256
+ * @param startBit
+ * @param endBit
+ * @returns
+ */
+declare function getBits(uint256: bigint, startBit: bigint, _endBit: bigint): bigint;
+
+/**
+ * The userConfiguration on aave is stored as an alteranting bitmap.
+ * The least significant bit starts with borrowing on reserve 0
+ * In practice this means that the following bitmap b'1011 would mean a user
+ * is borrowing(bit 0) reserve 0, and supplies(bit 1,3) collateral on reserve 0 and 1
+ * @param userConfiguration bitmap
+ */
+declare function decodeUserConfiguration(userConfiguration: bigint): {
+    borrowedAssetIds: number[];
+    collateralAssetIds: number[];
+};
+
+type ExplorerConfig = {
+    api: string;
+    explorer: string;
+};
+/**
+ * Fetches what we consider the "best" explorer for a given chain.
+ * For our tooling we have a opinionated priorization for explorers:
+ * 1. Etherscan
+ * 2. Routescan
+ * 3. Blockscout and others
+ * @param chainId Id of the chain to fetch the explorer for
+ */
+declare function getExplorer(chainId: number): ExplorerConfig;
+type GetSourceCodeParams = {
+    chainId: number;
+    address: Address;
+    apiUrl?: string;
+    apiKey?: string;
+};
+declare function getSourceCode(params: GetSourceCodeParams): Promise<{
+    message: string;
+    result: {
+        ABI: any;
+        CompilerVersion: string;
+        ConstructorArguments: Hex;
+        ContractName: string;
+        EVMVersion: string;
+        Implementation: Address;
+        Library: string;
+        LicenseType: string;
+        OptimizationUsed: string;
+        Proxy: string;
+        Runs: string;
+        SimilarMatch: string;
+        SourceCode: string;
+    }[];
+    status: string;
+}>;
+declare function parseApiSourceCode(sourceCode: string): {
+    language: string;
+    libraries: any;
+    settings: {
+        evmVersion: string;
+        optimizer: {
+            enabled: boolean;
+            runs: number;
+        };
+    };
+    sources: Record<string, {
+        content: string;
+    }>;
+};
+
+export { type ExplorerConfig, bitmapToIndexes, decodeUserConfiguration, getBits, getExplorer, getSourceCode, parseApiSourceCode };

package/dist/index.d.ts

@@ -0,0 +1,88 @@
+import { Address, Hex } from 'viem';
+
+/**
+ * In solidity it is a quite common practice to encode bit variables in bitmaps opposed to bool structs.
+ * The reason for this is that solidity will pack one boolean per byte, while with a bitmap, one can pack one bit.. per bit.
+ * These utilities help with extracting the indexes of a given bitmap.
+ */
+/**
+ * Decodes a bitmap as an array of indexes.
+ * @param bitmap The bitmap
+ * @returns an array of indexes
+ */
+declare function bitmapToIndexes(bitmap: bigint): number[];
+/**
+ * Returns the selected bits of a uint256 as bigint
+ * @param uint256
+ * @param startBit
+ * @param endBit
+ * @returns
+ */
+declare function getBits(uint256: bigint, startBit: bigint, _endBit: bigint): bigint;
+
+/**
+ * The userConfiguration on aave is stored as an alteranting bitmap.
+ * The least significant bit starts with borrowing on reserve 0
+ * In practice this means that the following bitmap b'1011 would mean a user
+ * is borrowing(bit 0) reserve 0, and supplies(bit 1,3) collateral on reserve 0 and 1
+ * @param userConfiguration bitmap
+ */
+declare function decodeUserConfiguration(userConfiguration: bigint): {
+    borrowedAssetIds: number[];
+    collateralAssetIds: number[];
+};
+
+type ExplorerConfig = {
+    api: string;
+    explorer: string;
+};
+/**
+ * Fetches what we consider the "best" explorer for a given chain.
+ * For our tooling we have a opinionated priorization for explorers:
+ * 1. Etherscan
+ * 2. Routescan
+ * 3. Blockscout and others
+ * @param chainId Id of the chain to fetch the explorer for
+ */
+declare function getExplorer(chainId: number): ExplorerConfig;
+type GetSourceCodeParams = {
+    chainId: number;
+    address: Address;
+    apiUrl?: string;
+    apiKey?: string;
+};
+declare function getSourceCode(params: GetSourceCodeParams): Promise<{
+    message: string;
+    result: {
+        ABI: any;
+        CompilerVersion: string;
+        ConstructorArguments: Hex;
+        ContractName: string;
+        EVMVersion: string;
+        Implementation: Address;
+        Library: string;
+        LicenseType: string;
+        OptimizationUsed: string;
+        Proxy: string;
+        Runs: string;
+        SimilarMatch: string;
+        SourceCode: string;
+    }[];
+    status: string;
+}>;
+declare function parseApiSourceCode(sourceCode: string): {
+    language: string;
+    libraries: any;
+    settings: {
+        evmVersion: string;
+        optimizer: {
+            enabled: boolean;
+            runs: number;
+        };
+    };
+    sources: Record<string, {
+        content: string;
+    }>;
+};
+
+export { type ExplorerConfig, bitmapToIndexes, decodeUserConfiguration, getBits, getExplorer, getSourceCode, parseApiSourceCode };