Skip to content

zyablitsev/algorand-privatenetwork

Repository files navigation

Algorand PrivateNetwork Sandbox. The Simplest Tool

This is Algorand Sandbox alternative to create an Algorand development environment.

jq is required (https://stedolan.github.io/jq/).

Docker is not needed.

Postgres should be installed if you need Indexer in your environment.

Usage

Create and edit configuration file:

~$ cp config.example config
~$ vi config

Use the make command to interact with the Algorand PrivateNetwork Sandbox.

make commands:
  binaries-download   -> fetch latest release of algorand node, tools and indexer binaries.
  binaries-clean      -> delete binaries.

  network-create      -> init private network.
  network-start       -> start private network.
  network-stop        -> stop private network.
  network-delete      -> delete private network.
  network-status      -> get node status.
  account-list        -> list of algorand accounts on this machine.

  kmd-start           -> start kmd service.
  kmd-stop            -> stop kmd service.

  pgschema-install    -> create postgres database for indexer.
  pgschema-uninstall  -> remove indexer database.
  indexer-start       -> start indexer.

  clean               -> full cleanup.

Getting Started

Network (algod)

Open a terminal and run:

~$ git clone https://github.com/zyablitsev/algorand-privatenetwork.git

In whatever local directory the private network sandbox should reside. Then:

~$ cd algorand-privatenetwork
~$ cp config.example config
~$ vi config
~$ make binaries-download network-create network-start

This will download binaries, configure private network and start it.

algod endoint:

  • address: http://localhost:4001
  • token (from config): aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

Key management daemon (kmd)

Run:

~$ make kmd-start

kmd endpoint:

  • address: http://localhost:4002
  • token (from config): cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc

Indexer

To start indexer make sure the postgres is running. Then:

~$ make pgschema-install indexer-start

indexer endpoint:

  • address: http://localhost:8980

Example curl command

~$ curl "localhost:8980/v2/accounts"

About

Algorand node for development environment

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published