Skip to content

algorand/go-algorand-sdk

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Nov 3, 2022
a615ed1 · Nov 3, 2022
Nov 2, 2022
Jul 6, 2022
Aug 16, 2022
Mar 1, 2019
Nov 2, 2022
Sep 1, 2022
Mar 28, 2022
Jan 20, 2022
Nov 2, 2022
Aug 31, 2022
Mar 14, 2019
Sep 13, 2021
Nov 2, 2022
Jun 21, 2021
Nov 2, 2022
Nov 2, 2022
Oct 7, 2022
Nov 2, 2022
Jul 1, 2019
Feb 7, 2019
Feb 19, 2019
Oct 7, 2022
Aug 22, 2022
Aug 31, 2022
Aug 31, 2022
Oct 7, 2022

Repository files navigation

go-algorand-sdk

Build Status Go Report Card GoDoc

The Algorand golang SDK provides:

  • HTTP clients for the algod (agreement) and kmd (key management) APIs
  • Standalone functionality for interacting with the Algorand protocol, including transaction signing, message encoding, etc.

Documentation

Full documentation is available on godoc. You can also self-host the documentation by running godoc -http=:8099 and visiting http://localhost:8099/pkg/github.com/algorand/go-algorand-sdk in your web browser.

Additional developer documentation and examples can be found on developer.algorand.org

Package overview

In client/, the kmd packages provide HTTP clients for the Key Management Daemon. It is responsible for managing spending key material, signing transactions, and managing wallets. In client/v2 the algod package contains a client for the Algorand protocol daemon HTTP API. You can use it to check the status of the blockchain, read a block, look at transactions, or submit a signed transaction. In client/v2 the indexer package contains a client for the Algorand Indexer API. You can use it to query historical transactions or make queries about the current state of the chain.

future package contains Transaction building utility functions.

types contains the data structures you'll use when interacting with the network, including addresses, transactions, multisig signatures, etc.

encoding contains the json and msgpack packages, which can be used to serialize messages for the algod/kmd APIs and the network.

mnemonic contains support for turning 32-byte keys into checksummed, human-readable mnemonics (and going from mnemonics back to keys).

SDK Development

Run tests with make docker-test. To set up the sandbox-based test harness without standing up the go-algorand docker image use make harness.

Quick Start

To download the SDK, open a terminal and use the go get command.

go get -u github.com/algorand/go-algorand-sdk/...