storjnode 0.0.9

Low level storj protocol reference implementation.

Low level storj protocol reference implementation.

Setup

Windows

Download latest windows release from github.

Extract the zip file to the folder where you wish to have it installed.

$ storjnode.exe version

Linux

Install client

$ sudo apt-get install python-pip python-dev
$ sudo pip install storjnode
$ storjnode version

Update client

$ sudo pip install storjnode --upgrade
$ storjnode version

OSX

Install client

$ brew install python
$ rehash
$ pip install storjnode
$ storjnode version

Update client

$ pip install storjnode --upgrade
$ storjnode version

Usage

CLI reference node

Using the CLI reference implementation.

# Show help text.
$ storjnode --help

# Show version number.
$ storjnode version

# Put key value pair in DHT.
$ storjnode put <KEY> <VALUE>

# Retrieve value from DHT.
$ storjnode get <KEY>

# Send node a direct message
$ storjnode direct_message <NODEID> <MESSAGE>

# Send node a relay message
$ storjnode relay_message <NODEID> <MESSAGE>

# Run node and join network.
$ storjnode run

# Run node on non default port and join network.
$ storjnode --udp_port=<PORT> run

# Run node with provided key, used for node id, auth and encryption
$ storjnode --node_key=<BITCOIN WIF/HWIF> run

# Show node id
$ storjnode --node_key=<BITCOIN WIF/HWIF> showid

# Show node type (Public with public ip or private behind a NAT)
$ storjnode --node_key=<BITCOIN WIF/HWIF> showtype

Python

Normal usage

Starting and using a node in python.

#!/usr/bin/env python
# from examples/usage.py
import time
import storjnode
from crochet import setup, TimeoutError
setup()  # start twisted via crochet


# start node (use bitcoin wif or hwif as node key)
node_key = "KzygUeD8qXaKBFdJWMk9c6AVib89keoZFBNdFBsj73kYZfAc4n1j"
node = storjnode.network.Node(node_key)


print("Giving nodes some time to find peers.")
time.sleep(storjnode.network.WALK_TIMEOUT)


try:
    # The blocking node interface is very simple and behaves like a dict.
    node["examplekey"] = "examplevalue"  # put key value pair into DHT
    retrieved = node["examplekey"]  # retrieve value by key from DHT
    print("{key} => {value}".format(key="examplekey", value=retrieved))

except TimeoutError:
    print("Got timeout error")

finally:
    node.stop()

Multinode usage

Using more then one node in a python script.

If your are using more then one node in a single script, you must assign them different ports.

#!/usr/bin/env python
# from examples/multinode.py
import time
import storjnode
from crochet import setup, TimeoutError
setup()  # start twisted via crochet


# create alice node (with bitcoin wif as node key)
alice_key = "Kyh4a6zF1TkBZW6gyzwe7XRVtJ18Y75C2bC2d9axeWZnoUdAVXYc"
alice_node = storjnode.network.Node(alice_key)

# create bob node (with bitcoin hwif as node key)
bob_key = ("xprv9s21ZrQH143K3uzRG1qUPdYhVZG1TAxQ9bLTWZuFf1FHR5hiWuRf"
        "o2L2ZNoUX9BW17guAbMXqHjMJXBFvuTBD2WWvRT3zNbtVJ1S7yxUvWd")
bob_node = storjnode.network.Node(bob_key)


print("Giving nodes some time to find peers.")
time.sleep(storjnode.network.WALK_TIMEOUT)

try:
    # use nodes
    alice_node["examplekey"] = "examplevalue"  # alice inserts value
    stored_value = bob_node["examplekey"]  # bob retrievs value
    print("{key} => {value}".format(key="examplekey", value=stored_value))

except TimeoutError:
    print("Got timeout error")

finally:  # stop nodes
    alice_node.stop()
    bob_node.stop()

Node messaging

Nodes can send messages to each other. You can send direct messages or relay messages from node to node.

Direct messages:

The node spidercrawls the network to find the receiving node and sends the message directly. This will fail if the receiving node is behind a NAT and doesn’t have a public ip.

#!/usr/bin/env python
# from examples/direct_message.py
import time
import binascii
import storjnode
from crochet import setup, TimeoutError
setup()  # start twisted via crochet


# isolate nodes becaues this example fails behind a NAT


# create alice node (with bitcoin wif as node key)
alice_key = "Kyh4a6zF1TkBZW6gyzwe7XRVtJ18Y75C2bC2d9axeWZnoUdAVXYc"
alice_node = storjnode.network.Node(
    alice_key, bootstrap_nodes=[("240.0.0.0", 1337)]
)

# create bob node (with bitcoin hwif as node key)
bob_key = ("xprv9s21ZrQH143K3uzRG1qUPdYhVZG1TAxQ9bLTWZuFf1FHR5hiWuRf"
        "o2L2ZNoUX9BW17guAbMXqHjMJXBFvuTBD2WWvRT3zNbtVJ1S7yxUvWd")
bob_node = storjnode.network.Node(
    bob_key, bootstrap_nodes=[("127.0.0.1", alice_node.port)]
)


# add message handler to bob node
def message_handler(source, message):
    src = binascii.hexlify(source) if source is not None else "unknown"
    print("%s from %s" % (message, src))
bob_node.add_message_handler(message_handler)


print("Giving nodes some time to find peers.")
time.sleep(storjnode.network.WALK_TIMEOUT)


try:
    # send direct message (blocking call)
    alice_node.direct_message(bob_node.get_id(), "hi bob")
except TimeoutError:
    print("Got timeout error")
finally:  # stop nodes
    alice_node.stop()
    bob_node.stop()

Relay messages:

Relay messages are sent to the node nearest the receiver in the routing table that accepts the relay message. This continues until it reaches the destination or the nearest node to the receiver is reached.

Because messages are always relayed only to reachable nodes in the current routing table, there is a fare chance nodes behind a NAT can be reached if it is connected to the network.

#!/usr/bin/env python
# from examples/relay_message.py
import time
import binascii
import storjnode
from crochet import setup, TimeoutError
setup()  # start twisted via crochet


# create alice node (with bitcoin wif as node key)
alice_key = "Kyh4a6zF1TkBZW6gyzwe7XRVtJ18Y75C2bC2d9axeWZnoUdAVXYc"
alice_node = storjnode.network.Node(
    alice_key, bootstrap_nodes=[("240.0.0.0", 1337)]  # isolate
)


# create bob node (with bitcoin hwif as node key)
bob_key = ("xprv9s21ZrQH143K3uzRG1qUPdYhVZG1TAxQ9bLTWZuFf1FHR5hiWuRf"
        "o2L2ZNoUX9BW17guAbMXqHjMJXBFvuTBD2WWvRT3zNbtVJ1S7yxUvWd")
bob_node = storjnode.network.Node(
    bob_key, bootstrap_nodes=[("127.0.0.1", alice_node.port)]  # isolate
)


# add message handler to bob node
def message_handler(source, message):
    src = binascii.hexlify(source) if source is not None else "unknown"
    print("%s from %s" % (message, src))
alice_node.add_message_handler(message_handler)


print("Giving nodes some time to find peers.")
time.sleep(storjnode.network.WALK_TIMEOUT)


try:
    # send relayed message (non blocking call)
    bob_node.relay_message(alice_node.get_id(), "hi alice")
    time.sleep(storjnode.network.WALK_TIMEOUT)  # wait for it to be relayed

except TimeoutError:
    print("Got timeout error")

finally:  # stop nodes
    alice_node.stop()
    bob_node.stop()

Network mapping

You can crawl the network to create a map of the network. Generating a graph of the network is also possable (though not reccomended for networks with many nodes).

#!/usr/bin/env python
# from examples/map_network.py
import time
import storjnode
import datetime
from crochet import setup
from storjnode.common import STORJ_HOME
setup()  # start twisted via crochet


key = "Kyh4a6zF1TkBZW6gyzwe7XRVtJ18Y75C2bC2d9axeWZnoUdAVXYc"
node = storjnode.network.Node(key)


print("Giving nodes some time to find peers.")
time.sleep(storjnode.network.WALK_TIMEOUT)


try:
    netmap = storjnode.network.map.generate(node)
    now = datetime.datetime.now()
    storjnode.util.ensure_path_exists(STORJ_HOME)
    storjnode.network.map.render(netmap, STORJ_HOME, "netmap %s" % str(now))
finally:
    node.stop()