Flow SDK Guidelines
@devbugging is already working on this.
Since Jul 21, 2021.
- Dominant language
- Go
- Stars
- 361
- Forks
- 159
- PR merge metrics
- No merged PRs in 30d
Description
In order to provide SDK developers with expectations for what functionality a Flow SDKs should provide, we must create a language agnostic SDK spec. This specification should outline what functionality a Flow SDK should provide. The specification should not specify how such functionality must be achieved.
The outcome should be a specification for what functionality a Flow SDK must provide. Depending on which language implements the SDK spec, it should be flexible enough such that the varying features of such language can be utilized. The aim being that each Flow SDK can feel friendly and intuitive to users of the SDK's language, yet function with feature parity to Flow SDKs of other languages.
The Flow SDK spec will standardize a new "layer" of abstraction between the Flow protocol, Access API, Flow SDK and a developers application.
Layer 0: Flow Protocol
Layer 1: Access API
Layer 2: Flow SDK Spec <- New! Introduced by this issue.
Layer 3: A Flow SDK implementation.
Layer 4: A developers application.
Further Questions
- What are the set of features each SDK should provide?
- How can we standardize the ways that SDKs enable developers to engage with functionality exposed by the Access API?
Expected Outcomes
- A specification exists for the functionality a Flow SDK should implement.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.