remove asList parameter in raw(), preferring to use serialize()

Author: ryanio

packages/tx/src/baseTransaction.ts

@@ -112,19 +112,9 @@ export abstract class BaseTransaction<TransactionObject> {
   }
 
   /**
-   * Returns the raw `Buffer[]` (Transaction) or `Buffer` (typed transaction).
-   * This is the data which is found in the transactions of the block body.
-   *
-   * Note that if you want to use this function in a tx type independent way
-   * to then use the raw data output for tx instantiation with
-   * `Tx.fromValuesArray()` you should set the `asList` parameter to `true` -
-   * which is ignored on a legacy tx but provides the correct format on
-   * a typed tx.
-   *
-   * To prepare a tx to be added as block data with `Block.fromValuesArray()`
-   * just use the plain `raw()` method.
+   * Returns a Buffer Array of the raw Buffers of this transaction, in order.
    */
-  abstract raw(asList: boolean): Buffer[] | Buffer
+  abstract raw(): Buffer[]
 
   /**
    * Returns the encoding of the transaction.

packages/tx/src/eip2930Transaction.ts

@@ -246,52 +246,36 @@ export default class AccessListEIP2930Transaction extends BaseTransaction<Access
   /**
    * Returns a Buffer Array of the raw Buffers of this transaction, in order.
    *
-   * Note that if you want to use this function in a tx type independent way
-   * to then use the raw data output for tx instantiation with
-   * `Tx.fromValuesArray()` you should set the `asList` parameter to `true` -
-   * which is ignored on a legacy tx but provides the correct format on
-   * a typed tx.
-   *
-   * To prepare a tx to be added as block data with `Block.fromValuesArray()`
-   * just use the plain `raw()` method.
-   *
-   * @param asList - By default, this method returns a concatenated Buffer
-   *                 If this is not desired, then set this to `true`, to get a Buffer array.
+   * Use `serialize()` to add to block data for `Block.fromValuesArray()`.
    */
-  raw(asList = false): Buffer[] | Buffer {
-    const base = <Buffer[]>[
+  raw(): Buffer[] {
+    return [
       bnToRlp(this.chainId),
       bnToRlp(this.nonce),
       bnToRlp(this.gasPrice),
       bnToRlp(this.gasLimit),
       this.to !== undefined ? this.to.buf : Buffer.from([]),
       bnToRlp(this.value),
       this.data,
-      this.accessList,
+      <any>this.accessList,
       this.v !== undefined ? bnToRlp(this.v) : Buffer.from([]),
       this.r !== undefined ? bnToRlp(this.r) : Buffer.from([]),
       this.s !== undefined ? bnToRlp(this.s) : Buffer.from([]),
     ]
-    if (!asList) {
-      return Buffer.concat([Buffer.from('01', 'hex'), rlp.encode(base)])
-    } else {
-      return base
-    }
   }
 
   /**
-   * Returns the encoding of the transaction. For typed transaction, this is the raw Buffer.
-   * In Transaction, this is a Buffer array.
+   * Returns the serialized encoding of the transaction.
    */
   serialize(): Buffer {
-    return <Buffer>this.raw()
+    return Buffer.concat([Buffer.from('01', 'hex'), rlp.encode(this.raw())])
   }
 
   /**
    * Computes a sha3-256 hash of the serialized unsigned tx, which is used to sign the transaction.
    */
   getMessageToSign() {
-    const base = this.raw(true).slice(0, 8)
+    const base = this.raw().slice(0, 8)
     return keccak256(Buffer.concat([Buffer.from('01', 'hex'), rlp.encode(base)]))
   }
 

packages/tx/src/legacyTransaction.ts

@@ -108,15 +108,6 @@ export default class Transaction extends BaseTransaction<Transaction> {
 
   /**
    * Returns a Buffer Array of the raw Buffers of this transaction, in order.
-   *
-   * Note that if you want to use this function in a tx type independent way
-   * to then use the raw data output for tx instantiation with
-   * `Tx.fromValuesArray()` you should set the `asList` parameter to `true` -
-   * which is ignored on a legacy tx but provides the correct format on
-   * a typed tx.
-   *
-   * To prepare a tx to be added as block data with `Block.fromValuesArray()`
-   * just use the plain `raw()` method.
    */
   raw(): Buffer[] {
     return [

packages/tx/test/base.spec.ts

@@ -121,7 +121,7 @@ tape('[BaseTransaction]', function (t) {
     for (const txType of txTypes) {
       txType.txs.forEach(function (tx: any) {
         st.ok(
-          txType.class.fromValuesArray(tx.raw(true), { common }),
+          txType.class.fromValuesArray(tx.raw(), { common }),
           `${txType.name}: should do roundtrip raw() -> fromValuesArray()`
         )
       })

packages/tx/test/transactionFactory.spec.ts

@@ -86,7 +86,7 @@ tape('[TransactionFactory]: Basic functions', function (t) {
 
   t.test('should decode raw block body data', function (st) {
     const rawLegacy = simpleSignedTransaction.raw()
-    const rawEIP2930 = simpleSignedAccessListEIP2930Transaction.raw()
+    const rawEIP2930 = simpleSignedAccessListEIP2930Transaction.serialize()
 
     const legacyTx = TransactionFactory.fromBlockBodyData(rawLegacy)
     const eip2930Tx = TransactionFactory.fromBlockBodyData(rawEIP2930, { common: EIP2930Common })