Skip to content

Documentation for Algorand's Go implementation

Notifications You must be signed in to change notification settings

Adg0/go-algorand-doc

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

90 Commits
 
 
 
 
 
 
 
 

Repository files navigation

go-algorand-doc

Getting started with TestNet

This Repo contains the installers for the Algorand Blockchain TestNet.

To get started, refer to the Node Setup Guide. All developer documentation is available at Developer.algorgand.org.

We are using many different communication channels for discussing TestNet. Our official channel for TestNet support is https://community.algorand.com/. We will also be monitoring this Github repo for issues and discussions.

Node hardware requirements (subject to change)

At this time, we're expecting participants to run standalone Nodes and not Relays, so the hardware requirements are fairly minimal. You need 4-8GB RAM, 100GB HDD/SSD, and 10Mbit broadband. The more cores in your CPU the better, but generally 4 cores are more than enough for a single node. There are diminishing returns after that. There is no specific GPU-optimized code, so your graphics card should have no impact.

Once you have a running node

Ensure you have enabled telemetry and send us your Node name and GUID so we can correlate telemetry properly. This process is explained in the Node Setup Guide.

It's important that you are configured to update regularly or you risk being disconnected from the network and unable to connect until after you update. Not to mention falling behind in features and bug fixes. We recommend setting up a CRON job as outlined in the Configuring Auto-Update Guide. If you want to manually check for an update, use ./update.sh -d ~/node/data as discussed in the Setup Guide.

Using GOAL

Run goal --help to get help.

Most commands need you to specify the location of the data folder. You can set ALGORAND_DATA in the environment if you want to skip that step when using goal.

e.g.

./goal node status -d ~/node/data
./goal account new -d ~/node/data

Once you create an account, you can use our Dispenser to transfer tokens to your account.

The ./goal clerk command is used to generate your own transactions.

We currently have a dashboard running for TestNet, which displays the view of the blockchain from one of our Relays.

We sometimes have a script running that's generating random transactions between some test accounts, generating ~4 TPS on the network.

Writing your own client

Refer to our Using the SDKs and REST APIs documentation as a starting point for writing your own clients.

Let us know where you would like more documentation and we'll look at prioritizing that.

Thanks, and Welcome to Algorand's TestNet!

About

Documentation for Algorand's Go implementation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 67.2%
  • Go 29.4%
  • Dockerfile 3.4%