Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aviate-labs/agent-go
Golang Agent for the Internet Computer
https://github.com/aviate-labs/agent-go
agent blockchain dfinity golang icp internet-computer
Last synced: 5 days ago
JSON representation
Golang Agent for the Internet Computer
- Host: GitHub
- URL: https://github.com/aviate-labs/agent-go
- Owner: aviate-labs
- License: apache-2.0
- Created: 2021-06-09T13:50:41.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-18T10:23:01.000Z (3 months ago)
- Last Synced: 2024-08-19T07:57:10.570Z (3 months ago)
- Topics: agent, blockchain, dfinity, golang, icp, internet-computer
- Language: Go
- Homepage:
- Size: 688 KB
- Stars: 35
- Watchers: 1
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-internet-computer - agent-go - Libraries for interfacing with the IC using Go. (Client Libraries (Agents) / Go)
- awesome-icp - aviate-labs/agent-go
README
# Go Agent for the Internet Computer
[](https://github.com/aviate-labs/agent-go)
[](https://pkg.go.dev/github.com/aviate-labs/agent-go)
```shell
go get github.com/aviate-labs/agent-go
```
## Getting Started
The agent is a library that allows you to talk to the Internet Computer.
```go
package main
import (
"github.com/aviate-labs/agent-go"
"github.com/aviate-labs/agent-go/ic"
"log"
)
type (
Account struct {
Account string `ic:"account"`
}
Balance struct {
E8S uint64 `ic:"e8s"`
}
)
func main() {
a, _ := agent.New(agent.DefaultConfig)
var balance Balance
if err := a.Query(
ic.LEDGER_PRINCIPAL, "account_balance_dfx",
[]any{Account{"9523dc824aa062dcd9c91b98f4594ff9c6af661ac96747daef2090b7fe87037d"}},
[]any{&balance},
); err != nil {
log.Fatal(err)
}
_ = balance // Balance{E8S: 0}
}
```
### Using an Identity
Supported identities are `Ed25519` and `Secp256k1`. By default, the agent uses the anonymous identity.
```go
id, _ := identity.NewEd25519Identity(publicKey, privateKey)
config := agent.Config{
Identity: id,
}
```
### Using the Local Replica
If you are running a local replica, you can use the `FetchRootKey` option to fetch the root key from the replica.
```go
u, _ := url.Parse("http://localhost:8000")
config := agent.Config{
ClientConfig: &agent.ClientConfig{Host: u},
FetchRootKey: true,
DisableSignedQueryVerification: true,
}
```
## Packages
You can find the documentation for each package in the links below. Examples can be found throughout the documentation.
| Package Name | Links | Description |
|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------|
| `agent` | [](https://github.com/aviate-labs/agent-go) [](https://pkg.go.dev/github.com/aviate-labs/agent-go) | A library to talk directly to the Replica. |
| `candid` | [](https://pkg.go.dev/github.com/aviate-labs/agent-go/candid) | A Candid library for Golang. |
| `certification` | [](https://pkg.go.dev/github.com/aviate-labs/agent-go/certificate) | A Certification library for Golang. |
| `gen` | [](https://pkg.go.dev/github.com/aviate-labs/agent-go/gen) | A library to generate Golang clients. |
| `ic` | [](https://pkg.go.dev/github.com/aviate-labs/agent-go/ic) | Multiple auto-generated sub-modules to talk to the Internet Computer services |
| `identity` | [](https://pkg.go.dev/github.com/aviate-labs/agent-go/identity) | A library that creates/manages identities. |
| `pocketic` | [](https://pkg.go.dev/github.com/aviate-labs/agent-go/pocketic) | A client library to talk to the PocketIC Server. |
| `principal` | [](https://pkg.go.dev/github.com/aviate-labs/agent-go/principal) | Generic Identifiers for the Internet Computer |
| `registry` | [](https://pkg.go.dev/github.com/aviate-labs/agent-go/registry) | A client to interact with the registry canister. |
More dependencies in the [go.mod](./go.mod) file.
## CLI
```shell
go install github.com/aviate-labs/agent-go/cmd/goic@latest
```
Read more [here](cmd/goic/README.md)
## Testing
This repository contains two types of tests: standard Go tests and [PocketIC](https://github.com/dfinity/pocketic)
-dependent tests. The test suite runs a local PocketIC server using the installed pocket-ic-server to execute some
end-to-end (e2e) tests. If pocket-ic-server is not installed, those specific tests will be skipped.
```shell
go test -v ./...
```
## Reference Implementations
- [Rust Agent](https://github.com/dfinity/agent-rs/)
- [JavaScript Agent](https://github.com/dfinity/agent-js/)