check-ethereum-scanner
Version:
Safety checks for new Ethereum tokens
428 lines • 19.2 kB
JavaScript
"use strict";
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
if (typeof b !== "function" && b !== null)
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __read = (this && this.__read) || function (o, n) {
var m = typeof Symbol === "function" && o[Symbol.iterator];
if (!m) return o;
var i = m.call(o), r, ar = [], e;
try {
while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
}
catch (error) { e = { error: error }; }
finally {
try {
if (r && !r.done && (m = i["return"])) m.call(i);
}
finally { if (e) throw e.error; }
}
return ar;
};
Object.defineProperty(exports, "__esModule", { value: true });
var ethereumjs_util_1 = require("ethereumjs-util");
var types_1 = require("./types");
var baseTransaction_1 = require("./baseTransaction");
var util_1 = require("./util");
var TRANSACTION_TYPE = 0;
/**
* An Ethereum non-typed (legacy) transaction
*/
var Transaction = /** @class */ (function (_super) {
__extends(Transaction, _super);
/**
* This constructor takes the values, validates them, assigns them and freezes the object.
*
* It is not recommended to use this constructor directly. Instead use
* the static factory methods to assist in creating a Transaction object from
* varying data types.
*/
function Transaction(txData, opts) {
if (opts === void 0) { opts = {}; }
var _this = this;
var _a;
_this = _super.call(this, __assign(__assign({}, txData), { type: TRANSACTION_TYPE }), opts) || this;
_this.common = _this._validateTxV(_this.v, opts.common);
_this.gasPrice = new ethereumjs_util_1.BN((0, ethereumjs_util_1.toBuffer)(txData.gasPrice === '' ? '0x' : txData.gasPrice));
if (_this.gasPrice.mul(_this.gasLimit).gt(ethereumjs_util_1.MAX_INTEGER)) {
var msg = _this._errorMsg('gas limit * gasPrice cannot exceed MAX_INTEGER (2^256-1)');
throw new Error(msg);
}
_this._validateCannotExceedMaxInteger({ gasPrice: _this.gasPrice });
if (_this.common.gteHardfork('spuriousDragon')) {
if (!_this.isSigned()) {
_this.activeCapabilities.push(types_1.Capability.EIP155ReplayProtection);
}
else {
// EIP155 spec:
// If block.number >= 2,675,000 and v = CHAIN_ID * 2 + 35 or v = CHAIN_ID * 2 + 36
// then when computing the hash of a transaction for purposes of signing or recovering
// instead of hashing only the first six elements (i.e. nonce, gasprice, startgas, to, value, data)
// hash nine elements, with v replaced by CHAIN_ID, r = 0 and s = 0.
var v = _this.v;
var chainIdDoubled = _this.common.chainIdBN().muln(2);
// v and chain ID meet EIP-155 conditions
if (v.eq(chainIdDoubled.addn(35)) || v.eq(chainIdDoubled.addn(36))) {
_this.activeCapabilities.push(types_1.Capability.EIP155ReplayProtection);
}
}
}
if (_this.common.isActivatedEIP(3860)) {
(0, util_1.checkMaxInitCodeSize)(_this.common, _this.data.length);
}
var freeze = (_a = opts === null || opts === void 0 ? void 0 : opts.freeze) !== null && _a !== void 0 ? _a : true;
if (freeze) {
Object.freeze(_this);
}
return _this;
}
/**
* Instantiate a transaction from a data dictionary.
*
* Format: { nonce, gasPrice, gasLimit, to, value, data, v, r, s }
*
* Notes:
* - All parameters are optional and have some basic default values
*/
Transaction.fromTxData = function (txData, opts) {
if (opts === void 0) { opts = {}; }
return new Transaction(txData, opts);
};
/**
* Instantiate a transaction from the serialized tx.
*
* Format: `rlp([nonce, gasPrice, gasLimit, to, value, data, v, r, s])`
*/
Transaction.fromSerializedTx = function (serialized, opts) {
if (opts === void 0) { opts = {}; }
var values = ethereumjs_util_1.rlp.decode(serialized);
if (!Array.isArray(values)) {
throw new Error('Invalid serialized tx input. Must be array');
}
return this.fromValuesArray(values, opts);
};
/**
* Instantiate a transaction from the serialized tx.
* (alias of {@link Transaction.fromSerializedTx})
*
* @deprecated this constructor alias is deprecated and will be removed
* in favor of the {@link Transaction.fromSerializedTx} constructor
*/
Transaction.fromRlpSerializedTx = function (serialized, opts) {
if (opts === void 0) { opts = {}; }
return Transaction.fromSerializedTx(serialized, opts);
};
/**
* Create a transaction from a values array.
*
* Format: `[nonce, gasPrice, gasLimit, to, value, data, v, r, s]`
*/
Transaction.fromValuesArray = function (values, opts) {
if (opts === void 0) { opts = {}; }
// If length is not 6, it has length 9. If v/r/s are empty Buffers, it is still an unsigned transaction
// This happens if you get the RLP data from `raw()`
if (values.length !== 6 && values.length !== 9) {
throw new Error('Invalid transaction. Only expecting 6 values (for unsigned tx) or 9 values (for signed tx).');
}
var _a = __read(values, 9), nonce = _a[0], gasPrice = _a[1], gasLimit = _a[2], to = _a[3], value = _a[4], data = _a[5], v = _a[6], r = _a[7], s = _a[8];
(0, ethereumjs_util_1.validateNoLeadingZeroes)({ nonce: nonce, gasPrice: gasPrice, gasLimit: gasLimit, value: value, v: v, r: r, s: s });
return new Transaction({
nonce: nonce,
gasPrice: gasPrice,
gasLimit: gasLimit,
to: to,
value: value,
data: data,
v: v,
r: r,
s: s,
}, opts);
};
/**
* Returns a Buffer Array of the raw Buffers of the legacy transaction, in order.
*
* Format: `[nonce, gasPrice, gasLimit, to, value, data, v, r, s]`
*
* For legacy txs this is also the correct format to add transactions
* to a block with {@link Block.fromValuesArray} (use the `serialize()` method
* for typed txs).
*
* For an unsigned tx this method returns the empty Buffer values
* for the signature parameters `v`, `r` and `s`. For an EIP-155 compliant
* representation have a look at {@link Transaction.getMessageToSign}.
*/
Transaction.prototype.raw = function () {
return [
(0, ethereumjs_util_1.bnToUnpaddedBuffer)(this.nonce),
(0, ethereumjs_util_1.bnToUnpaddedBuffer)(this.gasPrice),
(0, ethereumjs_util_1.bnToUnpaddedBuffer)(this.gasLimit),
this.to !== undefined ? this.to.buf : Buffer.from([]),
(0, ethereumjs_util_1.bnToUnpaddedBuffer)(this.value),
this.data,
this.v !== undefined ? (0, ethereumjs_util_1.bnToUnpaddedBuffer)(this.v) : Buffer.from([]),
this.r !== undefined ? (0, ethereumjs_util_1.bnToUnpaddedBuffer)(this.r) : Buffer.from([]),
this.s !== undefined ? (0, ethereumjs_util_1.bnToUnpaddedBuffer)(this.s) : Buffer.from([]),
];
};
/**
* Returns the serialized encoding of the legacy transaction.
*
* Format: `rlp([nonce, gasPrice, gasLimit, to, value, data, v, r, s])`
*
* For an unsigned tx this method uses the empty Buffer values for the
* signature parameters `v`, `r` and `s` for encoding. For an EIP-155 compliant
* representation for external signing use {@link Transaction.getMessageToSign}.
*/
Transaction.prototype.serialize = function () {
return ethereumjs_util_1.rlp.encode(this.raw());
};
Transaction.prototype._getMessageToSign = function () {
var values = [
(0, ethereumjs_util_1.bnToUnpaddedBuffer)(this.nonce),
(0, ethereumjs_util_1.bnToUnpaddedBuffer)(this.gasPrice),
(0, ethereumjs_util_1.bnToUnpaddedBuffer)(this.gasLimit),
this.to !== undefined ? this.to.buf : Buffer.from([]),
(0, ethereumjs_util_1.bnToUnpaddedBuffer)(this.value),
this.data,
];
if (this.supports(types_1.Capability.EIP155ReplayProtection)) {
values.push((0, ethereumjs_util_1.toBuffer)(this.common.chainIdBN()));
values.push((0, ethereumjs_util_1.unpadBuffer)((0, ethereumjs_util_1.toBuffer)(0)));
values.push((0, ethereumjs_util_1.unpadBuffer)((0, ethereumjs_util_1.toBuffer)(0)));
}
return values;
};
Transaction.prototype.getMessageToSign = function (hashMessage) {
if (hashMessage === void 0) { hashMessage = true; }
var message = this._getMessageToSign();
if (hashMessage) {
return (0, ethereumjs_util_1.rlphash)(message);
}
else {
return message;
}
};
/**
* The amount of gas paid for the data in this tx
*/
Transaction.prototype.getDataFee = function () {
if (this.cache.dataFee && this.cache.dataFee.hardfork === this.common.hardfork()) {
return this.cache.dataFee.value;
}
if (Object.isFrozen(this)) {
this.cache.dataFee = {
value: _super.prototype.getDataFee.call(this),
hardfork: this.common.hardfork(),
};
}
return _super.prototype.getDataFee.call(this);
};
/**
* The up front amount that an account must have for this transaction to be valid
*/
Transaction.prototype.getUpfrontCost = function () {
return this.gasLimit.mul(this.gasPrice).add(this.value);
};
/**
* Computes a sha3-256 hash of the serialized tx.
*
* This method can only be used for signed txs (it throws otherwise).
* Use {@link Transaction.getMessageToSign} to get a tx hash for the purpose of signing.
*/
Transaction.prototype.hash = function () {
// In contrast to the tx type transaction implementations the `hash()` function
// for the legacy tx does not throw if the tx is not signed.
// This has been considered for inclusion but lead to unexpected backwards
// compatibility problems (no concrete reference found, needs validation).
//
// For context see also https://github.com/ethereumjs/ethereumjs-monorepo/pull/1445,
// September, 2021 as well as work done before.
//
// This should be updated along the next major version release by adding:
//
//if (!this.isSigned()) {
// const msg = this._errorMsg('Cannot call hash method if transaction is not signed')
// throw new Error(msg)
//}
if (Object.isFrozen(this)) {
if (!this.cache.hash) {
this.cache.hash = (0, ethereumjs_util_1.rlphash)(this.raw());
}
return this.cache.hash;
}
return (0, ethereumjs_util_1.rlphash)(this.raw());
};
/**
* Computes a sha3-256 hash which can be used to verify the signature
*/
Transaction.prototype.getMessageToVerifySignature = function () {
if (!this.isSigned()) {
var msg = this._errorMsg('This transaction is not signed');
throw new Error(msg);
}
var message = this._getMessageToSign();
return (0, ethereumjs_util_1.rlphash)(message);
};
/**
* Returns the public key of the sender
*/
Transaction.prototype.getSenderPublicKey = function () {
var _a;
var msgHash = this.getMessageToVerifySignature();
// EIP-2: All transaction signatures whose s-value is greater than secp256k1n/2 are considered invalid.
// Reasoning: https://ethereum.stackexchange.com/a/55728
if (this.common.gteHardfork('homestead') && ((_a = this.s) === null || _a === void 0 ? void 0 : _a.gt(types_1.N_DIV_2))) {
var msg = this._errorMsg('Invalid Signature: s-values greater than secp256k1n/2 are considered invalid');
throw new Error(msg);
}
var _b = this, v = _b.v, r = _b.r, s = _b.s;
try {
return (0, ethereumjs_util_1.ecrecover)(msgHash, v, (0, ethereumjs_util_1.bnToUnpaddedBuffer)(r), (0, ethereumjs_util_1.bnToUnpaddedBuffer)(s), this.supports(types_1.Capability.EIP155ReplayProtection) ? this.common.chainIdBN() : undefined);
}
catch (e) {
var msg = this._errorMsg('Invalid Signature');
throw new Error(msg);
}
};
/**
* Process the v, r, s values from the `sign` method of the base transaction.
*/
Transaction.prototype._processSignature = function (v, r, s) {
var vBN = new ethereumjs_util_1.BN(v);
if (this.supports(types_1.Capability.EIP155ReplayProtection)) {
vBN.iadd(this.common.chainIdBN().muln(2).addn(8));
}
var opts = __assign(__assign({}, this.txOptions), { common: this.common });
return Transaction.fromTxData({
nonce: this.nonce,
gasPrice: this.gasPrice,
gasLimit: this.gasLimit,
to: this.to,
value: this.value,
data: this.data,
v: vBN,
r: new ethereumjs_util_1.BN(r),
s: new ethereumjs_util_1.BN(s),
}, opts);
};
/**
* Returns an object with the JSON representation of the transaction.
*/
Transaction.prototype.toJSON = function () {
return {
nonce: (0, ethereumjs_util_1.bnToHex)(this.nonce),
gasPrice: (0, ethereumjs_util_1.bnToHex)(this.gasPrice),
gasLimit: (0, ethereumjs_util_1.bnToHex)(this.gasLimit),
to: this.to !== undefined ? this.to.toString() : undefined,
value: (0, ethereumjs_util_1.bnToHex)(this.value),
data: '0x' + this.data.toString('hex'),
v: this.v !== undefined ? (0, ethereumjs_util_1.bnToHex)(this.v) : undefined,
r: this.r !== undefined ? (0, ethereumjs_util_1.bnToHex)(this.r) : undefined,
s: this.s !== undefined ? (0, ethereumjs_util_1.bnToHex)(this.s) : undefined,
};
};
/**
* Validates tx's `v` value
*/
Transaction.prototype._validateTxV = function (v, common) {
// Check for valid v values in the scope of a signed legacy tx
if (v !== undefined) {
// v is 1. not matching the EIP-155 chainId included case and...
// v is 2. not matching the classic v=27 or v=28 case
if (v.ltn(37) && !v.eqn(27) && !v.eqn(28)) {
throw new Error("Legacy txs need either v = 27/28 or v >= 37 (EIP-155 replay protection), got v = ".concat(v));
}
}
var chainIdBN;
// No unsigned tx and EIP-155 activated and chain ID included
if (v !== undefined &&
(!common || common.gteHardfork('spuriousDragon')) &&
!v.eqn(27) &&
!v.eqn(28)) {
if (common) {
var chainIdDoubled = common.chainIdBN().muln(2);
var isValidEIP155V = v.eq(chainIdDoubled.addn(35)) || v.eq(chainIdDoubled.addn(36));
if (!isValidEIP155V) {
throw new Error("Incompatible EIP155-based V ".concat(v, " and chain id ").concat(common.chainIdBN(), ". See the Common parameter of the Transaction constructor to set the chain id."));
}
}
else {
// Derive the original chain ID
var numSub = void 0;
if (v.subn(35).isEven()) {
numSub = 35;
}
else {
numSub = 36;
}
// Use derived chain ID to create a proper Common
chainIdBN = v.subn(numSub).divn(2);
}
}
return this._getCommon(common, chainIdBN);
};
/**
* @deprecated if you have called this internal method please use `tx.supports(Capabilities.EIP155ReplayProtection)` instead
*/
Transaction.prototype._unsignedTxImplementsEIP155 = function () {
return this.common.gteHardfork('spuriousDragon');
};
/**
* @deprecated if you have called this internal method please use `tx.supports(Capabilities.EIP155ReplayProtection)` instead
*/
Transaction.prototype._signedTxImplementsEIP155 = function () {
if (!this.isSigned()) {
var msg = this._errorMsg('This transaction is not signed');
throw new Error(msg);
}
var onEIP155BlockOrLater = this.common.gteHardfork('spuriousDragon');
// EIP155 spec:
// If block.number >= 2,675,000 and v = CHAIN_ID * 2 + 35 or v = CHAIN_ID * 2 + 36, then when computing the hash of a transaction for purposes of signing or recovering, instead of hashing only the first six elements (i.e. nonce, gasprice, startgas, to, value, data), hash nine elements, with v replaced by CHAIN_ID, r = 0 and s = 0.
var v = this.v;
var chainIdDoubled = this.common.chainIdBN().muln(2);
var vAndChainIdMeetEIP155Conditions = v.eq(chainIdDoubled.addn(35)) || v.eq(chainIdDoubled.addn(36));
return vAndChainIdMeetEIP155Conditions && onEIP155BlockOrLater;
};
/**
* Return a compact error string representation of the object
*/
Transaction.prototype.errorStr = function () {
var errorStr = this._getSharedErrorPostfix();
errorStr += " gasPrice=".concat(this.gasPrice);
return errorStr;
};
/**
* Internal helper function to create an annotated error message
*
* @param msg Base error message
* @hidden
*/
Transaction.prototype._errorMsg = function (msg) {
return "".concat(msg, " (").concat(this.errorStr(), ")");
};
return Transaction;
}(baseTransaction_1.BaseTransaction));
exports.default = Transaction;
//# sourceMappingURL=legacyTransaction.js.map