trie: rename trie helpers to mpt (#3718)

* trie: rename trie to mpt

* trie: fix example

* trie: rename trie helpers to mpt

* verkle: fix type issues

Author: gabrocheleau

packages/client/src/sync/fetcher/accountfetcher.ts

@@ -1,5 +1,5 @@
 import { MerkleStateManager } from '@ethereumjs/statemanager'
-import { verifyTrieRangeProof } from '@ethereumjs/trie'
+import { verifyMPTRangeProof } from '@ethereumjs/trie'
 import {
   BIGINT_0,
   BIGINT_1,
@@ -324,7 +324,7 @@ export class AccountFetcher extends Fetcher<JobTask, AccountData[], AccountData>
     const keys = accounts.map((acc: any) => acc.hash)
     const values = accounts.map((acc: any) => accountBodyToRLP(acc.body))
     // convert the request to the right values
-    return verifyTrieRangeProof(stateRoot, origin, keys[keys.length - 1], keys, values, proof, {
+    return verifyMPTRangeProof(stateRoot, origin, keys[keys.length - 1], keys, values, proof, {
       common: this.config.chainCommon,
       useKeyHashingFunction: this.config.chainCommon?.customCrypto?.keccak256 ?? keccak256,
     })
@@ -405,7 +405,7 @@ export class AccountFetcher extends Fetcher<JobTask, AccountData[], AccountData>
       // check zero-element proof
       if (rangeResult.proof.length > 0) {
         try {
-          const isMissingRightRange = await verifyTrieRangeProof(
+          const isMissingRightRange = await verifyMPTRangeProof(
             this.root,
             origin,
             null,

packages/client/src/sync/fetcher/storagefetcher.ts

@@ -1,5 +1,5 @@
 import { MerkleStateManager } from '@ethereumjs/statemanager'
-import { verifyTrieRangeProof } from '@ethereumjs/trie'
+import { verifyMPTRangeProof } from '@ethereumjs/trie'
 import {
   BIGINT_0,
   BIGINT_1,
@@ -128,7 +128,7 @@ export class StorageFetcher extends Fetcher<JobTask, StorageData[][], StorageDat
         )
       const keys = slots.map((slot: any) => slot.hash)
       const values = slots.map((slot: any) => slot.body)
-      return await verifyTrieRangeProof(
+      return await verifyMPTRangeProof(
         stateRoot,
         origin,
         keys[keys.length - 1],
@@ -280,7 +280,7 @@ export class StorageFetcher extends Fetcher<JobTask, StorageData[][], StorageDat
       // zero-element proof
       if (rangeResult.proof.length > 0) {
         try {
-          const isMissingRightRange = await verifyTrieRangeProof(
+          const isMissingRightRange = await verifyMPTRangeProof(
             task.storageRequests[0].storageRoot,
             origin,
             null,
@@ -337,7 +337,7 @@ export class StorageFetcher extends Fetcher<JobTask, StorageData[][], StorageDat
         const proof = i === rangeResult.slots.length - 1 ? rangeResult.proof : undefined
         if (proof === undefined || proof.length === 0) {
           // all-elements proof verification
-          await verifyTrieRangeProof(
+          await verifyMPTRangeProof(
             root,
             null,
             null,

packages/client/src/sync/fetcher/trienodefetcher.ts

@@ -1,8 +1,8 @@
 import { MerkleStateManager } from '@ethereumjs/statemanager'
 import {
-  BranchNode,
-  ExtensionNode,
-  LeafNode,
+  BranchMPTNode,
+  ExtensionMPTNode,
+  LeafMPTNode,
   MerklePatriciaTrie,
   decodeNode,
   mergeAndFormatKeyPaths,
@@ -226,8 +226,8 @@ export class TrieNodeFetcher extends Fetcher<JobTask, Uint8Array[], Uint8Array>
         let hasStorageComponent = false
 
         // get all children of received node
-        if (node instanceof BranchNode) {
-          const children = (node as BranchNode).getChildren()
+        if (node instanceof BranchMPTNode) {
+          const children = (node as BranchMPTNode).getChildren()
           for (const [i, embeddedNode] of children) {
             if (embeddedNode !== null) {
               const newStoragePath = nodePath.concat(bytesToHex(Uint8Array.from([i])))
@@ -240,7 +240,7 @@ export class TrieNodeFetcher extends Fetcher<JobTask, Uint8Array[], Uint8Array>
               })
             }
           }
-        } else if (node instanceof ExtensionNode) {
+        } else if (node instanceof ExtensionMPTNode) {
           this.DEBUG && this.debug('extension node found')
           const stringPath = bytesToHex(pathToHexKey(nodePath, node.key(), 'hex'))
           const syncPath =
@@ -341,7 +341,7 @@ export class TrieNodeFetcher extends Fetcher<JobTask, Uint8Array[], Uint8Array>
 
           // add account node data to account trie
           const node = decodeNode(nodeData)
-          if (node instanceof LeafNode) {
+          if (node instanceof LeafMPTNode) {
             const key = bytesToHex(pathToHexKey(path, node.key(), 'keybyte'))
             ops.push({
               type: 'put',
@@ -359,7 +359,7 @@ export class TrieNodeFetcher extends Fetcher<JobTask, Uint8Array[], Uint8Array>
             if (pathToStorageNode !== undefined && pathToStorageNode.size > 0) {
               for (const [path, data] of pathToStorageNode) {
                 const storageNode = decodeNode(data)
-                if (storageNode instanceof LeafNode) {
+                if (storageNode instanceof LeafMPTNode) {
                   const storageKey = bytesToHex(pathToHexKey(path, storageNode.key(), 'keybyte'))
                   storageTrieOps.push({
                     type: 'put',

packages/client/test/net/protocol/snapprotocol.spec.ts

@@ -1,5 +1,5 @@
 import { RLP } from '@ethereumjs/rlp'
-import { decodeNode, verifyTrieRangeProof } from '@ethereumjs/trie'
+import { decodeNode, verifyMPTRangeProof } from '@ethereumjs/trie'
 import {
   KECCAK256_NULL,
   KECCAK256_RLP,
@@ -191,7 +191,7 @@ describe('[SnapProtocol]', () => {
     try {
       const keys = accounts.map((acc: any) => acc.hash)
       const values = accounts.map((acc: any) => accountBodyToRLP(acc.body))
-      await verifyTrieRangeProof(stateRoot, keys[0], keys[keys.length - 1], keys, values, proof, {
+      await verifyMPTRangeProof(stateRoot, keys[0], keys[keys.length - 1], keys, values, proof, {
         useKeyHashingFunction: keccak256,
       })
     } catch (e) {
@@ -324,7 +324,7 @@ describe('[SnapProtocol]', () => {
     try {
       const keys = lastAccountSlots.map((acc: any) => acc.hash)
       const values = lastAccountSlots.map((acc: any) => acc.body)
-      await verifyTrieRangeProof(
+      await verifyMPTRangeProof(
         lastAccountStorageRoot,
         keys[0],
         keys[keys.length - 1],

packages/client/test/sync/fetcher/trienodefetcher.spec.ts

@@ -9,7 +9,7 @@ import { Config } from '../../../src/config.js'
 import { SnapProtocol } from '../../../src/net/protocol/index.js'
 import { wait } from '../../integration/util.js'
 
-import type { BranchNode } from '@ethereumjs/trie'
+import type { BranchMPTNode } from '@ethereumjs/trie'
 
 // Collected from Sepolia:
 // getTrieNodes({
@@ -165,7 +165,7 @@ describe('[TrieNodeFetcher]', async () => {
 
     await fetcher.store(requestResult)
 
-    const rootNode = decodeNode(nodes[0] as unknown as Uint8Array) as BranchNode
+    const rootNode = decodeNode(nodes[0] as unknown as Uint8Array) as BranchMPTNode
     const children = rootNode.getChildren()
     assert.equal(
       children.length,

packages/statemanager/src/proofs/merkle.ts

@@ -3,7 +3,7 @@ import {
   createMerkleProof,
   createTrieFromProof,
   updateTrieFromMerkleProof,
-  verifyTrieProof,
+  verifyMPTProof,
 } from '@ethereumjs/trie'
 import {
   KECCAK256_NULL,
@@ -194,7 +194,7 @@ export async function verifyMerkleStateProof(
 
   // This returns the account if the proof is valid.
   // Verify that it matches the reported account.
-  const value = await verifyTrieProof(key, accountProof, {
+  const value = await verifyMPTProof(key, accountProof, {
     useKeyHashing: true,
   })
 
@@ -240,7 +240,7 @@ export async function verifyMerkleStateProof(
     const storageProof = stProof.proof.map((value: PrefixedHexString) => hexToBytes(value))
     const storageValue = setLengthLeft(hexToBytes(stProof.value), 32)
     const storageKey = hexToBytes(stProof.key)
-    const proofValue = await verifyTrieProof(storageKey, storageProof, {
+    const proofValue = await verifyMPTProof(storageKey, storageProof, {
       useKeyHashing: true,
     })
     const reportedValue = setLengthLeft(

packages/statemanager/test/rpcStateManager.spec.ts

@@ -1,7 +1,7 @@
 import { createBlockFromJSONRPCProvider, createBlockFromRPC } from '@ethereumjs/block'
 import { Common, Hardfork, Mainnet } from '@ethereumjs/common'
 import { type EVMRunCallOpts, createEVM } from '@ethereumjs/evm'
-import { verifyTrieProof } from '@ethereumjs/trie'
+import { verifyMPTProof } from '@ethereumjs/trie'
 import { createFeeMarket1559Tx, createTxFromRPC } from '@ethereumjs/tx'
 import {
   Address,
@@ -88,7 +88,7 @@ describe('RPC State Manager API tests', () => {
     const address = createAddressFromString('0xccAfdD642118E5536024675e776d32413728DD07')
     const proof = await getRPCStateProof(state, address)
     const proofBuf = proof.accountProof.map((proofNode) => hexToBytes(proofNode))
-    const doesThisAccountExist = await verifyTrieProof(address.bytes, proofBuf, {
+    const doesThisAccountExist = await verifyMPTProof(address.bytes, proofBuf, {
       useKeyHashing: true,
     })
     assert.ok(!doesThisAccountExist, 'getAccount returns undefined for non-existent account')

packages/trie/scripts/view.ts

@@ -7,12 +7,12 @@ import {
   utf8ToBytes,
 } from '@ethereumjs/util'
 
-import { BranchNode, ExtensionNode, LeafNode } from '../node/index.js'
+import { BranchMPTNode, ExtensionMPTNode, LeafMPTNode } from '../node/index.js'
 import { MerklePatriciaTrie } from '../trie.js'
 
 import { _walkTrie } from './asyncWalk.js'
 
-import type { TrieNode } from '../types.js'
+import type { MPTNode } from '../types.js'
 import type { Debugger } from 'debug'
 
 const debug = _debug('trieview') // cspell:disable-line
@@ -45,17 +45,17 @@ const debugN = (type: TNode, d?: Debugger) => {
 }
 const debugT = debug.extend('Trie')
 
-function getNodeType(node: TrieNode): TNode {
-  return node instanceof BranchNode
+function getNodeType(node: MPTNode): TNode {
+  return node instanceof BranchMPTNode
     ? 'br'
-    : node instanceof ExtensionNode
+    : node instanceof ExtensionMPTNode
       ? 'ex'
-      : node instanceof LeafNode
+      : node instanceof LeafMPTNode
         ? 'lf'
         : 'nl'
 }
 
-function logNode(trie: MerklePatriciaTrie, node: TrieNode, currentKey: number[]): void {
+function logNode(trie: MerklePatriciaTrie, node: MPTNode, currentKey: number[]): void {
   delimiter(3)
   const type = getNodeType(node)
   if (equalsBytes(trie.hash(node.serialize()), trie.root())) {

packages/trie/src/constructors.ts

@@ -9,9 +9,9 @@ import { concatBytes } from 'ethereum-cryptography/utils'
 
 import { MerklePatriciaTrie, ROOT_DB_KEY, updateTrieFromMerkleProof } from './index.js'
 
-import type { Proof, TrieOpts } from './index.js'
+import type { MPTOpts, Proof } from './index.js'
 
-export async function createTrie(opts?: TrieOpts) {
+export async function createTrie(opts?: MPTOpts) {
   const keccakFunction =
     opts?.common?.customCrypto.keccak256 ?? opts?.useKeyHashingFunction ?? keccak256
   let key = ROOT_DB_KEY
@@ -60,7 +60,7 @@ export async function createTrie(opts?: TrieOpts) {
  * @param trieOpts trie opts to be applied to returned trie
  * @returns new trie created from given proof
  */
-export async function createTrieFromProof(proof: Proof, trieOpts?: TrieOpts) {
+export async function createTrieFromProof(proof: Proof, trieOpts?: MPTOpts) {
   const shouldVerifyRoot = trieOpts?.root !== undefined
   const trie = new MerklePatriciaTrie(trieOpts)
   const root = await updateTrieFromMerkleProof(trie, proof, shouldVerifyRoot)

packages/trie/src/node/branch.ts

@@ -1,18 +1,18 @@
 import { RLP } from '@ethereumjs/rlp'
 
-import type { BranchNodeBranchValue, NodeReferenceOrRawNode } from '../types.js'
+import type { BranchMPTNodeBranchValue, NodeReferenceOrRawNode } from '../types.js'
 
-export class BranchNode {
-  _branches: BranchNodeBranchValue[]
+export class BranchMPTNode {
+  _branches: BranchMPTNodeBranchValue[]
   _value: Uint8Array | null
 
   constructor() {
     this._branches = new Array(16).fill(null)
     this._value = null
   }
 
-  static fromArray(arr: Uint8Array[]): BranchNode {
-    const node = new BranchNode()
+  static fromArray(arr: Uint8Array[]): BranchMPTNode {
+    const node = new BranchMPTNode()
     node._branches = arr.slice(0, 16)
     node._value = arr[16]
     return node
@@ -26,19 +26,19 @@ export class BranchNode {
     return this._value && this._value.length > 0 ? this._value : null
   }
 
-  setBranch(i: number, v: BranchNodeBranchValue) {
+  setBranch(i: number, v: BranchMPTNodeBranchValue) {
     this._branches[i] = v
   }
 
-  raw(): BranchNodeBranchValue[] {
+  raw(): BranchMPTNodeBranchValue[] {
     return [...this._branches, this._value]
   }
 
   serialize(): Uint8Array {
     return RLP.encode(this.raw())
   }
 
-  getBranch(i: number): BranchNodeBranchValue {
+  getBranch(i: number): BranchMPTNodeBranchValue {
     const b = this._branches[i]
     if (b !== null && b.length > 0) {
       return b