package
0.0.0-20230203010516-6d4bf48beedd
Repository: https://github.com/onyx-protocol/onyx.git
Documentation: pkg.go.dev
# README
API
Idempotency
Most of the API endpoints are idempotent. Some endpoints require a client_token parameter that is used for
ensuring idempotency. These client tokens are only used as an idempotency key, and cannot be used to lookup
entities later.
# Packages
Package accesstoken provides storage and validation of Chain Core credentials.
Package account stores and tracks accounts within a Chain Core.
Package asset maintains a registry of all assets on a blockchain.
Package blocksigner implements remote block signing.
Package config is a generated protocol buffer package.
Package coretest provides utilities for testing Chain Core.
Package coreunsafe contains Core logic that is unsafe for production.
Package fetch implements block replication for participant Chain Cores.
Package generator implements the Chain Core generator.
Package leader implements leader election between cored processes of a Chain Core.
Package migrate implements database migration for Chain Core.
Package mockhsm provides a mock HSM for development environments.
No description provided by the author
Package query implements indexing and querying of annotated blockchain data.
Package rpc implements Chain Core's RPC client.
Package signers associates signers and their corresponding keys.
Package txbuilder builds a Chain Protocol transaction from a list of actions.
Package txdb provides storage for Chain Protocol blockchain data structures.
Package txfeed implements Chain Core's transaction feeds.
# Functions
No description provided by the author
BlockSigner configures the Core to use signFn to handle block-signing requests.
No description provided by the author
Config provides access to Chain Core configuration options and their values.
GeneratorLocal configures the launched Core to run as a Generator.
GeneratorRemote configures the launched Core to fetch blocks from the provided remote generator.
IndexTransactions configures whether or not transactions should be annotated and indexed for the query engine.
MockHSM configures the Core to expose the MockHSM endpoints.
RateLimit adds a rate-limiting restriction, using keyFn to extract the key to rate limit on.
RedirectHandler redirects / to /dashboard/.
Run launches a new configured Chain Core.
RunUnconfigured launches a new unconfigured Chain Core.
TLSConfig returns a TLS config suitable for use as a Chain Core client and server.
UseTLS configures the Core to use TLS with the given config when communicating between Core processes.
# Constants
No description provided by the author
# Type aliases
RunOption describes a runtime configuration option.