ethers.js/lib.commonjs/utils/data.js

184 lines
5.5 KiB
JavaScript
Raw Normal View History

2022-09-05 23:57:11 +03:00
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
2022-09-16 05:58:45 +03:00
exports.zeroPadBytes = exports.zeroPadValue = exports.stripZerosLeft = exports.dataSlice = exports.dataLength = exports.concat = exports.hexlify = exports.isBytesLike = exports.isHexString = exports.getBytesCopy = exports.getBytes = void 0;
2022-11-30 23:44:23 +03:00
/**
* Some data helpers.
*
*
2022-12-03 05:27:06 +03:00
* @_subsection api/utils:Data Helpers [about-data]
2022-11-30 23:44:23 +03:00
*/
2022-09-16 05:58:45 +03:00
const errors_js_1 = require("./errors.js");
function _getBytes(value, name, copy) {
if (value instanceof Uint8Array) {
if (copy) {
return new Uint8Array(value);
}
return value;
}
if (typeof (value) === "string" && value.match(/^0x([0-9a-f][0-9a-f])*$/i)) {
const result = new Uint8Array((value.length - 2) / 2);
let offset = 2;
for (let i = 0; i < result.length; i++) {
result[i] = parseInt(value.substring(offset, offset + 2), 16);
offset += 2;
}
return result;
}
2022-11-09 10:57:02 +03:00
(0, errors_js_1.assertArgument)(false, "invalid BytesLike value", name || "value", value);
2022-09-16 05:58:45 +03:00
}
/**
* Get a typed Uint8Array for %%value%%. If already a Uint8Array
* the original %%value%% is returned; if a copy is required use
* [[getBytesCopy]].
*
* @see: getBytesCopy
*/
function getBytes(value, name) {
return _getBytes(value, name, false);
}
exports.getBytes = getBytes;
/**
* Get a typed Uint8Array for %%value%%, creating a copy if necessary
* to prevent any modifications of the returned value from being
* reflected elsewhere.
*
* @see: getBytes
*/
function getBytesCopy(value, name) {
return _getBytes(value, name, true);
}
exports.getBytesCopy = getBytesCopy;
/**
2022-11-30 23:44:23 +03:00
* Returns true if %%value%% is a valid [[HexString]].
2022-09-16 05:58:45 +03:00
*
2022-11-30 23:44:23 +03:00
* If %%length%% is ``true`` or a //number//, it also checks that
* %%value%% is a valid [[DataHexString]] of %%length%% (if a //number//)
2022-09-16 05:58:45 +03:00
* bytes of data (e.g. ``0x1234`` is 2 bytes).
*/
2022-09-05 23:57:11 +03:00
function isHexString(value, length) {
if (typeof (value) !== "string" || !value.match(/^0x[0-9A-Fa-f]*$/)) {
return false;
}
if (typeof (length) === "number" && value.length !== 2 + 2 * length) {
return false;
}
if (length === true && (value.length % 2) !== 0) {
return false;
}
return true;
}
exports.isHexString = isHexString;
2022-09-16 05:58:45 +03:00
/**
* Returns true if %%value%% is a valid representation of arbitrary
2022-11-30 23:44:23 +03:00
* data (i.e. a valid [[DataHexString]] or a Uint8Array).
2022-09-16 05:58:45 +03:00
*/
2022-09-05 23:57:11 +03:00
function isBytesLike(value) {
return (isHexString(value, true) || (value instanceof Uint8Array));
}
exports.isBytesLike = isBytesLike;
const HexCharacters = "0123456789abcdef";
2022-09-16 05:58:45 +03:00
/**
2022-11-30 23:44:23 +03:00
* Returns a [[DataHexString]] representation of %%data%%.
2022-09-16 05:58:45 +03:00
*/
2022-09-05 23:57:11 +03:00
function hexlify(data) {
2022-09-16 05:58:45 +03:00
const bytes = getBytes(data);
2022-09-05 23:57:11 +03:00
let result = "0x";
for (let i = 0; i < bytes.length; i++) {
const v = bytes[i];
result += HexCharacters[(v & 0xf0) >> 4] + HexCharacters[v & 0x0f];
}
return result;
}
exports.hexlify = hexlify;
2022-09-16 05:58:45 +03:00
/**
2022-11-30 23:44:23 +03:00
* Returns a [[DataHexString]] by concatenating all values
2022-09-16 05:58:45 +03:00
* within %%data%%.
*/
2022-09-05 23:57:11 +03:00
function concat(datas) {
return "0x" + datas.map((d) => hexlify(d).substring(2)).join("");
}
exports.concat = concat;
2022-09-16 05:58:45 +03:00
/**
* Returns the length of %%data%%, in bytes.
*/
2022-09-05 23:57:11 +03:00
function dataLength(data) {
if (isHexString(data, true)) {
return (data.length - 2) / 2;
}
2022-09-16 05:58:45 +03:00
return getBytes(data).length;
2022-09-05 23:57:11 +03:00
}
exports.dataLength = dataLength;
2022-09-16 05:58:45 +03:00
/**
2022-11-30 23:44:23 +03:00
* Returns a [[DataHexString]] by slicing %%data%% from the %%start%%
2022-09-16 05:58:45 +03:00
* offset to the %%end%% offset.
*
* By default %%start%% is 0 and %%end%% is the length of %%data%%.
*/
2022-09-05 23:57:11 +03:00
function dataSlice(data, start, end) {
2022-09-16 05:58:45 +03:00
const bytes = getBytes(data);
2022-09-05 23:57:11 +03:00
if (end != null && end > bytes.length) {
2022-11-09 10:57:02 +03:00
(0, errors_js_1.assert)(false, "cannot slice beyond data bounds", "BUFFER_OVERRUN", {
2022-09-05 23:57:11 +03:00
buffer: bytes, length: bytes.length, offset: end
});
}
return hexlify(bytes.slice((start == null) ? 0 : start, (end == null) ? bytes.length : end));
}
exports.dataSlice = dataSlice;
2022-09-16 05:58:45 +03:00
/**
2022-11-30 23:44:23 +03:00
* Return the [[DataHexString]] result by stripping all **leading**
2022-09-16 05:58:45 +03:00
** zero bytes from %%data%%.
*/
2022-09-05 23:57:11 +03:00
function stripZerosLeft(data) {
let bytes = hexlify(data).substring(2);
2023-02-19 06:18:42 +03:00
while (bytes.startsWith("00")) {
2022-09-05 23:57:11 +03:00
bytes = bytes.substring(2);
}
return "0x" + bytes;
}
exports.stripZerosLeft = stripZerosLeft;
function zeroPad(data, length, left) {
2022-09-16 05:58:45 +03:00
const bytes = getBytes(data);
2022-11-09 10:57:02 +03:00
(0, errors_js_1.assert)(length >= bytes.length, "padding exceeds data length", "BUFFER_OVERRUN", {
buffer: new Uint8Array(bytes),
length: length,
offset: length + 1
});
2022-09-05 23:57:11 +03:00
const result = new Uint8Array(length);
result.fill(0);
if (left) {
result.set(bytes, length - bytes.length);
}
else {
result.set(bytes, 0);
}
return hexlify(result);
}
2022-09-16 05:58:45 +03:00
/**
2022-11-30 23:44:23 +03:00
* Return the [[DataHexString]] of %%data%% padded on the **left**
2022-09-16 05:58:45 +03:00
* to %%length%% bytes.
2022-12-30 19:30:03 +03:00
*
2023-02-13 06:14:26 +03:00
* If %%data%% already exceeds %%length%%, a [[BufferOverrunError]] is
2022-12-30 19:30:03 +03:00
* thrown.
*
* This pads data the same as **values** are in Solidity
* (e.g. ``uint128``).
2022-09-16 05:58:45 +03:00
*/
2022-09-05 23:57:11 +03:00
function zeroPadValue(data, length) {
return zeroPad(data, length, true);
}
exports.zeroPadValue = zeroPadValue;
2022-09-16 05:58:45 +03:00
/**
2022-11-30 23:44:23 +03:00
* Return the [[DataHexString]] of %%data%% padded on the **right**
2022-09-16 05:58:45 +03:00
* to %%length%% bytes.
2022-12-30 19:30:03 +03:00
*
2023-02-13 06:14:26 +03:00
* If %%data%% already exceeds %%length%%, a [[BufferOverrunError]] is
2022-12-30 19:30:03 +03:00
* thrown.
*
* This pads data the same as **bytes** are in Solidity
* (e.g. ``bytes16``).
2022-09-16 05:58:45 +03:00
*/
2022-09-05 23:57:11 +03:00
function zeroPadBytes(data, length) {
return zeroPad(data, length, false);
}
exports.zeroPadBytes = zeroPadBytes;
//# sourceMappingURL=data.js.map