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.
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
kmd packages provide HTTP clients for the Key Management Daemon. It is responsible for managing spending key material, signing transactions, and managing wallets.
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.
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
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).
Run tests with
make docker-test. To set up the sandbox-based test harness without standing up the go-algorand docker image use
To download the SDK, open a terminal and use the
go get command.
go get -u github.com/algorand/go-algorand-sdk/...
Package models defines models used by an algod rest client// IF YOU MODIFY THIS FILE: IMPORTANT In practice, this is straight up copied from /v1/models/model.go.
|Package models defines models used by an algod rest client// IF YOU MODIFY THIS FILE: IMPORTANT In practice, this is straight up copied from /v1/models/model.go.|
Code generated during build process, along with langspec.json.
|Code generated during build process, along with langspec.json.|