Reticulum/Examples/Minimal.py

##########################################################
# This RNS example demonstrates a minimal setup, that    #
# will start up the Reticulum Network Stack, generate a  #
# new destination, and let the user send an announce.    #
##########################################################

import argparse
import RNS

# Let's define an app name. We'll use this for all
# destinations we create. Since this basic example
# is part of a range of example utilities, we'll put
# them all within the app namespace "example_utilities"
APP_NAME = "example_utilitites"

# This initialisation is executed when the program is started
def program_setup(configpath):
	# We must first initialise Reticulum
	reticulum = RNS.Reticulum(configpath)
	
	# Randomly create a new identity for our example
	identity = RNS.Identity()

	# Using the identity we just created, we create a destination.
	# Destinations are endpoints in Reticulum, that can be addressed
	# and communicated with. Destinations can also announce their
	# existence, which will let the network know they are reachable
	# and autoomatically create paths to them, from anywhere else
	# in the network.
	destination = RNS.Destination(identity, RNS.Destination.IN, RNS.Destination.SINGLE, APP_NAME, "minimalsample")

	# We configure the destination to automatically prove all
	# packets adressed to it. By doing this, RNS will automatically
	# generate a proof for each incoming packet and transmit it
	# back to the sender of that packet. This will let anyone that
	# tries to communicate with the destination know whether their
	# communication was received correctly.
	destination.set_proof_strategy(RNS.Destination.PROVE_ALL)
	
	# Everything's ready!
	# Let's hand over control to the announce loop
	announceLoop(destination)


def announceLoop(destination):
	# Let the user know that everything is ready
	RNS.log("Minimal example "+RNS.prettyhexrep(destination.hash)+" running, hit enter to manually send an announce (Ctrl-C to quit)")

	# We enter a loop that runs until the users exits.
	# If the user hits enter, we will announce our server
	# destination on the network, which will let clients
	# know how to create messages directed towards it.
	while True:
		entered = input()
		destination.announce()
		RNS.log("Sent announce from "+RNS.prettyhexrep(destination.hash))


##########################################################
#### Program Startup #####################################
##########################################################

# This part of the program gets run at startup,
# and parses input from the user, and then starts
# the desired program mode.
if __name__ == "__main__":
	try:
		parser = argparse.ArgumentParser(description="Bare minimum example to start Reticulum and create a destination")
		parser.add_argument("--config", action="store", default=None, help="path to alternative Reticulum config directory", type=str)
		args = parser.parse_args()

		if args.config:
			configarg = args.config
		else:
			configarg = None

		program_setup(configarg)

	except KeyboardInterrupt:
		print("")
		exit()