From a68c1c931714553d9a4ba7fcf519a5dcb1c505e7 Mon Sep 17 00:00:00 2001 From: Ryan Ghods Date: Tue, 12 May 2020 10:20:04 -0700 Subject: [PATCH] Update changelog with trie raw method breaking changes --- CHANGELOG.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5426b1f..d99a82a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,8 +10,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) This release introduces a major API upgrade from callbacks to Promises. -See the [docs](https://github.com/ethereumjs/merkle-patricia-tree/tree/master/docs) for the latest method signatures. - Example using async/await syntax: ```typescript @@ -22,6 +20,16 @@ await trie.put(Buffer.from('test'), Buffer.from('one')) const value = await trie.get(Buffer.from('test')) ``` +### Breaking Changes + +#### Trie methods + +See the [docs](https://github.com/ethereumjs/merkle-patricia-tree/tree/master/docs) for the latest Promise-based method signatures. + +#### Trie raw methods + +`getRaw`, `putRaw` and `delRaw` were deprecated in `v3.0.0` and have been removed from this release. Instead, please use `trie.db.get`, `trie.db.put`, and `trie.db.del`. If using a `SecureTrie` or `CheckpointTrie`, use `trie._maindb` to override the checkpointing mechanism and interact directly with the db. + ### Changed - Convert trieNode to ES6 class ([#71](https://github.com/ethereumjs/merkle-patricia-tree/pull/71)) @@ -43,7 +51,7 @@ const value = await trie.get(Buffer.from('test')) ### Fixed - Drop ethereumjs-testing dep and fix bug in branch value update ([#69](https://github.com/ethereumjs/merkle-patricia-tree/pull/69)) -- Fix prove and verifyProof in SecureTrie ([#79](https://github.com/ethereumjs/merkle-patricia-tree/pull/70)) +- Fix prove and verifyProof in SecureTrie ([#79](https://github.com/ethereumjs/merkle-patricia-tree/pull/79)) - Fixed src code links in docs ([#93](https://github.com/ethereumjs/merkle-patricia-tree/pull/93)) ### Dev / Testing / CI