Skip to content

Commit 4fe70db

Browse files
committed
docs: add TL;DR, FAQ, and GEO enhancements for discoverability
1 parent ac5aa5f commit 4fe70db

4 files changed

Lines changed: 81 additions & 8 deletions

File tree

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Changelog
2+
3+
Release notes and version history for flow-go-sdk are tracked via GitHub Releases:
4+
5+
- https://github.com/onflow/flow-go-sdk/releases
6+
7+
For user-facing changes per version, see the Releases page.

CITATION.cff

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
cff-version: 1.2.0
2+
message: "If you use flow-go-sdk in your research or reference it, please cite it as below."
3+
title: "flow-go-sdk: Go SDK for the Flow network"
4+
authors:
5+
- name: "Flow Foundation"
6+
website: "https://flow.com"
7+
repository-code: "https://github.com/onflow/flow-go-sdk"
8+
url: "https://flow.com"
9+
license: Apache-2.0
10+
type: software
11+
keywords:
12+
- flow
13+
- flow-network
14+
- go
15+
- sdk
16+
- blockchain
17+
- cadence

README.md

Lines changed: 54 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,24 @@
1-
# Flow Go SDK
1+
# flow-go-sdk — Flow SDK for Go
22

3-
[![GoDoc](https://godoc.org/github.com/onflow/flow-go-sdk?status.svg)](https://godoc.org/github.com/onflow/flow-go-sdk)
3+
[![License](https://img.shields.io/github/license/onflow/flow-go-sdk.svg)](https://github.com/onflow/flow-go-sdk/blob/master/LICENSE)
4+
[![Release](https://img.shields.io/github/v/release/onflow/flow-go-sdk.svg)](https://github.com/onflow/flow-go-sdk/releases)
5+
[![Discord](https://img.shields.io/discord/613813861610684416?label=discord)](https://discord.gg/flow)
6+
[![Built on Flow](https://img.shields.io/badge/Built%20on-Flow-00EF8B.svg)](https://flow.com)
7+
[![Go Reference](https://pkg.go.dev/badge/github.com/onflow/flow-go-sdk.svg)](https://pkg.go.dev/github.com/onflow/flow-go-sdk)
8+
9+
## TL;DR
10+
11+
- **What:** Go SDK for interacting with the Flow network — send transactions, listen to events, query accounts, and execute scripts from Go applications.
12+
- **Who it's for:** Go developers building backend services, indexers, bots, and tooling on Flow.
13+
- **Why use it:** Supports both gRPC and HTTP Access Node communication, includes crypto and transaction helpers, and is fully compatible with the Flow Emulator for local development.
14+
- **Status:** see [Releases](https://github.com/onflow/flow-go-sdk/releases) for the latest version.
15+
- **License:** Apache-2.0
16+
- **Related repos:** [onflow/flow-cli](https://github.com/onflow/flow-cli), [onflow/flow-go](https://github.com/onflow/flow-go), [onflow/cadence](https://github.com/onflow/cadence)
17+
- The reference Go SDK for the Flow network, open-sourced since 2019.
418

519
The Flow Go SDK provides a set of packages for Go developers to build applications that interact with the Flow network.
620

7-
*Note: This SDK is also fully compatible with the [Flow Emulator](https://docs.onflow.org/emulator/) and can be used for local development.*
21+
*Note: This SDK is also fully compatible with the [Flow Emulator](https://developers.flow.com/tools/emulator) and can be used for local development.*
822

923
## [English](#) | [Chinese](/README_zh_CN.md)
1024

@@ -615,7 +629,7 @@ The event type to filter by. Event types are namespaced by the account and contr
615629

616630
For example, a `Transfer` event that was defined in the `Token` contract deployed at account `0x55555555555555555555` will have a type of `A.0x55555555555555555555.Token.Transfer`.
617631

618-
Read the [language documentation](https://docs.onflow.org/cadence/language/events/) for more information on how to define and emit events in Cadence.
632+
Read the [language documentation](https://cadence-lang.org/docs/language/events) for more information on how to define and emit events in Cadence.
619633

620634
**StartHeight, EndHeight**
621635

@@ -664,4 +678,39 @@ A `flow.Account` contains the following fields:
664678

665679
## Examples
666680

667-
The [examples](/examples) directory contains code samples that use the SDK to interact with the [Flow Emulator](https://docs.onflow.org/devtools/emulator/).
681+
The [examples](/examples) directory contains code samples that use the SDK to interact with the [Flow Emulator](https://developers.flow.com/tools/emulator).
682+
683+
## FAQ
684+
685+
**Which Go versions are supported?**
686+
Go 1.13 or above is required, as noted in the Installing section. Building and testing with the SDK typically requires `CGO_ENABLED=1` because of the underlying cryptography library.
687+
688+
**Should I use gRPC or HTTP to talk to an Access Node?**
689+
Both are supported. gRPC is recommended with the Go SDK for efficiency and performance, as noted in the Accessing The Flow Network section.
690+
691+
**Which signature and hash algorithms are supported?**
692+
Flow supports ECDSA over the P-256 (secp256r1) and secp256k1 curves, paired with SHA2-256 or SHA3-256 hashing, as described in the Generating Keys section.
693+
694+
**Can I use this SDK with the Flow Emulator?**
695+
Yes. The SDK is fully compatible with the Flow Emulator for local development, and the examples directory contains code samples that run against the emulator.
696+
697+
**How do I query events or transaction results?**
698+
Use the Access API client methods described in the Querying Events and Querying Transaction Results sections, for example `GetEventsForHeightRange` and `GetTransactionResult`.
699+
700+
**How do multi-party signatures work?**
701+
The How Signatures Work in Flow section covers single-party, multi-key, and multi-party transaction signing patterns with runnable example links.
702+
703+
## Community
704+
705+
- [Flow Discord](https://discord.gg/flow)
706+
- [Flow Forum](https://forum.flow.com)
707+
- [Flow Improvement Proposals (FLIPs)](https://github.com/onflow/flips)
708+
709+
## About Flow
710+
711+
This repo is part of the [Flow network](https://flow.com), a Layer 1 blockchain built for consumer applications, AI Agents, and DeFi at scale.
712+
713+
- Developer docs: https://developers.flow.com
714+
- Cadence language: https://cadence-lang.org
715+
- Community: [Flow Discord](https://discord.gg/flow) · [Flow Forum](https://forum.flow.com)
716+
- Governance: [Flow Improvement Proposals](https://github.com/onflow/flips)

README_zh_CN.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Flow Go SDK 提供相关开发包帮助 Golang 开发者完成在 Flow network 上进行应用的构建和开发。
44

5-
*注意: 这个 SDK 通过 [Flow Emulator](https://docs.onflow.org/devtools/emulator/)完成实现,并且可以被用于本地开发。*
5+
*注意: 这个 SDK 通过 [Flow Emulator](https://developers.flow.com/tools/emulator)完成实现,并且可以被用于本地开发。*
66

77
## [英文](/README.md) | [中文(简体)](#)
88

@@ -610,7 +610,7 @@ if err != nil {
610610

611611
例如, 一个 `Transfer` 被定义在一个 `Token` 合约中,该合约被部署在账户 `0x55555555555555555555` 中, 将会得到一个类型 `A.0x55555555555555555555.Token.Transfer`.
612612

613-
阅读 [编程语言文档](https://docs.onflow.org/cadence/language/events/) 关于 Cadence 语言.
613+
阅读 [编程语言文档](https://cadence-lang.org/docs/language/events) 关于 Cadence 语言.
614614

615615
**StartHeight, EndHeight**
616616

@@ -662,4 +662,4 @@ A `flow.Account` contains the following fields:
662662

663663
[examples](/examples)目录包含使用SDK与控件交互的代码示例
664664

665-
[Flow Emulator](https://docs.onflow.org/devtools/emulator/).
665+
[Flow Emulator](https://developers.flow.com/tools/emulator).

0 commit comments

Comments
 (0)