auroraclient

auroraclient

auroraclient is a Hcnet Go SDK package that provides client access to a aurora server. It supports all endpoints exposed by the aurora API.

This project is maintained by the Hcnet Development Foundation.

Getting Started

This library is aimed at developers building Go applications that interact with the Hcnet network. It allows users to query the network and submit transactions to the network. The recommended transaction builder for Go programmers is txnbuild. Together, these two libraries provide a complete Hcnet SDK.

• The auroraclient API reference.
• The txnbuild API reference.

Prerequisites

• Go (this repository is officially supported on the last two releases of Go)
• Modules to manage dependencies

Installing

• go get github.com/HashCash-Consultants/go/clients/auroraclient

Usage

    ...
    import hClient "github.com/HashCash-Consultants/go/clients/auroraclient"
    ...

    // Use the default pubnet client
    client := hClient.DefaultPublicNetClient

    // Create an account request
    accountRequest := hClient.AccountRequest{AccountID: "GCLWGQPMKXQSPF776IU33AH4PZNOOWNAWGGKVTBQMIC5IMKUNP3E6NVU"}

    // Load the account detail from the network
    account, err := client.AccountDetail(accountRequest)
    if err != nil {
        fmt.Println(err)
        return
    }
    // Account contains information about the hcnet account
    fmt.Print(account)

For more examples, refer to the documentation.

Running the tests

Run the unit tests from the package directory: go test

Contributing

Please read Code of Conduct to understand this project's communication rules.

To submit improvements and fixes to this library, please see CONTRIBUTING.

License

This project is licensed under the Apache License - see the LICENSE file for details.