Skip to content
This repository was archived by the owner on Jan 19, 2021. It is now read-only.

Commit a68c1c9

Browse files
committed
Update changelog with trie raw method breaking changes
1 parent 6a09b6e commit a68c1c9

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

CHANGELOG.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
1010

1111
This release introduces a major API upgrade from callbacks to Promises.
1212

13-
See the [docs](https://github.com/ethereumjs/merkle-patricia-tree/tree/master/docs) for the latest method signatures.
14-
1513
Example using async/await syntax:
1614

1715
```typescript
@@ -22,6 +20,16 @@ await trie.put(Buffer.from('test'), Buffer.from('one'))
2220
const value = await trie.get(Buffer.from('test'))
2321
```
2422

23+
### Breaking Changes
24+
25+
#### Trie methods
26+
27+
See the [docs](https://github.com/ethereumjs/merkle-patricia-tree/tree/master/docs) for the latest Promise-based method signatures.
28+
29+
#### Trie raw methods
30+
31+
`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.
32+
2533
### Changed
2634

2735
- 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'))
4351
### Fixed
4452

4553
- Drop ethereumjs-testing dep and fix bug in branch value update ([#69](https://github.com/ethereumjs/merkle-patricia-tree/pull/69))
46-
- Fix prove and verifyProof in SecureTrie ([#79](https://github.com/ethereumjs/merkle-patricia-tree/pull/70))
54+
- Fix prove and verifyProof in SecureTrie ([#79](https://github.com/ethereumjs/merkle-patricia-tree/pull/79))
4755
- Fixed src code links in docs ([#93](https://github.com/ethereumjs/merkle-patricia-tree/pull/93))
4856

4957
### Dev / Testing / CI

0 commit comments

Comments
 (0)