aboutsummaryrefslogtreecommitdiffstats
path: root/wire/README.md
diff options
context:
space:
mode:
authorobscuren <geffobscura@gmail.com>2014-12-20 09:34:12 +0800
committerobscuren <geffobscura@gmail.com>2014-12-20 09:34:12 +0800
commit3983dd2428137211f84f299f9ce8690c22f50afd (patch)
tree3a2dc53b365e6f377fc82a3514150d1297fe549c /wire/README.md
parent7daa8c2f6eb25511c6a54ad420709af911fc6748 (diff)
parent0a9dc1536c5d776844d6947a0090ff7e1a7c6ab4 (diff)
downloadgo-tangerine-vv0.7.10.tar
go-tangerine-vv0.7.10.tar.gz
go-tangerine-vv0.7.10.tar.bz2
go-tangerine-vv0.7.10.tar.lz
go-tangerine-vv0.7.10.tar.xz
go-tangerine-vv0.7.10.tar.zst
go-tangerine-vv0.7.10.zip
Merge branch 'release/v0.7.10'vv0.7.10
Diffstat (limited to 'wire/README.md')
-rw-r--r--wire/README.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/wire/README.md b/wire/README.md
new file mode 100644
index 000000000..7f63688b3
--- /dev/null
+++ b/wire/README.md
@@ -0,0 +1,36 @@
+# ethwire
+
+The ethwire package contains the ethereum wire protocol. The ethwire
+package is required to write and read from the ethereum network.
+
+# Installation
+
+`go get github.com/ethereum/ethwire-go`
+
+# Messaging overview
+
+The Ethereum Wire protocol defines the communication between the nodes
+running Ethereum. Further reader reading can be done on the
+[Wiki](http://wiki.ethereum.org/index.php/Wire_Protocol).
+
+# Reading Messages
+
+```go
+// Read and validate the next eth message from the provided connection.
+// returns a error message with the details.
+msg, err := ethwire.ReadMessage(conn)
+if err != nil {
+ // Handle error
+}
+```
+
+# Writing Messages
+
+```go
+// Constructs a message which can be interpreted by the eth network.
+// Write the inventory to network
+err := ethwire.WriteMessage(conn, &Msg{
+ Type: ethwire.MsgInvTy,
+ Data : []interface{}{...},
+})
+```