README
¶
🚀 lightnode
A node used for querying Darknodes using JSON-RPC 2.0 interfaces. Featuring query caching (for performance) as well as retrying for failed requests (for reliability).
Built with ❤ by Ren.
Building a Docker image
docker build . --build-arg GITHUB_TOKEN={your github token} --tag lightnode
Running a Docker image
Ensure you have a working local .env file for neccesary env vars set, then
docker run --env-file=.env --env DATABASE_URL=/lightnode/cache.sql --network host -v `pwd`/cache.sql:/lightnode/cache.sql lightnode
Documentation
¶
Index ¶
- Variables
- type Lightnode
- type Options
- func (opts Options) WithBootstrapAddrs(bootstrapAddrs []wire.Address) Options
- func (opts Options) WithCap(cap int) Options
- func (opts Options) WithChains(chains map[multichain.Chain]binding.ChainOptions) Options
- func (opts Options) WithClientTimeout(clientTimeout time.Duration) Options
- func (opts Options) WithConfirmerPollRate(confirmerPollRate time.Duration) Options
- func (opts Options) WithDistPubKey(distPubKey *id.PubKey) Options
- func (opts Options) WithLimiterGlobalRates(rates map[string]rate.Limit) Options
- func (opts Options) WithLimiterIPRates(rates map[string]rate.Limit) Options
- func (opts Options) WithLimiterMaxClients(maxClients int) Options
- func (opts Options) WithLimiterTTL(ttl time.Duration) Options
- func (opts Options) WithMaxBatchSize(maxBatchSize int) Options
- func (opts Options) WithMaxGatewayCount(maxGatewayCount int) Options
- func (opts Options) WithMaxPageSize(maxPageSize int) Options
- func (opts Options) WithNetwork(network multichain.Network) Options
- func (opts Options) WithPort(port string) Options
- func (opts Options) WithServerTimeout(serverTimeout time.Duration) Options
- func (opts Options) WithTTL(ttl time.Duration) Options
- func (opts Options) WithTransactionExpiry(transactionExpiry time.Duration) Options
- func (opts Options) WithUpdaterPollRate(updaterPollRate time.Duration) Options
- func (opts Options) WithWatcherConfidenceInterval(watcherConfidenceInterval uint64) Options
- func (opts Options) WithWatcherMaxBlockAdvance(watcherMaxBlockAdvance uint64) Options
- func (opts Options) WithWatcherPollRate(watcherPollRate time.Duration) Options
- func (opts Options) WithWhitelist(whitelist []tx.Selector) Options
Constants ¶
This section is empty.
Variables ¶
var ( DefaultPort = "5000" DefaultCap = 128 DefaultMaxBatchSize = 10 DefaultMaxPageSize = 10 DefaultMaxGatewayCount = 10000 DefaultServerTimeout = 15 * time.Second DefaultClientTimeout = 15 * time.Second DefaultTTL = 3 * time.Second DefaultUpdaterPollRate = 5 * time.Minute DefaultConfirmerPollRate = confirmer.DefaultPollInterval DefaultWatcherPollRate = 15 * time.Second DefaultWatcherMaxBlockAdvance = uint64(1000) DefaultWatcherConfidenceInterval = uint64(6) DefaultTransactionExpiry = confirmer.DefaultExpiry DefaultBootstrapAddrs = []wire.Address{} DefaultLimiterIPRates = map[string]rate.Limit{"fallback": resolver.LimiterDefaultIPRate} DefaultLimiterGlobalRates = map[string]rate.Limit{"fallback": resolver.LimiterDefaultGlobalRate} DefaultLimiterTTL = resolver.LimiterDefaultTTL DefaultLimiterMaxClients = resolver.LimiterDefaultMaxClients )
Enumerate default options.
Functions ¶
This section is empty.
Types ¶
type Lightnode ¶
type Lightnode struct {
// contains filtered or unexported fields
}
Lightnode is the top level container that encapsulates the functionality of the lightnode.
type Options ¶
type Options struct {
Network multichain.Network
DistPubKey *id.PubKey
Port string
Cap int
MaxBatchSize int
MaxPageSize int
MaxGatewayCount int
ServerTimeout time.Duration
ClientTimeout time.Duration
TTL time.Duration
UpdaterPollRate time.Duration
ConfirmerPollRate time.Duration
WatcherPollRate time.Duration
WatcherMaxBlockAdvance uint64
WatcherConfidenceInterval uint64
TransactionExpiry time.Duration
BootstrapAddrs []wire.Address
Chains map[multichain.Chain]binding.ChainOptions
Whitelist []tx.Selector
LimiterGlobalRates map[string]rate.Limit
LimiterIPRates map[string]rate.Limit
LimiterTTL time.Duration
LimiterMaxClients int
}
Options to configure the precise behaviour of the Lightnode.
func DefaultOptions ¶
func DefaultOptions() Options
DefaultOptions returns new options with default configurations that should work for the majority of use cases.
func (Options) WithBootstrapAddrs ¶
WithBootstrapAddrs makes an initial list of nodes known to the node. These nodes will be used to bootstrap into the P2P network.
func (Options) WithChains ¶
func (opts Options) WithChains(chains map[multichain.Chain]binding.ChainOptions) Options
WithChains is used to specify the chain options for a the supported chains.
func (Options) WithClientTimeout ¶
WithClientTimeout updates the client timeout.
func (Options) WithConfirmerPollRate ¶
WithConfirmerPollRate updates the confirmer poll rate.
func (Options) WithDistPubKey ¶
WithDistPubKey updates the distributed public key.
func (Options) WithLimiterGlobalRates ¶
WithLimiterGlobalRate is used to set global rate limits for specific methods
func (Options) WithLimiterIPRates ¶
WithLimiterIpRate is used to set per-ip rate limits for specific methods
func (Options) WithLimiterMaxClients ¶
WithLimiterMaxClients used to whitelist certain selectors inside the Darknode.
func (Options) WithLimiterTTL ¶
WithLimiterTTL used to whitelist certain selectors inside the Darknode.
func (Options) WithMaxBatchSize ¶
WithMaxBatchSize updates the maximum batch size when submitting requests.
func (Options) WithMaxGatewayCount ¶
WithMaxGatewayCount is used to set the max number of gateways that can be persisted
func (Options) WithMaxPageSize ¶
WithMaxPageSize updates the maximum page size when querying transactions.
func (Options) WithNetwork ¶
func (opts Options) WithNetwork(network multichain.Network) Options
WithNetwork updates the network.
func (Options) WithServerTimeout ¶
WithServerTimeout updates the server timeout.
func (Options) WithTransactionExpiry ¶
WithTransactionExpiry updates the transaction expiry.
func (Options) WithUpdaterPollRate ¶
WithUpdaterPollRate updates the updater poll rate.
func (Options) WithWatcherConfidenceInterval ¶
WithWatcherPollRate updates the watcher poll rate.
func (Options) WithWatcherMaxBlockAdvance ¶
WithWatcherPollRate updates the watcher poll rate.
func (Options) WithWatcherPollRate ¶
WithWatcherPollRate updates the watcher poll rate.
Source Files
Directories