good morning!!!!
Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
B
bor
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package Registry
Container Registry
Harbor Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
open
bor
Commits
4ce3dfe9
Commit
4ce3dfe9
authored
9 years ago
by
Jeff R. Allen
Browse files
Options
Downloads
Patches
Plain Diff
common: Update README.md for the current package name
parent
90f1fe0e
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
common/README.md
+19
-18
19 additions, 18 deletions
common/README.md
with
19 additions
and
18 deletions
common/README.md
+
19
−
18
View file @
4ce3dfe9
#
ethutil
#
common
[

](https://travis-ci.org/ethereum/go-ethereum)
The
ethutil
package contains the ethereum utility library.
The
common
package contains the ethereum utility library.
# Installation
`go get github.com/ethereum/ethutil-go`
As a subdirectory the main go-ethereum repository, you get it with
`go get github.com/ethereum/go-ethereum`
.
# Usage
## RLP (Recursive Linear Prefix) Encoding
RLP Encoding is an encoding scheme u
tiliz
ed by the Ethereum project. It
encodes any native value or list to string.
RLP Encoding is an encoding scheme u
s
ed by the Ethereum project. It
encodes any native value or list to
a
string.
More in depth information about the
E
ncoding scheme see the
[
Wiki
](
http://wiki.ethereum.org/index.php/RLP
)
article.
More in depth information about the
e
ncoding scheme see the
[
Wiki
](
http://wiki.ethereum.org/index.php/RLP
)
article.
```
go
rlp
:=
ethutil
.
Encode
(
"doge"
)
rlp
:=
common
.
Encode
(
"doge"
)
fmt
.
Printf
(
"%q
\n
"
,
rlp
)
// => "\0x83dog"
rlp
=
ethutil
.
Encode
([]
interface
{}{
"dog"
,
"cat"
})
rlp
=
common
.
Encode
([]
interface
{}{
"dog"
,
"cat"
})
fmt
.
Printf
(
"%q
\n
"
,
rlp
)
// => "\0xc8\0x83dog\0x83cat"
decoded
:=
ethutil
.
Decode
(
rlp
)
decoded
:=
common
.
Decode
(
rlp
)
fmt
.
Println
(
decoded
)
// => ["dog" "cat"]
```
## Patricia Trie
Patricie Tree is a merkle trie u
tiliz
ed by the Ethereum project.
Patricie Tree is a merkle trie u
s
ed by the Ethereum project.
More in depth information about the (modified) Patricia Trie can be
found on the
[
Wiki
](
http://wiki.ethereum.org/index.php/Patricia_Tree
)
.
The patricia trie uses a db as backend and could be anything as long as
it satisfies the Database interface found in
`
ethutil
/db.go`
.
it satisfies the Database interface found in
`
common
/db.go`
.
```
go
db
:=
NewDatabase
()
// db, root
trie
:=
ethutil
.
NewTrie
(
db
,
""
)
trie
:=
common
.
NewTrie
(
db
,
""
)
trie
.
Put
(
"puppy"
,
"dog"
)
trie
.
Put
(
"horse"
,
"stallion"
)
...
...
@@ -65,7 +66,7 @@ all (key, value) bindings.
// ... Create db/trie
// Note that RLP uses interface slices as list
value
:=
ethutil
.
Encode
([]
interface
{}{
"one"
,
2
,
"three"
,
[]
interface
{}{
42
}})
value
:=
common
.
Encode
([]
interface
{}{
"one"
,
2
,
"three"
,
[]
interface
{}{
42
}})
// Store the RLP encoded value of the list
trie
.
Put
(
"mykey"
,
value
)
```
...
...
@@ -89,7 +90,7 @@ type (e.g. `Slice()` returns []interface{}, `Uint()` return 0, etc).
`Append(v)`
appends the value (v) to the current value/list.
```
go
val
:=
ethutil
.
NewEmptyValue
()
.
Append
(
1
)
.
Append
(
"2"
)
val
:=
common
.
NewEmptyValue
()
.
Append
(
1
)
.
Append
(
"2"
)
val
.
AppendList
()
.
Append
(
3
)
```
...
...
@@ -110,7 +111,7 @@ val.AppendList().Append(3)
`Byte()`
returns the value as a single byte.
```
go
val
:=
ethutil
.
NewValue
([]
interface
{}{
1
,
"2"
,[]
interface
{}{
3
}})
val
:=
common
.
NewValue
([]
interface
{}{
1
,
"2"
,[]
interface
{}{
3
}})
val
.
Get
(
0
)
.
Uint
()
// => 1
val
.
Get
(
1
)
.
Str
()
// => "2"
s
:=
val
.
Get
(
2
)
// => Value([]interface{}{3})
...
...
@@ -122,7 +123,7 @@ s.Get(0).Uint() // => 3
Decoding streams of RLP data is simplified
```
go
val
:=
ethutil
.
NewValueFromBytes
(
rlpData
)
val
:=
common
.
NewValueFromBytes
(
rlpData
)
val
.
Get
(
0
)
.
Uint
()
```
...
...
@@ -132,7 +133,7 @@ Encoding from Value to RLP is done with the `Encode` method. The
underlying value can be anything RLP can encode (int, str, lists, bytes)
```
go
val
:=
ethutil
.
NewValue
([]
interface
{}{
1
,
"2"
,[]
interface
{}{
3
}})
val
:=
common
.
NewValue
([]
interface
{}{
1
,
"2"
,[]
interface
{}{
3
}})
rlp
:=
val
.
Encode
()
// Store the rlp data
Store
(
rlp
)
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment