Skip to content

Commit 83e7b01

Browse files
holgerd77holgerd77
committed
trie: rebuild documentation
1 parent 7f37a07 commit 83e7b01

File tree

2 files changed

+19
-193
lines changed

2 files changed

+19
-193
lines changed

‎packages/trie/docs/classes/_checkpointtrie_.checkpointtrie.md‎

Lines changed: 10 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,6 @@ Adds checkpointing to the {@link BaseTrie}
2121
### Properties
2222

2323
* [EMPTY_TRIE_ROOT](_checkpointtrie_.checkpointtrie.md#empty_trie_root)
24-
* [_checkpoints](_checkpointtrie_.checkpointtrie.md#_checkpoints)
25-
* [_mainDB](_checkpointtrie_.checkpointtrie.md#_maindb)
26-
* [_scratch](_checkpointtrie_.checkpointtrie.md#_scratch)
2724
* [db](_checkpointtrie_.checkpointtrie.md#db)
2825

2926
### Accessors
@@ -34,10 +31,7 @@ Adds checkpointing to the {@link BaseTrie}
3431
### Methods
3532

3633
* [_createInitialNode](_checkpointtrie_.checkpointtrie.md#private-_createinitialnode)
37-
* [_createScratchReadStream](_checkpointtrie_.checkpointtrie.md#private-_createscratchreadstream)
3834
* [_deleteNode](_checkpointtrie_.checkpointtrie.md#private-_deletenode)
39-
* [_enterCpMode](_checkpointtrie_.checkpointtrie.md#private-_entercpmode)
40-
* [_exitCpMode](_checkpointtrie_.checkpointtrie.md#private-_exitcpmode)
4135
* [_findDbNodes](_checkpointtrie_.checkpointtrie.md#private-_finddbnodes)
4236
* [_findValueNodes](_checkpointtrie_.checkpointtrie.md#private-_findvaluenodes)
4337
* [_formatNode](_checkpointtrie_.checkpointtrie.md#private-_formatnode)
@@ -70,7 +64,7 @@ Adds checkpointing to the {@link BaseTrie}
7064

7165
*Overrides [Trie](_basetrie_.trie.md).[constructor](_basetrie_.trie.md#constructor)*
7266

73-
*Defined in [checkpointTrie.ts:13](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L13)*
67+
*Defined in [checkpointTrie.ts:8](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L8)*
7468

7569
**Parameters:**
7670

@@ -94,39 +88,13 @@ The root for an empty trie
9488

9589
___
9690

97-
### _checkpoints
98-
99-
• **_checkpoints**: *Buffer[]*
100-
101-
*Defined in [checkpointTrie.ts:13](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L13)*
102-
103-
___
104-
105-
### _mainDB
106-
107-
• **_mainDB**: *DB*
108-
109-
*Defined in [checkpointTrie.ts:11](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L11)*
110-
111-
___
112-
113-
### _scratch
114-
115-
• **_scratch**: *ScratchDB | null*
116-
117-
*Defined in [checkpointTrie.ts:12](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L12)*
118-
119-
___
120-
12191
### db
12292

123-
• **db**: *DB*
124-
125-
*Inherited from [Trie](_basetrie_.trie.md).[db](_basetrie_.trie.md#db)*
93+
• **db**: *CheckpointDB*
12694

127-
*Defined in [baseTrie.ts:43](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/baseTrie.ts#L43)*
95+
*Overrides [Trie](_basetrie_.trie.md).[db](_basetrie_.trie.md#db)*
12896

129-
The backend DB
97+
*Defined in [checkpointTrie.ts:8](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L8)*
13098

13199
## Accessors
132100

@@ -136,7 +104,7 @@ The backend DB
136104

137105
*Overrides [Trie](_basetrie_.trie.md).[isCheckpoint](_basetrie_.trie.md#ischeckpoint)*
138106

139-
*Defined in [checkpointTrie.ts:28](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L28)*
107+
*Defined in [checkpointTrie.ts:18](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L18)*
140108

141109
Is the trie during a checkpoint phase?
142110

@@ -195,25 +163,6 @@ Name | Type |
195163

196164
___
197165

198-
### `Private` _createScratchReadStream
199-
200-
▸ **_createScratchReadStream**(`scratchDb?`: ScratchDB): *ScratchReadStream‹›*
201-
202-
*Defined in [checkpointTrie.ts:135](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L135)*
203-
204-
Returns a `ScratchReadStream` based on the state updates
205-
since checkpoint.
206-
207-
**Parameters:**
208-
209-
Name | Type |
210-
------ | ------ |
211-
`scratchDb?` | ScratchDB |
212-
213-
**Returns:** *ScratchReadStream‹›*
214-
215-
___
216-
217166
### `Private` _deleteNode
218167

219168
▸ **_deleteNode**(`k`: Buffer, `stack`: TrieNode[]): *Promise‹void›*
@@ -235,36 +184,6 @@ Name | Type |
235184

236185
___
237186

238-
### `Private` _enterCpMode
239-
240-
▸ **_enterCpMode**(): *void*
241-
242-
*Defined in [checkpointTrie.ts:105](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L105)*
243-
244-
Enter into checkpoint mode.
245-
246-
**Returns:** *void*
247-
248-
___
249-
250-
### `Private` _exitCpMode
251-
252-
▸ **_exitCpMode**(`commitState`: boolean): *Promise‹void›*
253-
254-
*Defined in [checkpointTrie.ts:114](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L114)*
255-
256-
Exit from checkpoint mode.
257-
258-
**Parameters:**
259-
260-
Name | Type |
261-
------ | ------ |
262-
`commitState` | boolean |
263-
264-
**Returns:** *Promise‹void›*
265-
266-
___
267-
268187
### `Private` _findDbNodes
269188

270189
▸ **_findDbNodes**(`onFound`: [FoundNodeFunction](../modules/_basetrie_.md#foundnodefunction)): *Promise‹void›*
@@ -450,11 +369,10 @@ ___
450369

451370
▸ **checkpoint**(): *void*
452371

453-
*Defined in [checkpointTrie.ts:37](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L37)*
372+
*Defined in [checkpointTrie.ts:26](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L26)*
454373

455374
Creates a checkpoint that can later be reverted to or committed.
456-
After this is called, no changes to the trie will be permanently saved until `commit` is called.
457-
To override the checkpointing mechanism use `_maindb.put` to write directly write to db.
375+
After this is called, all changes can be reverted until `commit` is called.
458376

459377
**Returns:** *void*
460378

@@ -464,7 +382,7 @@ ___
464382

465383
▸ **commit**(): *Promise‹void›*
466384

467-
*Defined in [checkpointTrie.ts:52](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L52)*
385+
*Defined in [checkpointTrie.ts:35](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L35)*
468386

469387
Commits a checkpoint to disk, if current checkpoint is not nested.
470388
If nested, only sets the parent checkpoint as current checkpoint.
@@ -481,7 +399,7 @@ ___
481399

482400
*Overrides [Trie](_basetrie_.trie.md).[copy](_basetrie_.trie.md#copy)*
483401

484-
*Defined in [checkpointTrie.ts:90](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L90)*
402+
*Defined in [checkpointTrie.ts:64](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L64)*
485403

486404
Returns a copy of the underlying trie with the interface of CheckpointTrie.
487405

@@ -623,7 +541,7 @@ ___
623541

624542
▸ **revert**(): *Promise‹void›*
625543

626-
*Defined in [checkpointTrie.ts:73](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L73)*
544+
*Defined in [checkpointTrie.ts:50](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L50)*
627545

628546
Reverts the trie to the state it was at when `checkpoint` was first called.
629547
If during a nested checkpoint, sets root to most recent checkpoint, and sets

‎packages/trie/docs/classes/_secure_.securetrie.md‎

Lines changed: 9 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,6 @@ It has the same methods and constructor as `Trie`.
2525
### Properties
2626

2727
* [EMPTY_TRIE_ROOT](_secure_.securetrie.md#empty_trie_root)
28-
* [_checkpoints](_secure_.securetrie.md#_checkpoints)
29-
* [_mainDB](_secure_.securetrie.md#_maindb)
30-
* [_scratch](_secure_.securetrie.md#_scratch)
3128
* [db](_secure_.securetrie.md#db)
3229

3330
### Accessors
@@ -38,10 +35,7 @@ It has the same methods and constructor as `Trie`.
3835
### Methods
3936

4037
* [_createInitialNode](_secure_.securetrie.md#private-_createinitialnode)
41-
* [_createScratchReadStream](_secure_.securetrie.md#private-_createscratchreadstream)
4238
* [_deleteNode](_secure_.securetrie.md#private-_deletenode)
43-
* [_enterCpMode](_secure_.securetrie.md#private-_entercpmode)
44-
* [_exitCpMode](_secure_.securetrie.md#private-_exitcpmode)
4539
* [_findDbNodes](_secure_.securetrie.md#private-_finddbnodes)
4640
* [_findValueNodes](_secure_.securetrie.md#private-_findvaluenodes)
4741
* [_formatNode](_secure_.securetrie.md#private-_formatnode)
@@ -98,45 +92,15 @@ The root for an empty trie
9892

9993
___
10094

101-
### _checkpoints
102-
103-
• **_checkpoints**: *Buffer[]*
104-
105-
*Inherited from [CheckpointTrie](_checkpointtrie_.checkpointtrie.md).[_checkpoints](_checkpointtrie_.checkpointtrie.md#_checkpoints)*
106-
107-
*Defined in [checkpointTrie.ts:13](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L13)*
108-
109-
___
110-
111-
### _mainDB
112-
113-
• **_mainDB**: *DB*
114-
115-
*Inherited from [CheckpointTrie](_checkpointtrie_.checkpointtrie.md).[_mainDB](_checkpointtrie_.checkpointtrie.md#_maindb)*
116-
117-
*Defined in [checkpointTrie.ts:11](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L11)*
118-
119-
___
120-
121-
### _scratch
122-
123-
• **_scratch**: *ScratchDB | null*
124-
125-
*Inherited from [CheckpointTrie](_checkpointtrie_.checkpointtrie.md).[_scratch](_checkpointtrie_.checkpointtrie.md#_scratch)*
126-
127-
*Defined in [checkpointTrie.ts:12](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L12)*
128-
129-
___
130-
13195
### db
13296

133-
• **db**: *DB*
97+
• **db**: *CheckpointDB*
13498

135-
*Inherited from [Trie](_basetrie_.trie.md).[db](_basetrie_.trie.md#db)*
99+
*Inherited from [CheckpointTrie](_checkpointtrie_.checkpointtrie.md).[db](_checkpointtrie_.checkpointtrie.md#db)*
136100

137-
*Defined in [baseTrie.ts:43](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/baseTrie.ts#L43)*
101+
*Overrides [Trie](_basetrie_.trie.md).[db](_basetrie_.trie.md#db)*
138102

139-
The backend DB
103+
*Defined in [checkpointTrie.ts:8](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L8)*
140104

141105
## Accessors
142106

@@ -148,7 +112,7 @@ The backend DB
148112

149113
*Overrides [Trie](_basetrie_.trie.md).[isCheckpoint](_basetrie_.trie.md#ischeckpoint)*
150114

151-
*Defined in [checkpointTrie.ts:28](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L28)*
115+
*Defined in [checkpointTrie.ts:18](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L18)*
152116

153117
Is the trie during a checkpoint phase?
154118

@@ -207,27 +171,6 @@ Name | Type |
207171

208172
___
209173

210-
### `Private` _createScratchReadStream
211-
212-
▸ **_createScratchReadStream**(`scratchDb?`: ScratchDB): *ScratchReadStream‹›*
213-
214-
*Inherited from [CheckpointTrie](_checkpointtrie_.checkpointtrie.md).[_createScratchReadStream](_checkpointtrie_.checkpointtrie.md#private-_createscratchreadstream)*
215-
216-
*Defined in [checkpointTrie.ts:135](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L135)*
217-
218-
Returns a `ScratchReadStream` based on the state updates
219-
since checkpoint.
220-
221-
**Parameters:**
222-
223-
Name | Type |
224-
------ | ------ |
225-
`scratchDb?` | ScratchDB |
226-
227-
**Returns:** *ScratchReadStream‹›*
228-
229-
___
230-
231174
### `Private` _deleteNode
232175

233176
▸ **_deleteNode**(`k`: Buffer, `stack`: TrieNode[]): *Promise‹void›*
@@ -249,40 +192,6 @@ Name | Type |
249192

250193
___
251194

252-
### `Private` _enterCpMode
253-
254-
▸ **_enterCpMode**(): *void*
255-
256-
*Inherited from [CheckpointTrie](_checkpointtrie_.checkpointtrie.md).[_enterCpMode](_checkpointtrie_.checkpointtrie.md#private-_entercpmode)*
257-
258-
*Defined in [checkpointTrie.ts:105](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L105)*
259-
260-
Enter into checkpoint mode.
261-
262-
**Returns:** *void*
263-
264-
___
265-
266-
### `Private` _exitCpMode
267-
268-
▸ **_exitCpMode**(`commitState`: boolean): *Promise‹void›*
269-
270-
*Inherited from [CheckpointTrie](_checkpointtrie_.checkpointtrie.md).[_exitCpMode](_checkpointtrie_.checkpointtrie.md#private-_exitcpmode)*
271-
272-
*Defined in [checkpointTrie.ts:114](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L114)*
273-
274-
Exit from checkpoint mode.
275-
276-
**Parameters:**
277-
278-
Name | Type |
279-
------ | ------ |
280-
`commitState` | boolean |
281-
282-
**Returns:** *Promise‹void›*
283-
284-
___
285-
286195
### `Private` _findDbNodes
287196

288197
▸ **_findDbNodes**(`onFound`: [FoundNodeFunction](../modules/_basetrie_.md#foundnodefunction)): *Promise‹void›*
@@ -470,11 +379,10 @@ ___
470379

471380
*Inherited from [CheckpointTrie](_checkpointtrie_.checkpointtrie.md).[checkpoint](_checkpointtrie_.checkpointtrie.md#checkpoint)*
472381

473-
*Defined in [checkpointTrie.ts:37](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L37)*
382+
*Defined in [checkpointTrie.ts:26](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L26)*
474383

475384
Creates a checkpoint that can later be reverted to or committed.
476-
After this is called, no changes to the trie will be permanently saved until `commit` is called.
477-
To override the checkpointing mechanism use `_maindb.put` to write directly write to db.
385+
After this is called, all changes can be reverted until `commit` is called.
478386

479387
**Returns:** *void*
480388

@@ -486,7 +394,7 @@ ___
486394

487395
*Inherited from [CheckpointTrie](_checkpointtrie_.checkpointtrie.md).[commit](_checkpointtrie_.checkpointtrie.md#commit)*
488396

489-
*Defined in [checkpointTrie.ts:52](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L52)*
397+
*Defined in [checkpointTrie.ts:35](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L35)*
490398

491399
Commits a checkpoint to disk, if current checkpoint is not nested.
492400
If nested, only sets the parent checkpoint as current checkpoint.
@@ -644,7 +552,7 @@ ___
644552

645553
*Inherited from [CheckpointTrie](_checkpointtrie_.checkpointtrie.md).[revert](_checkpointtrie_.checkpointtrie.md#revert)*
646554

647-
*Defined in [checkpointTrie.ts:73](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L73)*
555+
*Defined in [checkpointTrie.ts:50](https://github.com/ethereumjs/ethereumjs-vm/blob/master/packages/trie/src/checkpointTrie.ts#L50)*
648556

649557
Reverts the trie to the state it was at when `checkpoint` was first called.
650558
If during a nested checkpoint, sets root to most recent checkpoint, and sets

0 commit comments

Comments
 (0)