rosetta-sdk-go

module
v0.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 8, 2020 License: Apache-2.0

README

rosetta-sdk-go

Coinbase Coverage Status Go Report Card License GoDoc

What is Rosetta?

Rosetta is a new project from Coinbase to standardize the process of deploying and interacting with blockchains. With an explicit specification to adhere to, all parties involved in blockchain development can spend less time figuring out how to integrate with each other and more time working on the novel advances that will push the blockchain ecosystem forward. In practice, this means that any blockchain project that implements the requirements outlined in this specification will enable exchanges, block explorers, and wallets to integrate with much less communication overhead and network-specific work.

Versioning

  • Rosetta version: 1.3.0

Installation

go get github.com/coinbase/rosetta-sdk-go

Automatic Assertion

When using the helper methods to access a Rosetta Server (in fetcher/*.go), responses from the server are automatically checked for adherence to the Rosetta Interface. For example, if a BlockIdentifer is returned without a Hash, the fetch will fail. Take a look at the tests in asserter/*_test.go if you are curious about what exactly is asserted.

It is possible, but not recommended, to bypass this assertion using the unsafe helper methods available in fetcher/*.go.

Development

  • make deps to install dependencies
  • make gen to generate models and helpers
  • make test to run tests
  • make lint to lint the source code (included generated code)
  • make release to check if code passes all tests run by CircleCI

License

This project is available open source under the terms of the Apache 2.0 License.

© 2020 Coinbase

Directories

Path Synopsis
types module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL