dequanto 0.2.52 → 0.2.55

package/src/solidity/SlotsParser/models.ts

@@ -1,3 +1,4 @@
+import { TEth } from 'dequanto/models/TEth'
 import type { SourceFile } from './SourceFile'
 
 export type TSourceFileImport = {
@@ -8,7 +9,7 @@ export type TSourceFileImport = {
 
 
 export interface ISlotVarDefinition {
-    slot: number
+    slot: bigint
     position: number
     name: string
     type: string
@@ -20,6 +21,9 @@ export interface ISlotVarDefinition {
 }
 
 
+/** Slot definitions accepted from callers, including older generated readers. */
+export type ISlotVarDefinitionInput = Omit<ISlotVarDefinition, 'slot'> & { slot: number | bigint |  TEth.Hex | string };
+
 export interface ISlotsParserOption {
     /* Optionally provide additional sources in memory */
     files?: { path: string, content: string }[]

package/src/solidity/SlotsParser.ts

@@ -4,7 +4,9 @@ import type {
     ArrayTypeName,
     ContractDefinition,
     ElementaryTypeName,
+    Expression,
     Mapping,
+    StateVariableDeclarationVariable,
     StructDefinition,
     TypeName,
     UserDefinedTypeName
@@ -19,6 +21,7 @@ import { Ast } from './SlotsParser/Ast';
 import { ISlotsParserOption, ISlotVarDefinition } from './SlotsParser/models';
 
 import type { TAbiInput } from 'dequanto/types/TAbi';
+import { $bigint } from 'dequanto/utils/$bigint';
 
 const SLOT_SIZE = 256;
 export namespace SlotsParser {
@@ -34,7 +37,7 @@ export namespace SlotsParser {
                 let util = TypeAbiUtil.get(input)
                 if (util) {
                     return {
-                        slot: null as number,
+                        slot: null as bigint,
                         position: null as number,
                         name: input.name,
                         size: await util.sizeOf(),
@@ -81,10 +84,20 @@ export namespace SlotsParser {
             })
             .toArray();
 
-        let offset = { slot: 0, position: 0 };
+        let offset = { slot: 0n, position: 0 };
+        let contract = inheritanceChain[inheritanceChain.length - 1]?.contract;
+        if (Ast.isContractDefinition(contract) && contract.storageLayout != null) {
+            // The most derived contract sets the base slot for the entire inheritance chain.
+            let baseSlot = $require.notNull(Ast.evaluate<bigint>(contract.storageLayout), `StorageLayout eval failed`);
+            if (baseSlot < 0n || baseSlot >= 2n ** 256n) {
+                throw new Error('Custom storage layout must be within the uint256 slot range');
+            }
+            offset.slot = baseSlot;
+        }
         slotsDef = applyPositions(slotsDef, offset);
         return slotsDef;
     }
+
     async function extractSlotsSingle (contract: TypeUtil.ITypeCtx, opts?: {
         withConstants?: boolean
         withImmutables?: boolean
@@ -92,6 +105,9 @@ export namespace SlotsParser {
 
         let vars = Ast.isStructDefinition(contract.contract) ? contract.contract.members : alot(Ast.getVariableDeclarations(contract.contract))
             .map($var => {
+                if (($var as StateVariableDeclarationVariable).isTransient) {
+                    return null;
+                }
                 if ($var.isDeclaredConst && opts?.withConstants !== true) {
                     return null;
                 }
@@ -108,7 +124,7 @@ export namespace SlotsParser {
                 let util = TypeUtil.get(v.typeName, contract);
                 if (util) {
                     let $var = {
-                        slot: null as number,
+                        slot: null as bigint,
                         position: null as number,
                         name: v.name,
                         size: await util.sizeOf(),
@@ -137,8 +153,8 @@ export namespace SlotsParser {
         return slotsDef;
     }
 
-    function applyPositions ($vars: ISlotVarDefinition[], offset?: { slot: number, position: number }) {
-        offset ??= { slot: 0, position: 0 };
+    function applyPositions ($vars: ISlotVarDefinition[], offset?: { slot: number | bigint, position: number }) {
+        let cursor = { slot: BigInt(offset?.slot ?? 0), position: offset?.position ?? 0 };
 
         $vars.forEach($var => {
             if ($var.memory === 'constant' || $var.memory === 'immutable') {
@@ -146,38 +162,38 @@ export namespace SlotsParser {
                 return;
             }
             if ($var.size === Infinity) {
-                if (offset.position > 0) {
+                if (cursor.position > 0) {
                     // was previously moved further in a slot, so just take the next slot
-                    offset.position = 0;
-                    offset.slot += 1;
+                    cursor.position = 0;
+                    cursor.slot += 1n;
                 }
 
-                $var.slot = offset.slot;
+                $var.slot = cursor.slot;
                 $var.position = 0;
 
                 // move to the start of the next slot
-                offset.slot += 1;
-                offset.position = 0;
+                cursor.slot += 1n;
+                cursor.position = 0;
                 return;
             }
-            if ($var.size <= SLOT_SIZE - offset.position && TypeUtil.isComplexType($var.type) === false) {
-                $var.slot = offset.slot;
-                $var.position = offset.position;
-                offset.position += $var.size;
+            if ($var.size <= SLOT_SIZE - cursor.position && TypeUtil.isComplexType($var.type) === false) {
+                $var.slot = cursor.slot;
+                $var.position = cursor.position;
+                cursor.position += $var.size;
                 return;
             }
-            if (offset.position > 0) {
-                offset.slot += 1;
-                offset.position = 0;
+            if (cursor.position > 0) {
+                cursor.slot += 1n;
+                cursor.position = 0;
                 // > moves to next slot
             }
-            $var.slot = offset.slot;
-            $var.position = offset.position;
+            $var.slot = cursor.slot;
+            $var.position = cursor.position;
 
             let slots = Math.floor($var.size / SLOT_SIZE);
 
-            offset.slot += slots;
-            offset.position = $var.size % SLOT_SIZE;
+            cursor.slot += BigInt(slots);
+            cursor.position = $var.size % SLOT_SIZE;
         });
         return $vars;
     }

package/src/solidity/SlotsStorage.ts

@@ -13,7 +13,7 @@ import { SlotMappingHandler } from './storage/handlers/SlotMappingHandler';
 import { SlotStringHandler } from './storage/handlers/SlotStringHandler';
 import { Accessor, IAccessorItem } from './storage/Accessor';
 import { SlotStructHandler } from './storage/handlers/SlotStructHandler';
-import { ISlotVarDefinition } from './SlotsParser/models';
+import { ISlotVarDefinition, ISlotVarDefinitionInput } from './SlotsParser/models';
 import { $types } from './utils/$types';
 import { SlotBytesHandler } from './storage/handlers/SlotBytesHandler';
 import { SlotValueConstantHandler } from './storage/handlers/SlotValueConstantHandler';
@@ -22,7 +22,7 @@ import { TEth } from 'dequanto/models/TEth';
 
 export class SlotsStorage {
 
-    static createWithClient(client: Web3Client, address: TAddress, slots: ISlotVarDefinition[], params?: {
+    static createWithClient(client: Web3Client, address: TAddress, slots: ISlotVarDefinitionInput[], params?: {
         blockNumber?: number
         storageOffset?: TEth.Hex | bigint
     }) {
@@ -35,8 +35,13 @@ export class SlotsStorage {
         return new SlotsStorage(transport, slots)
     }
 
-    constructor(public transport: ISlotsStorageTransport, public slots: ISlotVarDefinition[]) {
+    public slots: ISlotVarDefinition[];
 
+    constructor(public transport: ISlotsStorageTransport, slots: ISlotVarDefinitionInput[]) {
+        this.slots = slots.map(slot => ({
+            ...slot,
+            slot: slot.slot == null ? null : BigInt(slot.slot)
+        }));
     }
 
     async get<T = any>(path?: string | (string | number | bigint)[] |IAccessorItem[]): Promise<T> {

package/src/solidity/storage/SlotsStorageTransport.ts

@@ -56,7 +56,7 @@ export class SlotsCursorTransport implements ISlotsStorageTransport {
         return this.transport.extractMappingKeys(ctx)
     }
 
-    mapToGlobalSlot (slot = 0) {
+    mapToGlobalSlot (slot: string | number | bigint = 0n) {
         return BigInt(this.cursor.slot) + BigInt(slot);
     }
 }
@@ -109,7 +109,7 @@ export class SlotsStorageTransport implements ISlotsStorageTransport {
         throw new Error(`SlotMappingReader does not support the fetchAll method, as the size could be infinite`);
     }
 
-    mapToGlobalSlot (slot = 0) {
+    mapToGlobalSlot (slot: string | number | bigint = 0n) {
         return BigInt(slot);
     }
 
@@ -122,26 +122,23 @@ export class SlotsStorageTransportForArray implements ISlotsStorageTransport {
 
 
 
-    constructor (public transport: ISlotsStorageTransport, private slotNr: number | bigint, private elementI: number = 0, private slotsPerElement: number = 1, private slot?: ISlotVarDefinition) {
+    constructor (public transport: ISlotsStorageTransport, private slotNr: number | bigint, private elementI: number = 0, private slotsPerElement: number | bigint = 1n, private slot?: ISlotVarDefinition) {
 
     }
 
     async getStorageAt (slot: string | number | bigint, position = 0, size = 256) {
-        if (typeof slot !== 'number') {
-            throw new Error(`Array slot reader supports only numeric positions. Slot ${slot}`);
-        }
         let location = this.mapToGlobalSlot(slot);
         let memory = await this.getUnderlyingTransport().getStorageAt(location, position, size);
         return memory;
     }
 
     async setStorageAt(slot: string | number | bigint, position: number, size: number, buffer: string | number | bigint | boolean): Promise<void> {
-        let location = this.mapToGlobalSlot(Number(slot));
+        let location = this.mapToGlobalSlot(BigInt(slot));
         let memory = await this.transport.setStorageAt(location, position, size, buffer);
         return memory;
     }
 
-    mapToGlobalSlot (slotPositionNr: number | bigint = 0) {
+    mapToGlobalSlot (slotPositionNr: string | number | bigint = 0n) {
         let packedRoot = this.transport?.mapToGlobalSlot(this.slotNr) ?? 0n;
         let packedNextHash = $abiUtils.encodePacked({
             value: $hex.padBytes($hex.toHexBuffer(packedRoot), 32),
@@ -165,7 +162,7 @@ export class SlotsStorageTransportForArray implements ISlotsStorageTransport {
 }
 
 export class SlotsStorageTransportForMapping implements ISlotsStorageTransport {
-    constructor (public transport: ISlotsStorageTransport, private slotNr: number, private key: any, private slotsPerElement: number = 1) {
+    constructor (public transport: ISlotsStorageTransport, private slotNr: number | bigint, private key: any, private slotsPerElement: number | bigint = 1n) {
 
     }
 

package/src/solidity/storage/handlers/SlotDynamicArrayHandler.ts

@@ -48,7 +48,7 @@ export class SlotDynamicArrayHandler extends ASlotDynamicArray {
         let baseSlots = await SlotsParser.slotsFromAbi(baseType);
 
         // take the last slot index as that one will give us the TOTAL SLOTs per element
-        let slotsPerElement = baseSlots[baseSlots.length - 1].slot + 1;
+        let slotsPerElement = baseSlots[baseSlots.length - 1].slot + 1n;
 
         let transport = new SlotsStorageTransportForArray(this.transport, this.slot.slot, key.key, slotsPerElement, this.slot);
         let storage = new SlotsStorage(transport, baseSlots);

package/src/utils/$bigint.ts

@@ -68,9 +68,12 @@ export namespace $bigint {
     }
 
     /**
-     * @param amount e.g "2.4 ether", "10 gwei", "1.7^18", "123456", "1.7e18"
+     * @param amount e.g "2.4 ether", "10 gwei", "1.7^18", "123456", "1.7e18", "1_000_000"
      */
     export function parse (amount: string): bigint {
+        // clean 1_000
+        amount = amount.replaceAll('_', '');
+
         if (/^\d+$/.test(amount) || $is.Hex(amount) ) {
             return BigInt(amount);
         }

package/tsconfig.json

@@ -1,7 +1,8 @@
 {
     "exclude": [
         "exports/core.lib.ts",
-        "ts-temp"
+        "ts-temp",
+        "lib/"
     ],
     "compilerOptions": {
         "baseUrl": "./",

package/lib/cjs/gen/Ast.js

@@ -1,14 +0,0 @@
-"use strict";
-//import parser from '@solidity-parser/parser';
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Ast = void 0;
-class Ast {
-    static parse(source) {
-        // let ast = parser.parse(source, {
-        //     tolerant: true,
-        // });
-    }
-}
-exports.Ast = Ast;
-//# sourceMappingURL=Ast.js.map
-//# sourceMappingURL=Ast.ts.map

package/lib/cjs/gen/Ast.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Ast.js","sourceRoot":"","sources":["../../../src/gen/Ast.ts"],"names":[],"mappings":";AAAA,+CAA+C;;;AAG/C,MAAa,GAAG;IAEZ,MAAM,CAAC,KAAK,CAAE,MAAc;QACxB,mCAAmC;QACnC,sBAAsB;QACtB,MAAM;IAEV,CAAC;CACJ;AARD,kBAQC"}

package/lib/esm/gen/Ast.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Ast.js","sourceRoot":"","sources":["../../../src/gen/Ast.ts"],"names":[],"mappings":";AAAA,+CAA+C;;;AAG/C,MAAa,GAAG;IAEZ,MAAM,CAAC,KAAK,CAAE,MAAc;QACxB,mCAAmC;QACnC,sBAAsB;QACtB,MAAM;IAEV,CAAC;CACJ;AARD,kBAQC"}

package/lib/esm/gen/Ast.mjs

@@ -1,10 +0,0 @@
-//import parser from '@solidity-parser/parser';
-export class Ast {
-    static parse(source) {
-        // let ast = parser.parse(source, {
-        //     tolerant: true,
-        // });
-    }
-}
-//# sourceMappingURL=Ast.js.map
-//# sourceMappingURL=Ast.ts.map

package/lib/types/gen/Ast.d.ts

@@ -1,3 +0,0 @@
-export declare class Ast {
-    static parse(source: string): void;
-}

package/src/gen/Ast.ts

@@ -1,12 +0,0 @@
-//import parser from '@solidity-parser/parser';
-
-
-export class Ast {
-
-    static parse (source: string) {
-        // let ast = parser.parse(source, {
-        //     tolerant: true,
-        // });
-
-    }
-}