Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
Menu
Open sidebar
adam.huang
go-libp2p
Commits
2362b05a
Commit
2362b05a
authored
8 years ago
by
Jeromy
Browse files
Options
Download
Email Patches
Plain Diff
add first tutorial, showing creation of a host
parent
ff5be0e6
master
2018-Q4-OKR
feat/protobuf
feat/relay-integrate
feat/udp
fix/473
fix/no-custom-field
fix/reset-ping-stream
fix/revert-correct-external-addr
gx/update-jccl6u
gx/update-nza0mn
jenkinsfile
kevina/fix-go-vet
multistream-ping
punching
revert-276-update-go-detect-race
v6.0.23
v6.0.22
v6.0.21
v6.0.20
v6.0.19
v6.0.18
v6.0.17
v6.0.16
v6.0.15
v6.0.14
v6.0.13
v6.0.12
v6.0.11
v6.0.10
v6.0.9
v6.0.8
v6.0.7
v6.0.6
v6.0.5
v6.0.4
v6.0.3
v6.0.2
v6.0.1
v6.0.0
v5.0.21
v5.0.20
v5.0.19
v5.0.18
v5.0.17
v5.0.16
v5.0.15
v5.0.14
v5.0.13
v5.0.12
v5.0.11
v5.0.10
v5.0.9
v5.0.8
v5.0.7
v5.0.6
v5.0.5
v5.0.4
v5.0.3
v5.0.2
v5.0.1
v5.0.0
v4.5.5
v4.5.4
v4.5.3
v4.5.2
v4.5.1
v4.5.0
v4.4.5
v4.4.4
v4.4.3
v4.4.2
v4.4.1
v4.4.0
v4.3.12
v4.3.11
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
tutorial/001-the-host/README.md
+79
-0
tutorial/001-the-host/README.md
tutorial/001-the-host/host.go
+45
-0
tutorial/001-the-host/host.go
with
124 additions
and
0 deletions
+124
-0
tutorial/001-the-host/README.md
0 → 100644
View file @
2362b05a
# The libp2p 'host'
For most applications, the host is the basic building block you'll need to get
started. This guide will show how to construct and use a simple host.
The host is an abstraction that manages services on top of a swarm. It provides
a clean interface to connect to a service on a given remote peer.
First, you'll need an ID, and a place to store that ID. To generate a 'test'
ID, you can do the following:
```
go
import
(
testutil
"github.com/libp2p/go-testutil"
pstore
"github.com/libp2p/go-libp2p-peerstore"
)
// For toy applications, this is an easy way to get an identity
ident
,
err
:=
testutil
.
RandIdentity
()
if
err
!=
nil
{
panic
(
err
)
}
// We've created the identity, now we need to store it.
// A peerstore holds information about peers, including your own
ps
:=
pstore
.
NewPeerstore
()
// An identity is essentially a public/private keypair
ps
.
AddPrivKey
(
ident
.
ID
(),
ident
.
PrivateKey
())
ps
.
AddPubKey
(
ident
.
ID
(),
ident
.
PublicKey
())
```
Next, you'll need at least one address that you want to listen on. You can go
from a string to a multiaddr like this:
```
go
import
ma
"github.com/multiformats/go-multiaddr"
...
maddr
,
err
:=
ma
.
NewMultiaddr
(
"/ip4/0.0.0.0/tcp/9000"
)
if
err
!=
nil
{
panic
(
err
)
}
```
Now you know who you are, and where you live (in a manner of speaking). The
next step is setting up a 'swarm network' to handle all the peers you will
connect to. The swarm handles incoming connections from other peers, and
handles the negotiation of new outbound connections.
```
go
import
(
"context"
swarm
"github.com/libp2p/go-libp2p-swarm"
)
// Make a context to govern the lifespan of the swarm
ctx
:=
context
.
Background
()
// Put all this together
netw
,
err
:=
swarm
.
NewNetwork
(
ctx
,
[]
ma
.
Multiaddr
{
maddr
},
ident
.
ID
(),
ps
,
nil
)
if
err
!=
nil
{
panic
(
err
)
}
```
At this point, we have everything needed to finally construct a host. That call
is the simplest one so far:
```
go
import
bhost
"github.com/libp2p/go-libp2p/p2p/host/basic"
myhost
:=
bhost
.
New
(
netw
)
```
And thats it, you have a libp2p host and you're ready to start doing some
awesome p2p networking!
In future guides we will go over ways to use hosts, configure them differently
(hint: there are a huge number of ways to set these up), and interesting ways
to apply this technology to various applications you might want to build.
To see this code all put together, take a look at the
`host.go`
file in this
directory.
This diff is collapsed.
Click to expand it.
tutorial/001-the-host/host.go
0 → 100644
View file @
2362b05a
package
main
import
(
"context"
"fmt"
pstore
"github.com/libp2p/go-libp2p-peerstore"
swarm
"github.com/libp2p/go-libp2p-swarm"
bhost
"github.com/libp2p/go-libp2p/p2p/host/basic"
testutil
"github.com/libp2p/go-testutil"
ma
"github.com/multiformats/go-multiaddr"
)
func
main
()
{
// For toy applications, this is an easy way to get an identity
ident
,
err
:=
testutil
.
RandIdentity
()
if
err
!=
nil
{
panic
(
err
)
}
// We've created the identity, now we need to store it.
// A peerstore holds information about peers, including your own
ps
:=
pstore
.
NewPeerstore
()
// An identity is essentially a public/private keypair
ps
.
AddPrivKey
(
ident
.
ID
(),
ident
.
PrivateKey
())
ps
.
AddPubKey
(
ident
.
ID
(),
ident
.
PublicKey
())
maddr
,
err
:=
ma
.
NewMultiaddr
(
"/ip4/0.0.0.0/tcp/9000"
)
if
err
!=
nil
{
panic
(
err
)
}
// Make a context to govern the lifespan of the swarm
ctx
:=
context
.
Background
()
// Put all this together
netw
,
err
:=
swarm
.
NewNetwork
(
ctx
,
[]
ma
.
Multiaddr
{
maddr
},
ident
.
ID
(),
ps
,
nil
)
if
err
!=
nil
{
panic
(
err
)
}
myhost
:=
bhost
.
New
(
netw
)
fmt
.
Printf
(
"Hello World, my hosts ID is %s
\n
"
,
myhost
.
ID
())
}
This diff is collapsed.
Click to expand it.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment
Menu
Projects
Groups
Snippets
Help