admin: updated dist files

ethers-io · Jan 13, 2024 · 2f36f59 · 2f36f59
1 parent 1b4debd
commit 2f36f59
Show file tree

Hide file tree

Showing 34 changed files with 159 additions and 40 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,11 @@ Change Log
 
 This change log is maintained by `src.ts/_admin/update-changelog.ts` but may also be manually updated.
 
+ethers/v6.10.0 (2024-01-12 19:46)
+---------------------------------
+
+  - Limit decoded result imflation ratio from ABI-encoded data ([#4537](https://github.com/ethers-io/ethers.js/issues/4537); [1b4debd](https://github.com/ethers-io/ethers.js/commit/1b4debd4a9e61d171bfc60590116facb8bdbd2da)).
+
 ethers/v6.9.2 (2024-01-02 19:12)
 --------------------------------
 

diff --git a/dist/ethers.js b/dist/ethers.js
@@ -3,7 +3,7 @@ const __$G = (typeof globalThis !== 'undefined' ? globalThis: typeof window !==
 /**
  *  The current version of Ethers.
  */
-const version = "6.9.2";
+const version = "6.10.0";
 
 /**
  *  Property helper functions.
@@ -2970,15 +2970,35 @@ class Reader {
     allowLoose;
     #data;
     #offset;
-    constructor(data, allowLoose) {
+    #bytesRead;
+    #parent;
+    #maxInflation;
+    constructor(data, allowLoose, maxInflation) {
         defineProperties(this, { allowLoose: !!allowLoose });
         this.#data = getBytesCopy(data);
+        this.#bytesRead = 0;
+        this.#parent = null;
+        this.#maxInflation = (maxInflation != null) ? maxInflation : 1024;
         this.#offset = 0;
     }
     get data() { return hexlify(this.#data); }
     get dataLength() { return this.#data.length; }
     get consumed() { return this.#offset; }
     get bytes() { return new Uint8Array(this.#data); }
+    #incrementBytesRead(count) {
+        if (this.#parent) {
+            return this.#parent.#incrementBytesRead(count);
+        }
+        this.#bytesRead += count;
+        // Check for excessive inflation (see: #4537)
+        assert(this.#maxInflation < 1 || this.#bytesRead <= this.#maxInflation * this.dataLength, `compressed ABI data exceeds inflation ratio of ${this.#maxInflation} ( see: https:/\/github.com/ethers-io/ethers.js/issues/4537 )`, "BUFFER_OVERRUN", {
+            buffer: getBytesCopy(this.#data), offset: this.#offset,
+            length: count, info: {
+                bytesRead: this.#bytesRead,
+                dataLength: this.dataLength
+            }
+        });
+    }
     #peekBytes(offset, length, loose) {
         let alignedLength = Math.ceil(length / WordSize) * WordSize;
         if (this.#offset + alignedLength > this.#data.length) {
@@ -2997,11 +3017,14 @@ class Reader {
     }
     // Create a sub-reader with the same underlying data, but offset
     subReader(offset) {
-        return new Reader(this.#data.slice(this.#offset + offset), this.allowLoose);
+        const reader = new Reader(this.#data.slice(this.#offset + offset), this.allowLoose, this.#maxInflation);
+        reader.#parent = this;
+        return reader;
     }
     // Read bytes
     readBytes(length, loose) {
         let bytes = this.#peekBytes(0, length, !!loose);
+        this.#incrementBytesRead(length);
         this.#offset += bytes.length;
         // @TODO: Make sure the length..end bytes are all 0?
         return bytes.slice(0, length);
@@ -12232,6 +12255,7 @@ PanicReasons$1.set(0x51, "UNINITIALIZED_FUNCTION_CALL");
 const paramTypeBytes = new RegExp(/^bytes([0-9]*)$/);
 const paramTypeNumber = new RegExp(/^(u?int)([0-9]*)$/);
 let defaultCoder = null;
+let defaultMaxInflation = 1024;
 function getBuiltinCallException(action, tx, data, abiCoder) {
     let message = "missing revert data";
     let reason = null;
@@ -12368,7 +12392,11 @@ class AbiCoder {
     decode(types, data, loose) {
         const coders = types.map((type) => this.#getCoder(ParamType.from(type)));
         const coder = new TupleCoder(coders, "_");
-        return coder.decode(new Reader(data, loose));
+        return coder.decode(new Reader(data, loose, defaultMaxInflation));
+    }
+    static _setDefaultMaxInflation(value) {
+        assertArgument(typeof (value) === "number" && Number.isInteger(value), "invalid defaultMaxInflation factor", "value", value);
+        defaultMaxInflation = value;
     }
     /**
      *  Returns the shared singleton instance of a default [[AbiCoder]].

diff --git a/dist/ethers.js.map b/dist/ethers.js.map
diff --git a/dist/ethers.min.js b/dist/ethers.min.js
diff --git a/dist/ethers.umd.js b/dist/ethers.umd.js
@@ -9,7 +9,7 @@ const __$G = (typeof globalThis !== 'undefined' ? globalThis: typeof window !==
     /**
      *  The current version of Ethers.
      */
-    const version = "6.9.2";
+    const version = "6.10.0";
 
     /**
      *  Property helper functions.
@@ -2976,15 +2976,35 @@ const __$G = (typeof globalThis !== 'undefined' ? globalThis: typeof window !==
         allowLoose;
         #data;
         #offset;
-        constructor(data, allowLoose) {
+        #bytesRead;
+        #parent;
+        #maxInflation;
+        constructor(data, allowLoose, maxInflation) {
             defineProperties(this, { allowLoose: !!allowLoose });
             this.#data = getBytesCopy(data);
+            this.#bytesRead = 0;
+            this.#parent = null;
+            this.#maxInflation = (maxInflation != null) ? maxInflation : 1024;
             this.#offset = 0;
         }
         get data() { return hexlify(this.#data); }
         get dataLength() { return this.#data.length; }
         get consumed() { return this.#offset; }
         get bytes() { return new Uint8Array(this.#data); }
+        #incrementBytesRead(count) {
+            if (this.#parent) {
+                return this.#parent.#incrementBytesRead(count);
+            }
+            this.#bytesRead += count;
+            // Check for excessive inflation (see: #4537)
+            assert(this.#maxInflation < 1 || this.#bytesRead <= this.#maxInflation * this.dataLength, `compressed ABI data exceeds inflation ratio of ${this.#maxInflation} ( see: https:/\/github.com/ethers-io/ethers.js/issues/4537 )`, "BUFFER_OVERRUN", {
+                buffer: getBytesCopy(this.#data), offset: this.#offset,
+                length: count, info: {
+                    bytesRead: this.#bytesRead,
+                    dataLength: this.dataLength
+                }
+            });
+        }
         #peekBytes(offset, length, loose) {
             let alignedLength = Math.ceil(length / WordSize) * WordSize;
             if (this.#offset + alignedLength > this.#data.length) {
@@ -3003,11 +3023,14 @@ const __$G = (typeof globalThis !== 'undefined' ? globalThis: typeof window !==
         }
         // Create a sub-reader with the same underlying data, but offset
         subReader(offset) {
-            return new Reader(this.#data.slice(this.#offset + offset), this.allowLoose);
+            const reader = new Reader(this.#data.slice(this.#offset + offset), this.allowLoose, this.#maxInflation);
+            reader.#parent = this;
+            return reader;
         }
         // Read bytes
         readBytes(length, loose) {
             let bytes = this.#peekBytes(0, length, !!loose);
+            this.#incrementBytesRead(length);
             this.#offset += bytes.length;
             // @TODO: Make sure the length..end bytes are all 0?
             return bytes.slice(0, length);
@@ -12238,6 +12261,7 @@ const __$G = (typeof globalThis !== 'undefined' ? globalThis: typeof window !==
     const paramTypeBytes = new RegExp(/^bytes([0-9]*)$/);
     const paramTypeNumber = new RegExp(/^(u?int)([0-9]*)$/);
     let defaultCoder = null;
+    let defaultMaxInflation = 1024;
     function getBuiltinCallException(action, tx, data, abiCoder) {
         let message = "missing revert data";
         let reason = null;
@@ -12374,7 +12398,11 @@ const __$G = (typeof globalThis !== 'undefined' ? globalThis: typeof window !==
         decode(types, data, loose) {
             const coders = types.map((type) => this.#getCoder(ParamType.from(type)));
             const coder = new TupleCoder(coders, "_");
-            return coder.decode(new Reader(data, loose));
+            return coder.decode(new Reader(data, loose, defaultMaxInflation));
+        }
+        static _setDefaultMaxInflation(value) {
+            assertArgument(typeof (value) === "number" && Number.isInteger(value), "invalid defaultMaxInflation factor", "value", value);
+            defaultMaxInflation = value;
         }
         /**
          *  Returns the shared singleton instance of a default [[AbiCoder]].

diff --git a/dist/ethers.umd.js.map b/dist/ethers.umd.js.map
diff --git a/dist/ethers.umd.min.js b/dist/ethers.umd.min.js
diff --git a/dist/wordlists-extra.js b/dist/wordlists-extra.js
diff --git a/dist/wordlists-extra.js.map b/dist/wordlists-extra.js.map
diff --git a/dist/wordlists-extra.min.js b/dist/wordlists-extra.min.js
diff --git a/lib.commonjs/_version.d.ts.map b/lib.commonjs/_version.d.ts.map
diff --git a/lib.commonjs/_version.js b/lib.commonjs/_version.js
diff --git a/lib.commonjs/_version.js.map b/lib.commonjs/_version.js.map
diff --git a/lib.commonjs/abi/abi-coder.d.ts b/lib.commonjs/abi/abi-coder.d.ts
@@ -40,6 +40,7 @@ export declare class AbiCoder {
      *  padded event data emitted from ``external`` functions.
      */
     decode(types: ReadonlyArray<string | ParamType>, data: BytesLike, loose?: boolean): Result;
+    static _setDefaultMaxInflation(value: number): void;
     /**
      *  Returns the shared singleton instance of a default [[AbiCoder]].
      *

diff --git a/lib.commonjs/abi/abi-coder.d.ts.map b/lib.commonjs/abi/abi-coder.d.ts.map
diff --git a/lib.commonjs/abi/abi-coder.js b/lib.commonjs/abi/abi-coder.js