CONTRIBUTING.md

Checklists & quick info

• Bug Reports
• Feature Requests
• Questions
• Adding a new coin

Development info

Tests

Unit

To run the unit tests: make test

Integration

All integration tests are generated automatically. You only need to set the environment to your coin in the config file. The tests use a different build constraint, named integration.

To run the integration tests: make integration

or you can run manually: TEST_CONFIG=$(TEST_CONFIG) TEST_COINS=$(TEST_COINS) go test -tags=integration -v ./pkg/integration

Fixtures

• If you need to change the parameters used in our tests, update the file pkg/integration/testdata/fixtures.json
• To exclude an API from integration tests, you need to add the route inside the file pkg/integration/testdata/exclude.json E.g.:

[
  "/v2/ethereum/collections/:owner",
  "/v2/ethereum/collections/:owner/collection/:collection_id"
]

Error conventions

Use our error package for error handling and follow Go best practices. All errors thrown in BlockAtlas should use our Error struct:

type Error struct {
	Err   error
	Type  Type
	meta  map[string]interface{}
	stack []string
}

E is a convenience function for creating errors quickly:

func E(args ...interface{}) *Error

Usage:

• Wrap a generic error: errors.New(err)
• Wrap error with message: errors.New(err, "new message to append")
• Annotate error with type: errors.New(err, errors.TypePlatformRequest)
• Error with type and metadata:

errors.New(err, errors.TypePlatformRequest, errors.Params{
    "coin":   "Ethereum",
    "method": "CurrentBlockNumber",
})

• Any other combinations above

*All fatal errors emitted by logger package already send the error to *

List of error types

Logging Conventions

Use the package pkg/logger for logging. The order of function parameters is arbitrary when using the logger functions. Examples:

• Log message: log.Info("Loading Observer API")
• Log message with params: log.Info("Running application", log.Params{"bind": bind})
• Fatal with error: log.Fatal("Application failed", err)
• Create a simple error log: log.Error(err)
• Create an error log with a message: log.Error("Failed to initialize API", err)
• Create an error log, with error, message, and params:

p := log.Params{
	"platform": handle,
	"coin":     platform.Coin(),
}
err := platform.Init()
if err != nil {
	log.Error("Failed to initialize API", err, p)
}

• Debug log: log.Debug("Loading Observer API") or log.Debug("Loading Observer API", log.Params{"bind": bind})
• Warning log: log.Warn("Warning", err) or log.Warn(err, "Warning") or log.Warn("Warning", err, log.Params{"bind": bind})