Giter VIP home page Giter VIP logo

go-algorand-sdk's Introduction

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

Quick Start

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

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

go-algorand-sdk's People

Contributors

ahangsu avatar algobarb avatar algobolson avatar algoidurovic avatar algojack avatar algomaxj avatar algonautshant avatar algorandskiy avatar algorotem avatar barnjamin avatar brianolson avatar bricerisingalgorand avatar egieseke avatar eric-warehime avatar evanjrichard avatar fabrice102 avatar fgamundi avatar id-ms avatar jasonpaulos avatar jasonweathersby avatar justicz avatar lyk0rian avatar mjiang102628 avatar onetechnical avatar ori-shem-tov avatar rotemh avatar shiqizng avatar songchenwen avatar vervious avatar winder avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.