https://github.com/algorand/go-algorand-sdk

Algorand Golang SDK
https://github.com/algorand/go-algorand-sdk

Last synced: 3 months ago
JSON representation

Algorand Golang SDK

• Host: GitHub
• URL: https://github.com/algorand/go-algorand-sdk
• Owner: algorand
• License: mit
• Created: 2019-02-04T18:11:43.000Z (over 5 years ago)
• Default Branch: develop
• Last Pushed: 2024-03-07T19:29:57.000Z (4 months ago)
• Last Synced: 2024-03-07T20:35:35.857Z (4 months ago)
• Language: Go
• Homepage: https://pkg.go.dev/github.com/algorand/go-algorand-sdk/v2
• Size: 1.67 MB
• Stars: 182
• Watchers: 23
• Forks: 86
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: CODEOWNERS

Lists

• awesome-algorand - go-algorand-sdk - The Algorand Golang SDK. (Development Tools / Languages)

README

        
# go-algorand-sdk

[![Go Report Card](https://goreportcard.com/badge/github.com/algorand/go-algorand-sdk)](https://goreportcard.com/report/github.com/algorand/go-algorand-sdk/v2)

[![GoDoc](https://godoc.org/github.com/algorand/go-algorand-sdk?status.svg)](https://godoc.org/github.com/algorand/go-algorand-sdk/v2)

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](https://pkg.go.dev/github.com/algorand/go-algorand-sdk/v2). 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](https://developer.algorand.org/docs/sdks/go/)

## 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](https://github.com/algorand/algorand-sdk-testing#readme) 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.

```sh

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

```