@subsquid/evm-codec 0.3.0 → 1.0.0

package/lib/src/hex.js

@@ -0,0 +1,164 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HexSrc = void 0;
+const codec_1 = require("../codec");
+const HEX_BYTE = 2;
+const WORD_HEX = codec_1.WORD_SIZE * HEX_BYTE;
+const I64_SIGN_BIT = 1n << 63n;
+const I64_RANGE = 1n << 64n;
+const I128_SIGN_BIT = 1n << 127n;
+const I128_RANGE = 1n << 128n;
+const I256_SIGN_BIT = 1n << 255n;
+const I256_RANGE = 1n << 256n;
+const TEXT_DECODER = new TextDecoder('utf-8');
+class HexSrc {
+    buf;
+    base;
+    endChar;
+    pos;
+    oldPos;
+    constructor(hex, strOffset = 2, strEnd = hex.length) {
+        this.buf = hex;
+        this.base = strOffset;
+        this.endChar = strEnd;
+        this.pos = strOffset;
+        this.oldPos = strOffset;
+    }
+    slice(start, end) {
+        const s = this.base + HEX_BYTE * start;
+        const e = end == null ? this.endChar : this.base + HEX_BYTE * end;
+        return new HexSrc(this.buf, s, e);
+    }
+    u8() {
+        const start = this.pos + WORD_HEX - 2;
+        const val = Number.parseInt(this.buf.slice(start, start + 2), 16);
+        this.pos += WORD_HEX;
+        return val;
+    }
+    i8() {
+        return Number(this.i256());
+    }
+    u16() {
+        const start = this.pos + WORD_HEX - 4;
+        const val = Number.parseInt(this.buf.slice(start, start + 4), 16);
+        this.pos += WORD_HEX;
+        return val;
+    }
+    i16() {
+        return Number(this.i256());
+    }
+    u32() {
+        const start = this.pos + WORD_HEX - 8;
+        const val = Number.parseInt(this.buf.slice(start, start + 8), 16);
+        this.pos += WORD_HEX;
+        return val;
+    }
+    i32() {
+        return Number(this.i256());
+    }
+    u64() {
+        const start = this.pos + WORD_HEX - 16;
+        const val = BigInt(`0x${this.buf.slice(start, start + 16)}`);
+        this.pos += WORD_HEX;
+        return val;
+    }
+    i64() {
+        const raw = this.u64();
+        return raw < I64_SIGN_BIT ? raw : raw - I64_RANGE;
+    }
+    u128() {
+        const start = this.pos + WORD_HEX - 32;
+        const val = BigInt(`0x${this.buf.slice(start, start + 32)}`);
+        this.pos += WORD_HEX;
+        return val;
+    }
+    i128() {
+        const raw = this.u128();
+        return raw < I128_SIGN_BIT ? raw : raw - I128_RANGE;
+    }
+    u256() {
+        const val = BigInt(`0x${this.buf.slice(this.pos, this.pos + WORD_HEX)}`);
+        this.pos += WORD_HEX;
+        return val;
+    }
+    i256() {
+        const raw = this.u256();
+        return raw < I256_SIGN_BIT ? raw : raw - I256_RANGE;
+    }
+    address() {
+        const start = this.pos + WORD_HEX - 40;
+        const val = `0x${this.buf.slice(start, start + 40)}`;
+        this.pos += WORD_HEX;
+        return val;
+    }
+    bytes() {
+        const ptr = this.u32();
+        this.jump(ptr);
+        const len = Number(this.u256());
+        this.#assertLength(len, 'bytes');
+        const sub = this.buf.slice(this.pos, this.pos + HEX_BYTE * len);
+        const val = Buffer.from(sub, 'hex');
+        this.jumpBack();
+        return val;
+    }
+    bytesHex() {
+        const ptr = this.u32();
+        this.jump(ptr);
+        const len = Number(this.u256());
+        this.#assertLength(len, 'bytes');
+        const val = `0x${this.buf.slice(this.pos, this.pos + HEX_BYTE * len)}`;
+        this.jumpBack();
+        return val;
+    }
+    staticBytes(len) {
+        if (len > 32) {
+            throw new Error(`bytes${len} is not a valid type`);
+        }
+        const sub = this.buf.slice(this.pos, this.pos + HEX_BYTE * len);
+        this.pos += WORD_HEX;
+        return Buffer.from(sub, 'hex');
+    }
+    staticBytesHex(len) {
+        if (len > 32) {
+            throw new Error(`bytes${len} is not a valid type`);
+        }
+        const val = `0x${this.buf.slice(this.pos, this.pos + HEX_BYTE * len)}`;
+        this.pos += WORD_HEX;
+        return val;
+    }
+    string() {
+        const ptr = this.u32();
+        this.jump(ptr, 'string');
+        const len = Number(this.u256());
+        this.#assertLength(len, 'string');
+        const sub = this.buf.slice(this.pos, this.pos + HEX_BYTE * len);
+        const val = TEXT_DECODER.decode(Buffer.from(sub, 'hex'));
+        this.jumpBack();
+        return val;
+    }
+    bool() {
+        const a = this.buf.charCodeAt(this.pos + WORD_HEX - 2);
+        const b = this.buf.charCodeAt(this.pos + WORD_HEX - 1);
+        this.pos += WORD_HEX;
+        return a !== 48 /* '0' */ || b !== 48;
+    }
+    #assertLength(len, typeName) {
+        if (this.endChar - this.pos < HEX_BYTE * len) {
+            throw new RangeError(`Unexpected end of input. Attempting to read ${typeName} of length ${len} from 0x${this.buf.slice(this.base, this.endChar)}`);
+        }
+    }
+    jump(pos, typeName) {
+        const target = this.base + HEX_BYTE * pos;
+        if (pos < 0 || target >= this.endChar) {
+            const what = typeName ? `${typeName} ` : '';
+            throw new RangeError(`Unexpected pointer location: 0x${pos.toString(16)}. Attempting to read ${what}from 0x${this.buf.slice(this.base, this.endChar)}`);
+        }
+        this.oldPos = this.pos;
+        this.pos = target;
+    }
+    jumpBack() {
+        this.pos = this.oldPos;
+    }
+}
+exports.HexSrc = HexSrc;
+//# sourceMappingURL=hex.js.map

package/lib/src/hex.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hex.js","sourceRoot":"","sources":["../../src/src/hex.ts"],"names":[],"mappings":";;;AAAA,oCAA4C;AAE5C,MAAM,QAAQ,GAAG,CAAC,CAAA;AAClB,MAAM,QAAQ,GAAG,iBAAS,GAAG,QAAQ,CAAA;AAErC,MAAM,YAAY,GAAG,EAAE,IAAI,GAAG,CAAA;AAC9B,MAAM,SAAS,GAAG,EAAE,IAAI,GAAG,CAAA;AAC3B,MAAM,aAAa,GAAG,EAAE,IAAI,IAAI,CAAA;AAChC,MAAM,UAAU,GAAG,EAAE,IAAI,IAAI,CAAA;AAC7B,MAAM,aAAa,GAAG,EAAE,IAAI,IAAI,CAAA;AAChC,MAAM,UAAU,GAAG,EAAE,IAAI,IAAI,CAAA;AAE7B,MAAM,YAAY,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,CAAA;AAE7C,MAAa,MAAM;IACE,GAAG,CAAQ;IACX,IAAI,CAAQ;IACZ,OAAO,CAAQ;IACxB,GAAG,CAAQ;IACX,MAAM,CAAQ;IAEtB,YAAY,GAAW,EAAE,SAAS,GAAG,CAAC,EAAE,SAAiB,GAAG,CAAC,MAAM;QAC/D,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,SAAS,CAAA;QACrB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,IAAI,CAAC,GAAG,GAAG,SAAS,CAAA;QACpB,IAAI,CAAC,MAAM,GAAG,SAAS,CAAA;IAC3B,CAAC;IAED,KAAK,CAAC,KAAa,EAAE,GAAY;QAC7B,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,GAAG,QAAQ,GAAG,KAAK,CAAA;QACtC,MAAM,CAAC,GAAG,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,GAAG,QAAQ,GAAG,GAAG,CAAA;QACjE,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IACrC,CAAC;IAED,EAAE;QACE,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,GAAG,QAAQ,GAAG,CAAC,CAAA;QACrC,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;QACjE,IAAI,CAAC,GAAG,IAAI,QAAQ,CAAA;QACpB,OAAO,GAAG,CAAA;IACd,CAAC;IAED,EAAE;QACE,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;IAC9B,CAAC;IAED,GAAG;QACC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,GAAG,QAAQ,GAAG,CAAC,CAAA;QACrC,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;QACjE,IAAI,CAAC,GAAG,IAAI,QAAQ,CAAA;QACpB,OAAO,GAAG,CAAA;IACd,CAAC;IAED,GAAG;QACC,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;IAC9B,CAAC;IAED,GAAG;QACC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,GAAG,QAAQ,GAAG,CAAC,CAAA;QACrC,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;QACjE,IAAI,CAAC,GAAG,IAAI,QAAQ,CAAA;QACpB,OAAO,GAAG,CAAA;IACd,CAAC;IAED,GAAG;QACC,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;IAC9B,CAAC;IAED,GAAG;QACC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,GAAG,QAAQ,GAAG,EAAE,CAAA;QACtC,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,EAAE,CAAC,EAAE,CAAC,CAAA;QAC5D,IAAI,CAAC,GAAG,IAAI,QAAQ,CAAA;QACpB,OAAO,GAAG,CAAA;IACd,CAAC;IAED,GAAG;QACC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACtB,OAAO,GAAG,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,SAAS,CAAA;IACrD,CAAC;IAED,IAAI;QACA,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,GAAG,QAAQ,GAAG,EAAE,CAAA;QACtC,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,EAAE,CAAC,EAAE,CAAC,CAAA;QAC5D,IAAI,CAAC,GAAG,IAAI,QAAQ,CAAA;QACpB,OAAO,GAAG,CAAA;IACd,CAAC;IAED,IAAI;QACA,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,EAAE,CAAA;QACvB,OAAO,GAAG,GAAG,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,UAAU,CAAA;IACvD,CAAC;IAED,IAAI;QACA,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAA;QACxE,IAAI,CAAC,GAAG,IAAI,QAAQ,CAAA;QACpB,OAAO,GAAG,CAAA;IACd,CAAC;IAED,IAAI;QACA,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,EAAE,CAAA;QACvB,OAAO,GAAG,GAAG,aAAa,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,UAAU,CAAA;IACvD,CAAC;IAED,OAAO;QACH,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,GAAG,QAAQ,GAAG,EAAE,CAAA;QACtC,MAAM,GAAG,GAAG,KAAK,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,GAAG,EAAE,CAAC,EAAE,CAAA;QACpD,IAAI,CAAC,GAAG,IAAI,QAAQ,CAAA;QACpB,OAAO,GAAG,CAAA;IACd,CAAC;IAED,KAAK;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACtB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QACd,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;QAC/B,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAChC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,GAAG,QAAQ,GAAG,GAAG,CAAC,CAAA;QAC/D,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QACnC,IAAI,CAAC,QAAQ,EAAE,CAAA;QACf,OAAO,GAAG,CAAA;IACd,CAAC;IAED,QAAQ;QACJ,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACtB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QACd,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;QAC/B,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAChC,MAAM,GAAG,GAAG,KAAK,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,GAAG,QAAQ,GAAG,GAAG,CAAC,EAAE,CAAA;QACtE,IAAI,CAAC,QAAQ,EAAE,CAAA;QACf,OAAO,GAAG,CAAA;IACd,CAAC;IAED,WAAW,CAAC,GAAW;QACnB,IAAI,GAAG,GAAG,EAAE,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,QAAQ,GAAG,sBAAsB,CAAC,CAAA;QACtD,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,GAAG,QAAQ,GAAG,GAAG,CAAC,CAAA;QAC/D,IAAI,CAAC,GAAG,IAAI,QAAQ,CAAA;QACpB,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;IAClC,CAAC;IAED,cAAc,CAAC,GAAW;QACtB,IAAI,GAAG,GAAG,EAAE,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,QAAQ,GAAG,sBAAsB,CAAC,CAAA;QACtD,CAAC;QACD,MAAM,GAAG,GAAG,KAAK,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,GAAG,QAAQ,GAAG,GAAG,CAAC,EAAE,CAAA;QACtE,IAAI,CAAC,GAAG,IAAI,QAAQ,CAAA;QACpB,OAAO,GAAG,CAAA;IACd,CAAC;IAED,MAAM;QACF,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACtB,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;QACxB,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;QAC/B,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;QACjC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,GAAG,QAAQ,GAAG,GAAG,CAAC,CAAA;QAC/D,MAAM,GAAG,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAA;QACxD,IAAI,CAAC,QAAQ,EAAE,CAAA;QACf,OAAO,GAAG,CAAA;IACd,CAAC;IAED,IAAI;QACA,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAA;QACtD,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAA;QACtD,IAAI,CAAC,GAAG,IAAI,QAAQ,CAAA;QACpB,OAAO,CAAC,KAAK,EAAE,CAAC,SAAS,IAAI,CAAC,KAAK,EAAE,CAAA;IACzC,CAAC;IAED,aAAa,CAAC,GAAW,EAAE,QAAgB;QACvC,IAAI,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,GAAG,QAAQ,GAAG,GAAG,EAAE,CAAC;YAC3C,MAAM,IAAI,UAAU,CAChB,+CAA+C,QAAQ,cAAc,GAAG,WAAW,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,CAC/H,CAAA;QACL,CAAC;IACL,CAAC;IAED,IAAI,CAAC,GAAW,EAAE,QAAiB;QAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,GAAG,QAAQ,GAAG,GAAG,CAAA;QACzC,IAAI,GAAG,GAAG,CAAC,IAAI,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACpC,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;YAC3C,MAAM,IAAI,UAAU,CAChB,kCAAkC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,wBAAwB,IAAI,UAAU,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,CACpI,CAAA;QACL,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAA;QACtB,IAAI,CAAC,GAAG,GAAG,MAAM,CAAA;IACrB,CAAC;IAED,QAAQ;QACJ,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,MAAM,CAAA;IAC1B,CAAC;CACJ;AAhLD,wBAgLC"}

package/lib/util.d.ts

@@ -0,0 +1,6 @@
+export type Pretty<T> = {
+    [K in keyof T]: T[K];
+} & unknown;
+export declare function propName(prop: string): string;
+export declare function propAccess(prop: string): string;
+//# sourceMappingURL=util.d.ts.map

package/lib/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI;KAAE,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAC,GAAG,OAAO,CAAA;AAExD,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAK7C;AAED,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAK/C"}

package/lib/util.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.propName = propName;
+exports.propAccess = propAccess;
+function propName(prop) {
+    if (isValidProperty(prop)) {
+        return prop;
+    }
+    return `[${JSON.stringify(prop)}]`;
+}
+function propAccess(prop) {
+    if (isValidProperty(prop)) {
+        return `.${prop}`;
+    }
+    return `[${JSON.stringify(prop)}]`;
+}
+function isValidProperty(s) {
+    return /^[a-zA-Z_$][0-9a-zA-Z_$]*$/.test(s);
+}
+//# sourceMappingURL=util.js.map

package/lib/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;AAEA,4BAKC;AAED,gCAKC;AAZD,SAAgB,QAAQ,CAAC,IAAY;IACjC,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAA;IACf,CAAC;IACD,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAA;AACtC,CAAC;AAED,SAAgB,UAAU,CAAC,IAAY;IACnC,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,IAAI,EAAE,CAAA;IACrB,CAAC;IACD,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAA;AACtC,CAAC;AAED,SAAS,eAAe,CAAC,CAAS;IAC9B,OAAO,4BAA4B,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;AAC/C,CAAC"}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@subsquid/evm-codec",
-  "version": "0.3.0",
+  "version": "1.0.0",
   "description": "EVM encoder/decoder tools",
   "license": "GPL-3.0-or-later",
-  "repository": "git@github.com:subsquid/squid.git",
+  "repository": "git@github.com:subsquid/squid-sdk.git",
   "publishConfig": {
     "access": "public"
   },
@@ -13,14 +13,12 @@
     "src"
   ],
   "dependencies": {
-    "@subsquid/util-internal-hex": "^1.2.2"
+    "@subsquid/util-internal-hex": "^1.2.3"
   },
   "devDependencies": {
-    "@types/node": "^18.18.14",
-    "ethers": "^6.9.0",
-    "typescript": "~5.3.2",
-    "viem": "^2.8.14",
-    "vitest": "^1.4.0"
+    "@types/node": "^24.0.0",
+    "typescript": "5.5.4",
+    "vitest": "4.1.5"
   },
   "scripts": {
     "build": "rm -rf lib && tsc -p tsconfig.build.json",

package/src/codec.ts

@@ -1,28 +1,74 @@
-import type { Sink } from './sink'
-import type { Src } from './src'
-
 export const WORD_SIZE = 32
 
 export type BaseType = 'int' | 'address' | 'bool' | 'bytes' | 'string' | 'array' | 'struct'
 
-export interface Codec<TIn, TOut = TIn> {
-  encode(sink: Sink, val: TIn): void
-  decode(src: Src): TOut
-  isDynamic: boolean
-  slotsCount?: number
-  baseType: BaseType
+/** ABI encoder backend — writes one 32-byte word per call, manages the head/tail structure. */
+export interface Sink {
+    u8(val: number): void
+    i8(val: number): void
+    u16(val: number): void
+    i16(val: number): void
+    u32(val: number): void
+    i32(val: number): void
+    u64(val: bigint): void
+    i64(val: bigint): void
+    u128(val: bigint): void
+    i128(val: bigint): void
+    u256(val: bigint): void
+    i256(val: bigint): void
+    bool(val: boolean): void
+    bytes(val: Uint8Array | string): void
+    staticBytes(len: number, val: Uint8Array | string): void
+    address(val: string): void
+    string(val: string): void
+    /** Begin the tail of a dynamic type (writes the head offset, enters tail context). */
+    openTail(slotsCount?: number): void
+    /** Begin the tail of a dynamic array (writes offset + element count, enters tail context). */
+    openArray(count: number): void
+    /** End the current tail, propagate its size to the parent context. */
+    closeTail(): void
+    toString(): string
 }
 
-export type Struct = {
-  [key: string]: Codec<any>
+/** ABI decoder backend — reads one 32-byte word per call, follows offset pointers. */
+export interface Src {
+    u8(): number
+    i8(): number
+    u16(): number
+    i16(): number
+    u32(): number
+    i32(): number
+    u64(): bigint
+    i64(): bigint
+    u128(): bigint
+    i128(): bigint
+    u256(): bigint
+    i256(): bigint
+    bool(): boolean
+    bytes(): Uint8Array
+    /** Decode a dynamic `bytes` value as a `0x`-prefixed hex string. */
+    bytesHex(): string
+    staticBytes(len: number): Uint8Array
+    /** Decode a `bytes<N>` value as a `0x`-prefixed hex string. */
+    staticBytesHex(len: number): string
+    address(): string
+    string(): string
+    /** Create a sub-view of this source starting at byte offset `start`. */
+    slice(start: number, end?: number): Src
+    /** Follow an offset pointer: save the current position and jump to `pos`. */
+    jump(pos: number, typeName?: string): void
+    /** Return to the position saved by the last `jump`. */
+    jumpBack(): void
 }
 
-type Pretty<T> = { [K in keyof T]: T[K] } & unknown
-
-export type DecodedStruct<T extends Struct> = Pretty<{
-  [K in keyof T]: T[K] extends Codec<any, infer U> ? U : never
-}>
+export interface Codec<TIn, TOut = TIn> {
+    encode(sink: Sink, val: TIn): void
+    decode(src: Src): TOut
+    isDynamic: boolean
+    slotsCount?: number
+    baseType: BaseType
+}
 
-export type EncodedStruct<T extends Struct> = Pretty<{
-  [K in keyof T]: T[K] extends Codec<infer U, any> ? U : never
-}>
+export type Struct = {
+    [key: string]: Codec<any>
+}

package/src/codecs/array.test.ts

@@ -0,0 +1,87 @@
+import {describe, expect, it} from 'vitest'
+import {address, array, bytes, fixedSizeArray, int8, BytesSink, BytesSrc, string, uint256} from '..'
+
+function roundtrip<T>(codec: {encode: (s: BytesSink, v: T) => void; decode: (s: BytesSrc) => T; slotsCount?: number}, value: T) {
+  const sink = new BytesSink(codec.slotsCount ?? 1)
+  codec.encode(sink, value)
+  expect(codec.decode(new BytesSrc(sink.result()))).toStrictEqual(value)
+}
+
+describe('fixed size array', () => {
+  it('static types', () => {
+    roundtrip(fixedSizeArray(int8, 5), [1, 2, -3, 4, 5])
+    roundtrip(fixedSizeArray(int8, 5), [1, 2, -3, -4, 5])
+  })
+
+  it('dynamic types', () => {
+    const arr = fixedSizeArray(string, 3)
+    roundtrip(arr, [
+      'aaa',
+      'a relatively long string to test what happens when the string is long, longer than 32 bytes or even better, longer than 64 bytes!!!',
+      'dasdas',
+    ])
+  })
+
+  it('deep nested arrays', () => {
+    const arr = fixedSizeArray(fixedSizeArray(string, 3), 2)
+    const data = [
+      'aaa',
+      'a relatively long string to test what happens when the string is long, longer than 32 bytes or even better, longer than 64 bytes!!!',
+      'dasdas',
+    ]
+    roundtrip(arr, [data, [...data].reverse()])
+  })
+})
+
+describe('dynamic size array', () => {
+  it('static types', () => {
+    roundtrip(array(int8), [1, 2, -3, 4, 5])
+    roundtrip(array(int8), [1, 2, -3, -4, 5])
+  })
+
+  it('array of arrays', () => {
+    roundtrip(array(array(int8)), [
+      [1, 2, -3, -4, 5],
+      [1, 2, -3, -4, 5],
+    ])
+  })
+
+  it('dynamic types', () => {
+    roundtrip(array(string), [
+      'aaa',
+      'a relatively long string to test what happens when the string is long, longer than 32 bytes or even better, longer than 64 bytes!!!',
+      'dasdas',
+    ])
+  })
+
+  it('hardcore dynamic types', () => {
+    const sink = new BytesSink(5)
+    const arr1 = array(array(fixedSizeArray(string, 3)))
+    const arr2 = array(array(uint256))
+    const arr3 = array(fixedSizeArray(bytes, 2))
+    const data1 = [
+      [
+        ['aaa', 'bbb', 'ccc'],
+        ['ddd', 'eee', 'fff'],
+      ],
+      [['ggg', 'hhh', 'iii']],
+    ]
+    const data2 = [[1n, 2n, 3n], [], [4n]]
+    const data3 = [
+      ['0x1234', '0x5678'],
+      ['0xdead', '0xbeef'],
+    ]
+    arr1.encode(sink, data1)
+    address.encode(sink, '0x1234567890123456789012345678901234567890')
+    arr3.encode(sink, data3)
+    arr2.encode(sink, data2)
+    uint256.encode(sink, 123n)
+
+    const src = new BytesSrc(sink.result())
+    expect(arr1.decode(src)).toStrictEqual(data1)
+    expect(address.decode(src)).toBe('0x1234567890123456789012345678901234567890')
+    expect(arr3.decode(src)).toStrictEqual(data3)
+    expect(arr2.decode(src)).toStrictEqual(data2)
+    expect(uint256.decode(src)).toBe(123n)
+  })
+})

package/src/codecs/array.ts

@@ -1,6 +1,4 @@
-import { Codec, WORD_SIZE } from '../codec'
-import { Sink } from '../sink'
-import { Src } from '../src'
+import { WORD_SIZE, type Codec, type Sink, type Src } from '../codec'
 
 export class ArrayCodec<const TIn, const TOut> implements Codec<readonly TIn[], readonly TOut[]> {
   public readonly isDynamic = true
@@ -8,20 +6,17 @@ export class ArrayCodec<const TIn, const TOut> implements Codec<readonly TIn[],
   constructor(public readonly item: Codec<TIn, TOut>) {}
 
   encode(sink: Sink, val: TIn[]) {
-    sink.newDynamicDataArea(val.length)
+    sink.openArray(val.length)
     for (let i = 0; i < val.length; i++) {
       this.item.encode(sink, val[i])
     }
-    sink.increaseCurrentDataAreaSize(WORD_SIZE)
-    sink.endCurrentDataArea()
+    sink.closeTail()
   }
 
   decode(src: Src): TOut[] {
     const offset = src.u32()
-
-    src.safeJump(offset, 'array')
+    src.jump(offset)
     const len = src.u32()
-
     const tmpSrc = src.slice(offset + WORD_SIZE)
     const val = new Array(len)
     for (let i = 0; i < val.length; i++) {
@@ -55,11 +50,11 @@ export class FixedSizeArrayCodec<const TIn, const TOut> implements Codec<readonl
   }
 
   private encodeDynamic(sink: Sink, val: TIn[]) {
-    sink.newStaticDataArea(this.size)
+    sink.openTail(this.size)
     for (let i = 0; i < val.length; i++) {
       this.item.encode(sink, val[i])
     }
-    sink.endCurrentDataArea()
+    sink.closeTail()
   }
 
   decode(src: Src): TOut[] {

package/src/codecs/primitives.test.ts

@@ -0,0 +1,27 @@
+import {describe, expect, it} from "vitest";
+import {bytes32, BytesSink, BytesSrc, string, uint256} from "..";
+
+describe('Strings', () => {
+  it('should encode and decode strings', async () => {
+    const sink = new BytesSink(1)
+    string.encode(sink, 'hello')
+    expect(sink.toString()).toEqual('0x0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000568656c6c6f000000000000000000000000000000000000000000000000000000')
+    expect(string.decode(new BytesSrc(sink.result()))).toEqual('hello');
+  });
+
+  it('should encode and decode empty string', async () => {
+    const sink = new BytesSink(1)
+    string.encode(sink, '')
+    expect(sink.toString()).toEqual('0x00000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000000000000000000000000000000000000')
+    expect(string.decode(new BytesSrc(sink.result()))).toEqual('');
+  });
+
+  it('should fail on decoding invalid data', async () => {
+    let sink = new BytesSink(1)
+    uint256.encode(sink, 1337)
+    expect(() => string.decode(new BytesSrc(sink.result()))).toThrow('Unexpected pointer location: 0x539. Attempting to read string from 0x0000000000000000000000000000000000000000000000000000000000000539')
+    sink = new BytesSink(1)
+    bytes32.encode(sink, '0x4b45590000000000000000000000000000000000000000000000000000000000')
+    expect(() => string.decode(new BytesSrc(sink.result()))).toThrow('Unexpected end of input. Attempting to read string of length 3.404599034663955e+76 from 0x4b45590000000000000000000000000000000000000000000000000000000000')
+  });
+});