Skip to content

Latest commit

 

History

History
45 lines (26 loc) · 2.89 KB

README.md

File metadata and controls

45 lines (26 loc) · 2.89 KB
Raw

go-algorand-sdk

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 pkg.go.dev. You can also self-host the documentation by running godoc -http=:8099 and visiting http://localhost:8099/pkg/github.com/algorand/go-algorand-sdk/v2 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.

transaction 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.

We use golangci-lint to run linters on our codebase. Please run make lint before you submit a PR to make sure it conforms to linter standards.

We use cucumber testing for all of our SDKs, including this one. Please refer to algorand-sdk-testing for guidance and existing tests that you may need to update. Depending on the type of update you with to contribute, you may also need to have corresponding updates in the other SDKs (Java, JS, and Python). Feel welcome to ask for collaboration on that front.

Quick Start

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

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