digitalbitsgo

package module
Version: v0.0.0-...-798156f Latest Latest
Warning

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

Go to latest
Published: Oct 3, 2018 License: Apache-2.0 Imports: 0 Imported by: 0

README

DigitalBits Go

Build Status GoDoc Go Report Card

This repo is the home for all of the public go code produced by SDF. In addition to various tools and services, this repository is the SDK from which you may develop your own applications that integrate with the DigitalBits network.

Dependencies

NOTE: this repo presently uses a fork of govalidator that incorporates https://github.com/asaskevich/govalidator/pull/165. Vendored dependencies must be restored (using glide install) to get proper behaviour. In other words, this repo is not currently "go gettable"

This repository depends upon a number of external dependencies, and we use Glide to manage them. Glide is used to populate the vendor directory, ensuring that builds are reproducible even as upstream dependencies are changed. Please see the Glide website for installation instructions.

When creating this project, we had to decide whether or not we committed our external dependencies to the repo. We decided that we would not, by default, do so. This lets us avoid the diff churn associated with updating dependencies while allowing an acceptable path to get reproducible builds. To do so, simply install glide and run glide install in your checkout of the code. We realize this is a judgement call; Please feel free to open an issue if you would like to make a case that we change this policy.

Directory Layout

In addition to the other top-level packages, there are a few special directories that contain specific types of packages:

  • clients contains packages that provide client packages to the various DigitalBits services.
  • exp contains experimental packages. Use at your own risk.
  • handlers contains packages that provide pluggable implementors of http.Handler that make it easier to incorporate portions of the DigitalBits protocol into your own http server.
  • support contains packages that are not intended for consumption outside of DigitalBits' other packages. Packages that provide common infrastructure for use in our services and tools should go here, such as db or log.
  • support/scripts contains single-file go programs and bash scripts used to support the development of this repo.
  • services contains packages that compile to applications that are long-running processes (such as API servers).
  • tools contains packages that compile to command line applications.

Each of these directories have their own README file that explain further the nature of their contents.

Other packages

In addition to the packages described above, this repository contains various packages related to working with the DigitalBits network from a go program. It's recommended that you use godoc to browse the documentation for each.

Package source layout

While much of the code in individual packages is organized based upon different developers' personal preferences, many of the packages follow a simple convention for organizing the declarations inside of a package that aim to aid in your ability to find code.

In each package, there may be one or more of a set of common files:

  • main.go: Every package should have a main.go file. This file contains the package documentation (unless a separate doc.go file is used), all of the exported vars, consts, types and funcs for the package.
  • internal.go: This file should contain unexported vars, consts, types, and funcs. Conceptually, it should be considered the private counterpart to the main.go file of a package
  • errors.go: This file should contains declarations (both types and vars) for errors that are used by the package.
  • example_test.go: This file should contains example tests, as described at https://blog.golang.org/examples.

In addition to the above files, a package often has files that contains code that is specific to one declared type. This file uses the snake case form of the type name (for example loggly_hook.go would correspond to the type LogglyHook). This file should contain method declarations, interface implementation assertions and any other declarations that are tied solely to to that type.

Each non-test file can have a test counterpart like normal, whose name ends with _test.go. The common files described above also have their own test counterparts... for example internal_test.go should contains tests that test unexported behavior and more commonly test helpers that are unexported.

Generally, file contents are sorted by exported/unexported, then declaration type (ordered as consts, vars, types, then funcs), then finally alphabetically.

Test helpers

Often, we provide test packages that aid in the creation of tests that interact with our other packages. For example, the support/db package has the support/db/dbtest package underneath it that contains elements that make it easier to test code that accesses a SQL database. We've found that this pattern of having a separate test package maximizes flexibility and simplifies package dependencies.

Coding conventions

  • Always document exported package elements: vars, consts, funcs, types, etc.
  • Tests are better than no tests.

Documentation

The Go Gopher

There is no documentation for this package.

Source Files

Directories

Path Synopsis
Package address provides utility functions for working with digitalbits addresses.
Package address provides utility functions for working with digitalbits addresses.
Package amount provides utilities for converting numbers to/from the format used internally to digitalbits-core.
Package amount provides utilities for converting numbers to/from the format used internally to digitalbits-core.
Package build implements a builder system for constructing various xdr structures used by the DigitalBits network, most importanly transactions.
Package build implements a builder system for constructing various xdr structures used by the DigitalBits network, most importanly transactions.
Package clients contains sub-packages that provide client access to the various digitalbits services.
Package clients contains sub-packages that provide client access to the various digitalbits services.
digitalbitscore
Package digitalbitscore is a client library for communicating with an instance of digitalbits-core using through the server's HTTP port.
Package digitalbitscore is a client library for communicating with an instance of digitalbits-core using through the server's HTTP port.
frontier
Package frontier provides client access to a frontier server, allowing an application to post transactions and lookup ledger information.
Package frontier provides client access to a frontier server, allowing an application to post transactions and lookup ledger information.
Package crc16 is implementation according to CCITT standards.
Package crc16 is implementation according to CCITT standards.
examples
exp
Package exp houses experimental packages related to DigitalBits developement
Package exp houses experimental packages related to DigitalBits developement
crypto/derivation
Package derivation provides functions for ed25519 key derivation as described in: https://github.com/satoshilabs/slips/blob/master/slip-0010.md
Package derivation provides functions for ed25519 key derivation as described in: https://github.com/satoshilabs/slips/blob/master/slip-0010.md
handlers
federation
Package federation provides a pluggable handler that satisfies the DigitalBits federation protocol.
Package federation provides a pluggable handler that satisfies the DigitalBits federation protocol.
Package meta provides helpers for processing the metadata that is produced by digitalbits-core while processing transactions.
Package meta provides helpers for processing the metadata that is produced by digitalbits-core while processing transactions.
Package network contains functions that deal with digitalbits network passphrases and IDs.
Package network contains functions that deal with digitalbits network passphrases and IDs.
Package price implements functions to ease working with digitalbits price values.
Package price implements functions to ease working with digitalbits price values.
protocols
Package services contains sub-packages that provide long-running applications such as API servers.
Package services contains sub-packages that provide long-running applications such as API servers.
bifrost/stress
Structs and functions used in stress tests
Structs and functions used in stress tests
Package strkey is an implementation of StrKey, the address scheme for the StellarNetwork.
Package strkey is an implementation of StrKey, the address scheme for the StellarNetwork.
support
app
Package app provides vars that can be populated via "-X" linker flags to provide global application metadata, such as build time or version.
Package app provides vars that can be populated via "-X" linker flags to provide global application metadata, such as build time or version.
config
Package config provides a common infrastructure for reading configuration data stored in local TOML files.
Package config provides a common infrastructure for reading configuration data stored in local TOML files.
db
Package db is the base package for database access at digitalbits.
Package db is the base package for database access at digitalbits.
db/dbtest
Package dbtest is a package to ease the pain of developing test code that works against external databases.
Package dbtest is a package to ease the pain of developing test code that works against external databases.
db/sqlutils
Package sqlutils contains utility functions for manipulating strings of SQL
Package sqlutils contains utility functions for manipulating strings of SQL
errors
Package errors provides the common infrastructure for managing errors.
Package errors provides the common infrastructure for managing errors.
http
Package http provides easy access to digitalbits's best practices for building http servers.
Package http provides easy access to digitalbits's best practices for building http servers.
http/httptest
Package httptest enhances the stdlib net/http/httptest package by integrating it with gopkg.in/gavv/httpexpect.v1, reducing the boilerplate needed for http tests.
Package httptest enhances the stdlib net/http/httptest package by integrating it with gopkg.in/gavv/httpexpect.v1, reducing the boilerplate needed for http tests.
http/mutil
Package mutil contains various functions that are helpful when writing http middleware.
Package mutil contains various functions that are helpful when writing http middleware.
log
Package log provides the common logging facilities used by the digitalbits Development foundation.
Package log provides the common logging facilities used by the digitalbits Development foundation.
test
Package test contains simple test helpers that should not have any service-specific dependencies.
Package test contains simple test helpers that should not have any service-specific dependencies.
url
tools
xdb-sign
xdb-sign is a small interactive utility to help you contribute a signature to a transaction envelope.
xdb-sign is a small interactive utility to help you contribute a signature to a transaction envelope.
Package xdr contains the generated code for parsing the xdr structures used for digitalbits.
Package xdr contains the generated code for parsing the xdr structures used for digitalbits.

Jump to

Keyboard shortcuts

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