@ethereumjs/trie - npm Package Compare versions

Comparing version 5.0.2 to 5.0.3

dist/proof/range.d.ts

@@ -19,3 +19,3 @@ /// <reference types="node" />
  *
- * - Two edge elements proof. In this case two existent or non-existent proof(fisrt and last) should be provided.
+ * - Two edge elements proof. In this case two existent or non-existent proof(first and last) should be provided.
  *
@@ -22,0 +22,0 @@ * NOTE: Currently only supports verification when the length of firstKey and lastKey are the same.

dist/proof/range.js

@@ -359,3 +359,3 @@ "use strict";
  *
- * - Two edge elements proof. In this case two existent or non-existent proof(fisrt and last) should be provided.
+ * - Two edge elements proof. In this case two existent or non-existent proof(first and last) should be provided.
  *
@@ -362,0 +362,0 @@ * NOTE: Currently only supports verification when the length of firstKey and lastKey are the same.

dist/trie/trie.d.ts

@@ -13,4 +13,2 @@ /// <reference types="node" />
  * The basic trie interface, use with `import { Trie } from '@ethereumjs/trie'`.
- * In Ethereum applications stick with the {@link SecureTrie} overlay.
- * The API for the base and the secure interface are about the same.
  */
@@ -27,4 +25,6 @@ export declare class Trie {
     /**
-     * Create a new trie
+     * Creates a new trie.
      * @param opts Options for instantiating the trie
+     *
+     * Note: in most cases, the static {@link Trie.create} constructor should be used.  It uses the same API but provides sensible defaults
      */
@@ -106,3 +106,3 @@ constructor(opts?: TrieOpts);
      * @param stack - a stack of nodes to the value given by the key
-     * @param opStack - a stack of levelup operations to commit at the end of this funciton
+     * @param opStack - a stack of levelup operations to commit at the end of this function
      */
@@ -109,0 +109,0 @@ _saveStack(key: Nibbles, stack: TrieNode[], opStack: BatchDBOp[]): Promise<void>;

dist/trie/trie.js

@@ -16,9 +16,9 @@ "use strict";
  * The basic trie interface, use with `import { Trie } from '@ethereumjs/trie'`.
- * In Ethereum applications stick with the {@link SecureTrie} overlay.
- * The API for the base and the secure interface are about the same.
  */
 class Trie {
     /**
-     * Create a new trie
+     * Creates a new trie.
      * @param opts Options for instantiating the trie
+     *
+     * Note: in most cases, the static {@link Trie.create} constructor should be used.  It uses the same API but provides sensible defaults
      */
@@ -496,3 +496,3 @@ constructor(opts) {
         if (branchNodes.length === 1) {
-            // add the one remaing branch node to node above it
+            // add the one remaining branch node to node above it
             const branchNode = branchNodes[0][1];
@@ -520,3 +520,3 @@ const branchNodeKey = branchNodes[0][0];
         else {
-            // simple removing a leaf and recaluclation the stack
+            // simple removing a leaf and recalculation the stack
             if (parentNode) {
@@ -534,3 +534,3 @@ stack.push(parentNode);
      * @param stack - a stack of nodes to the value given by the key
-     * @param opStack - a stack of levelup operations to commit at the end of this funciton
+     * @param opStack - a stack of levelup operations to commit at the end of this function
      */
@@ -537,0 +537,0 @@ async _saveStack(key, stack, opStack) {

package.json

 {
   "name": "@ethereumjs/trie",
-  "version": "5.0.2",
+  "version": "5.0.3",
   "description": "This is an implementation of the modified merkle patricia tree as specified in Ethereum's yellow paper.",
@@ -48,4 +48,4 @@ "keywords": [
   "dependencies": {
-    "@ethereumjs/rlp": "^4.0.0",
-    "@ethereumjs/util": "^8.0.3",
+    "@ethereumjs/rlp": "^4.0.1",
+    "@ethereumjs/util": "^8.0.4",
     "@types/readable-stream": "^2.3.13",
@@ -52,0 +52,0 @@ "ethereum-cryptography": "^1.1.2",

README.md

@@ -31,3 +31,3 @@ # @ethereumjs/trie
 
-An additional `CheckpointTrie` implementation adds checkpointing functionality to `Trie` through the methods `checkpoint`, `commit` and `revert`.
+Checkpointing functionality to `Trie` through the methods `checkpoint`, `commit` and `revert`.
 
@@ -52,37 +52,34 @@ It is best to select the variant that is most appropriate for your unique use case.
 
-You can also review our [examples](https://github.com/ethereumjs/ethereumjs-monorepo/tree/master/packages/trie/examples) for database implementations. The [level.js](https://github.com/ethereumjs/ethereumjs-monorepo/tree/master/packages/trie/examples/level.js) example is the default implementation while [lmdb.js](https://github.com/ethereumjs/ethereumjs-monorepo/tree/master/packages/trie/examples/lmdb.js) is an alternative implementation that uses the popular [LMDB](https://en.wikipedia.org/wiki/Lightning_Memory-Mapped_Database) as its underlying database.
+### Use with static constructor
 
-> If no `db` option is provided, an in-memory database powered by [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) will fulfill this role.
+```typescript
+import { Trie, MapDB } from '@ethereumjs/trie'
 
-### Database
+const trie = Trie.create()
 
-> By default the only supported database mapping is MapDB.
+async function test() {
+  await trie.put(Buffer.from('test'), Buffer.from('one'))
+  const value = await trie.get(Buffer.from('test'))
+  console.log(value.toString()) // 'one'
+}
 
-But the 5.0.0 release introduced the `DB` interface to allow for the decoupling of the database layer from the previously tightly-coupled `LevelDB` integration. The `DB` interface defines the methods `get`, `put`, `del`, `batch` and `copy` that a concrete implementation of the `DB` interface will need to implement. The default implementation of the `DB` interface is now an in-memory storage based on the native [Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) and functions identically to pre-5.0.0 releases.
+test()
+```
 
-The base trie implementation (`Trie`) as well as all subclass implementations (`CheckpointTrie` and `SecureTrie`) accept any database implementation that adheres to the `DB` interface as the `db` option. It is possible to use alternative implementations like [LevelDB](#leveldb) if you wish to.
+When the static `Trie.create` constructor is used without any options, the `trie` object is instantiated with defaults configured to match the Etheruem production spec (i.e. keys are hashed using SHA256). It also persists the state root of the tree on each write operation, ensuring that your trie remains in the state you left it when you start your application the next time.
 
-#### Node Deletion
+### `Trie` Configuration Options
 
-By default, the deletion of trie nodes from the underlying database does not occur in order to avoid corrupting older trie states (as of `v4.2.0`). Should you only wish to work with the latest state of a trie, you can switch to a delete behavior (for example, if you wish to save disk space) by using the `deleteFromDB` constructor option (see related release notes in the changelog for further details).
+#### Database Options
 
-#### Persistence
+The `DB` opt in the `TrieOpts` allows you to use any database that conforms to the `DB` interface to store the trie data in. We provide several [examples](https://github.com/ethereumjs/ethereumjs-monorepo/tree/master/packages/trie/examples) for database implementations. The [level.js](https://github.com/ethereumjs/ethereumjs-monorepo/tree/master/packages/trie/examples/level.js) example is used in the `ethereumjs client` while [lmdb.js](https://github.com/ethereumjs/ethereumjs-monorepo/tree/master/packages/trie/examples/lmdb.js) is an alternative implementation that uses the popular [LMDB](https://en.wikipedia.org/wiki/Lightning_Memory-Mapped_Database) as its underlying database.
 
-You can enable persistence by setting the `useRootPersistence` option to `true` when constructing a trie through the `Trie.create` function. As such, this value is preserved when creating copies of the trie and is incapable of being modified once a trie is instantiated.
+If no `db` option is provided, an in-memory database powered by [a Javascript Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) will fulfill this role.
 
-```typescript
-import { Trie, MapDB } from '@ethereumjs/trie'
+If you want to use an alternative database, you can integrate your own by writing a DB wrapper that conforms to the [`DB` interface](./src/types.ts#L85). The `DB` interface defines the methods `get`, `put`, `del`, `batch` and `copy` that a concrete implementation of the `DB` interface will need to implement.
 
-const trie = await Trie.create({
-  db: new MapDB(),
-  useRootPersistence: true,
-})
-```
+##### LevelDB
 
-The `Trie.create` function is asynchronous and will read the root from your database before returning the trie instance. If you don't have the need for automatic restoration of the root then you can use the `new Trie` constructor with the same options and get persistence without the automatic restoration.
+As an example, to leveage `LevelDB` for all operations then you should create a file with the [following implementation from our recipes](./recipes//level.ts) in your project. Then instantiate your DB and trie as below:
 
-#### LevelDB
-
-If you wish to continue to rely on `LevelDB` for all operations then you should create a file with the [following implementation from our recipes](./recipes//level.ts) in your project. It is then possible to use the `LevelDB` implementation as follows:
-
 ```typescript
@@ -97,2 +94,19 @@ import { Trie } from '@ethereumjs/trie'
 
+#### Node Deletion (Pruning)
+
+By default, the deletion of trie nodes from the underlying database does not occur in order to avoid corrupting older trie states (as of `v4.2.0`). Should you only wish to work with the latest state of a trie, you can switch to a delete behavior (for example, if you wish to save disk space) by using the `deleteFromDB` constructor option (see related release notes in the changelog for further details).
+
+#### Root Persistence
+
+You can enable persistence by setting the `useRootPersistence` option to `true` when constructing a trie through the `Trie.create` function. As such, this value is preserved when creating copies of the trie and is incapable of being modified once a trie is instantiated.
+
+```typescript
+import { Trie, MapDB } from '@ethereumjs/trie'
+
+const trie = await Trie.create({
+  db: new MapDB(),
+  useRootPersistence: true,
+})
+```
+
 ## Proofs
@@ -99,0 +113,0 @@

src/proof/range.ts

@@ -398,3 +398,3 @@ import { BranchNode, ExtensionNode, LeafNode, Trie } from '../trie'
  *
- * - Two edge elements proof. In this case two existent or non-existent proof(fisrt and last) should be provided.
+ * - Two edge elements proof. In this case two existent or non-existent proof(first and last) should be provided.
  *
@@ -401,0 +401,0 @@ * NOTE: Currently only supports verification when the length of firstKey and lastKey are the same.

src/trie/trie.ts

@@ -35,4 +35,2 @@ import { RLP_EMPTY_STRING } from '@ethereumjs/util'
  * The basic trie interface, use with `import { Trie } from '@ethereumjs/trie'`.
- * In Ethereum applications stick with the {@link SecureTrie} overlay.
- * The API for the base and the secure interface are about the same.
  */
@@ -57,4 +55,6 @@ export class Trie {
   /**
-   * Create a new trie
+   * Creates a new trie.
    * @param opts Options for instantiating the trie
+   *
+   * Note: in most cases, the static {@link Trie.create} constructor should be used.  It uses the same API but provides sensible defaults
    */
@@ -567,3 +567,3 @@ constructor(opts?: TrieOpts) {
     if (branchNodes.length === 1) {
-      // add the one remaing branch node to node above it
+      // add the one remaining branch node to node above it
       const branchNode = branchNodes[0][1]
@@ -598,3 +598,3 @@ const branchNodeKey = branchNodes[0][0]
     } else {
-      // simple removing a leaf and recaluclation the stack
+      // simple removing a leaf and recalculation the stack
       if (parentNode) {
@@ -614,3 +614,3 @@ stack.push(parentNode)
    * @param stack - a stack of nodes to the value given by the key
-   * @param opStack - a stack of levelup operations to commit at the end of this funciton
+   * @param opStack - a stack of levelup operations to commit at the end of this function
    */
@@ -617,0 +617,0 @@ async _saveStack(key: Nibbles, stack: TrieNode[], opStack: BatchDBOp[]): Promise<void> {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

336

increased by4.35%

Worsened metrics

Total package byte prevSize

261521

decreased by-0.03%

Dependency changes

• Updated@ethereumjs/rlp@^4.0.1

• Updated@ethereumjs/util@^8.0.4