Documentation ¶
Overview ¶
Package chainstate is the on-chain data service abstraction layer
Index ¶
- Constants
- Variables
- type AddFilterMessage
- type AgentClient
- func (a *AgentClient) AddFilter(regex, item string) (centrifuge.PublishResult, error)
- func (a *AgentClient) Connect() error
- func (a *AgentClient) Disconnect() error
- func (a *AgentClient) SetFilter(regex string, bloomFilter *BloomProcessorFilter) (centrifuge.PublishResult, error)
- func (a *AgentClient) SetToken(token string)
- type BloomProcessor
- func (p *BloomProcessor) Add(regexString, item string) error
- func (p *BloomProcessor) Debug(debug bool)
- func (p *BloomProcessor) FilterTransaction(txHex string) (string, error)
- func (p *BloomProcessor) FilterTransactionPublishEvent(eData []byte) (string, error)
- func (p *BloomProcessor) GetFilters() map[string]*BloomProcessorFilter
- func (p *BloomProcessor) GetHash() string
- func (p *BloomProcessor) IsDebug() bool
- func (p *BloomProcessor) Logger() Logger
- func (p *BloomProcessor) Reload(regexString string, items []string) (err error)
- func (p *BloomProcessor) SetFilter(regex string, filter []byte) error
- func (p *BloomProcessor) SetLogger(logger Logger)
- func (p *BloomProcessor) Test(regexString, item string) bool
- type BloomProcessorFilter
- type ChainService
- type Client
- func (c *Client) Broadcast(ctx context.Context, id, txHex string, timeout time.Duration) (string, error)
- func (c *Client) BroadcastMiners() []*Miner
- func (c *Client) Close(ctx context.Context)
- func (c *Client) Debug(on bool)
- func (c *Client) DebugLog(text string)
- func (c *Client) HTTPClient() HTTPInterface
- func (c *Client) IsDebug() bool
- func (c *Client) IsNewRelicEnabled() bool
- func (c *Client) Minercraft() minercraft.ClientInterface
- func (c *Client) Monitor() MonitorService
- func (c *Client) MonitorBlockHeaders(ctx context.Context) error
- func (c *Client) Network() Network
- func (c *Client) NowNodes() nownodes.ClientInterface
- func (c *Client) QueryMiners() []*Miner
- func (c *Client) QueryTimeout() time.Duration
- func (c *Client) QueryTransaction(ctx context.Context, id string, requiredIn RequiredIn, timeout time.Duration) (*TransactionInfo, error)
- func (c *Client) QueryTransactionFastest(ctx context.Context, id string, requiredIn RequiredIn, timeout time.Duration) (*TransactionInfo, error)
- func (c *Client) RefreshFeeQuotes(ctx context.Context) error
- func (c *Client) WhatsOnChain() whatsonchain.ClientInterface
- type ClientInterface
- type ClientOps
- func WithBroadcastMiners(miners []*Miner) ClientOps
- func WithDebugging() ClientOps
- func WithExcludedProviders(providers []string) ClientOps
- func WithHTTPClient(client HTTPInterface) ClientOps
- func WithLogger(customLogger zLogger.GormLoggerInterface) ClientOps
- func WithMinercraft(client minercraft.ClientInterface) ClientOps
- func WithMonitoring(ctx context.Context, monitorOptions *MonitorOptions) ClientOps
- func WithMonitoringInterface(monitor MonitorService) ClientOps
- func WithNetwork(network Network) ClientOps
- func WithNewRelic() ClientOps
- func WithNowNodes(client nownodes.ClientInterface) ClientOps
- func WithNowNodesAPIKey(apiKey string) ClientOps
- func WithQueryMiners(miners []*Miner) ClientOps
- func WithQueryTimeout(timeout time.Duration) ClientOps
- func WithUserAgent(agent string) ClientOps
- func WithWhatsOnChain(client whatsonchain.ClientInterface) ClientOps
- func WithWhatsOnChainAPIKey(apiKey string) ClientOps
- type HTTPInterface
- type Logger
- type Miner
- type MinercraftServices
- type Monitor
- func (m *Monitor) Add(regexString, item string) error
- func (m *Monitor) AllowUnknownTransactions() bool
- func (m *Monitor) Connected()
- func (m *Monitor) Disconnected()
- func (m *Monitor) GetFalsePositiveRate() float64
- func (m *Monitor) GetLockID() string
- func (m *Monitor) GetMaxNumberOfDestinations() int
- func (m *Monitor) GetMonitorDays() int
- func (m *Monitor) GetProcessMempoolOnConnect() bool
- func (m *Monitor) IsConnected() bool
- func (m *Monitor) IsDebug() bool
- func (m *Monitor) LoadMonitoredDestinations() bool
- func (m *Monitor) Logger() Logger
- func (m *Monitor) ProcessMempool(ctx context.Context) error
- func (m *Monitor) Processor() MonitorProcessor
- func (m *Monitor) SaveDestinations() bool
- func (m *Monitor) SetChainstateOptions(options *clientOptions)
- func (m *Monitor) Start(ctx context.Context, handler MonitorHandler, onStop func()) error
- func (m *Monitor) Stop(ctx context.Context) error
- type MonitorClient
- type MonitorHandler
- type MonitorOptions
- type MonitorProcessor
- type MonitorService
- type Network
- type ProviderServices
- type RegexProcessor
- func (p *RegexProcessor) Add(regex string, _ string) error
- func (p *RegexProcessor) Debug(debug bool)
- func (p *RegexProcessor) FilterTransaction(hex string) (string, error)
- func (p *RegexProcessor) FilterTransactionPublishEvent(eData []byte) (string, error)
- func (p *RegexProcessor) GetFilters() map[string]*BloomProcessorFilter
- func (p *RegexProcessor) GetHash() string
- func (p *RegexProcessor) IsDebug() bool
- func (p *RegexProcessor) Logger() Logger
- func (p *RegexProcessor) Reload(_ string, items []string) (err error)
- func (p *RegexProcessor) SetFilter(_ string, _ []byte) error
- func (p *RegexProcessor) SetLogger(logger Logger)
- func (p *RegexProcessor) Test(_ string, item string) bool
- type RequiredIn
- type SetFilterMessage
- type TransactionInfo
- type TransactionType
- type TxInfo
Constants ¶
const ( // FilterBloom is for bloom filters FilterBloom = "bloom" // FilterRegex is for regex filters FilterRegex = "regex" )
const ( ProviderAll = "all" // All providers (used for errors etc) ProviderMAPI = "mapi" // Query & broadcast provider for mAPI (using given miners) ProviderNowNodes = "nownodes" // Query & broadcast provider for NowNodes ProviderWhatsOnChain = "whatsonchain" // Query & broadcast provider for WhatsOnChain )
List of providers
Variables ¶
var ( // DefaultFee is used when a fee has not been set by the user // This default is currently accepted by all BitcoinSV miners (500/1000) (4.25.22) DefaultFee = &utils.FeeUnit{ Satoshis: 1, Bytes: 2, } )
var ErrInvalidRequirements = errors.New("requirements are invalid or missing")
ErrInvalidRequirements is when an invalid requirement was given
var ErrInvalidTransactionHex = errors.New("invalid transaction hex")
ErrInvalidTransactionHex is when the transaction hex is missing or invalid
var ErrInvalidTransactionID = errors.New("invalid transaction id")
ErrInvalidTransactionID is when the transaction id is missing or invalid
var ErrMissingBroadcastMiners = errors.New("missing: broadcasting miners")
ErrMissingBroadcastMiners is when broadcasting miners are missing
var ErrMissingQueryMiners = errors.New("missing: query miners")
ErrMissingQueryMiners is when query miners are missing
var ErrMonitorNotAvailable = errors.New("monitor processor not available")
ErrMonitorNotAvailable is when the monitor processor is not available
var ErrTransactionIDMismatch = errors.New("result tx id did not match provided tx id")
ErrTransactionIDMismatch is when the returned tx does not match the expected given tx id
var ErrTransactionNotFound = errors.New("transaction not found using all chain providers")
ErrTransactionNotFound is when a transaction was not found in any on-chain provider
Functions ¶
This section is empty.
Types ¶
type AddFilterMessage ¶ added in v0.2.14
type AddFilterMessage struct { Filter string `json:"filter"` Hash string `json:"hash"` Regex string `json:"regex"` Timestamp int64 `json:"timestamp"` }
AddFilterMessage defines a new filter to be published from the client todo Just rely on the agent for this data type
type AgentClient ¶ added in v0.2.14
type AgentClient struct { *centrifuge.Client Token string }
AgentClient implements MonitorClient with needed agent methods
func (*AgentClient) AddFilter ¶ added in v0.2.14
func (a *AgentClient) AddFilter(regex, item string) (centrifuge.PublishResult, error)
AddFilter adds a new filter to the agent
func (*AgentClient) Connect ¶ added in v0.2.14
func (a *AgentClient) Connect() error
Connect establishes connection to agent
func (*AgentClient) Disconnect ¶ added in v0.2.14
func (a *AgentClient) Disconnect() error
Disconnect closes connection to agent
func (*AgentClient) SetFilter ¶ added in v0.2.14
func (a *AgentClient) SetFilter(regex string, bloomFilter *BloomProcessorFilter) (centrifuge.PublishResult, error)
SetFilter (re)sets a filter to the agent
func (*AgentClient) SetToken ¶ added in v0.2.14
func (a *AgentClient) SetToken(token string)
SetToken set the client token
type BloomProcessor ¶ added in v0.2.14
type BloomProcessor struct {
// contains filtered or unexported fields
}
BloomProcessor bloom filter processor
func NewBloomProcessor ¶ added in v0.2.14
func NewBloomProcessor(maxCells uint, falsePositiveRate float64) *BloomProcessor
NewBloomProcessor initialize a new bloom processor
func (*BloomProcessor) Add ¶ added in v0.2.14
func (p *BloomProcessor) Add(regexString, item string) error
Add a new item to the bloom filter
func (*BloomProcessor) Debug ¶ added in v0.2.14
func (p *BloomProcessor) Debug(debug bool)
Debug set debugging
func (*BloomProcessor) FilterTransaction ¶ added in v0.2.14
func (p *BloomProcessor) FilterTransaction(txHex string) (string, error)
FilterTransaction check whether a filter matches a tx event
func (*BloomProcessor) FilterTransactionPublishEvent ¶ added in v0.2.14
func (p *BloomProcessor) FilterTransactionPublishEvent(eData []byte) (string, error)
FilterTransactionPublishEvent check whether a filter matches a tx event
func (*BloomProcessor) GetFilters ¶ added in v0.2.14
func (p *BloomProcessor) GetFilters() map[string]*BloomProcessorFilter
GetFilters get all filters from the bloom processor
func (*BloomProcessor) GetHash ¶ added in v0.2.14
func (p *BloomProcessor) GetHash() string
GetHash get the hash of the current filter
func (*BloomProcessor) IsDebug ¶ added in v0.2.14
func (p *BloomProcessor) IsDebug() bool
IsDebug return whether debugging is on/off
func (*BloomProcessor) Logger ¶ added in v0.2.14
func (p *BloomProcessor) Logger() Logger
Logger return the logger
func (*BloomProcessor) Reload ¶ added in v0.2.14
func (p *BloomProcessor) Reload(regexString string, items []string) (err error)
Reload the bloom filter from the DB
func (*BloomProcessor) SetFilter ¶ added in v0.2.14
func (p *BloomProcessor) SetFilter(regex string, filter []byte) error
SetFilter replace and set a filter
func (*BloomProcessor) SetLogger ¶ added in v0.2.14
func (p *BloomProcessor) SetLogger(logger Logger)
SetLogger set the logger
func (*BloomProcessor) Test ¶ added in v0.2.14
func (p *BloomProcessor) Test(regexString, item string) bool
Test checks whether the item is in the bloom filter
type BloomProcessorFilter ¶ added in v0.2.14
type BloomProcessorFilter struct { Filter *boom.StableBloomFilter // contains filtered or unexported fields }
BloomProcessorFilter struct
type ChainService ¶
type ChainService interface { Broadcast(ctx context.Context, id, txHex string, timeout time.Duration) (string, error) QueryTransaction( ctx context.Context, id string, requiredIn RequiredIn, timeout time.Duration, ) (*TransactionInfo, error) QueryTransactionFastest( ctx context.Context, id string, requiredIn RequiredIn, timeout time.Duration, ) (*TransactionInfo, error) }
ChainService is the chain related methods
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is the client (configuration)
func (*Client) Broadcast ¶
func (c *Client) Broadcast(ctx context.Context, id, txHex string, timeout time.Duration) (string, error)
Broadcast will attempt to broadcast a transaction using the given providers
func (*Client) BroadcastMiners ¶
BroadcastMiners will return the broadcast miners
func (*Client) HTTPClient ¶
func (c *Client) HTTPClient() HTTPInterface
HTTPClient will return the HTTP client
func (*Client) IsNewRelicEnabled ¶
IsNewRelicEnabled will return if new relic is enabled
func (*Client) Minercraft ¶
func (c *Client) Minercraft() minercraft.ClientInterface
Minercraft will return the Minercraft client
func (*Client) Monitor ¶ added in v0.2.14
func (c *Client) Monitor() MonitorService
Monitor will return the Monitor client
func (*Client) MonitorBlockHeaders ¶ added in v0.2.14
MonitorBlockHeaders will start up a block headers monitor
func (*Client) NowNodes ¶
func (c *Client) NowNodes() nownodes.ClientInterface
NowNodes will return the NowNodes client
func (*Client) QueryMiners ¶
QueryMiners will return the query miners
func (*Client) QueryTimeout ¶
QueryTimeout will return the query timeout
func (*Client) QueryTransaction ¶
func (c *Client) QueryTransaction( ctx context.Context, id string, requiredIn RequiredIn, timeout time.Duration, ) (*TransactionInfo, error)
QueryTransaction will get the transaction info from all providers returning the "first" valid result
Note: this is slow, but follows a specific order: mAPI -> WhatsOnChain -> NowNodes
func (*Client) QueryTransactionFastest ¶
func (c *Client) QueryTransactionFastest( ctx context.Context, id string, requiredIn RequiredIn, timeout time.Duration, ) (*TransactionInfo, error)
QueryTransactionFastest will get the transaction info from ALL provider(s) returning the "fastest" valid result
Note: this is fast but could abuse each provider based on how excessive this method is used
func (*Client) RefreshFeeQuotes ¶ added in v0.2.14
RefreshFeeQuotes will update all fee quotes for all broadcasting miners in mAPI
func (*Client) WhatsOnChain ¶
func (c *Client) WhatsOnChain() whatsonchain.ClientInterface
WhatsOnChain will return the WhatsOnChain client
type ClientInterface ¶
type ClientInterface interface { ChainService ProviderServices MinercraftServices Close(ctx context.Context) Debug(on bool) DebugLog(text string) HTTPClient() HTTPInterface IsDebug() bool IsNewRelicEnabled() bool Monitor() MonitorService Network() Network QueryTimeout() time.Duration }
ClientInterface is the chainstate client interface
type ClientOps ¶
type ClientOps func(c *clientOptions)
ClientOps allow functional options to be supplied that overwrite default client options.
func WithBroadcastMiners ¶
WithBroadcastMiners will set a list of miners for broadcasting
func WithExcludedProviders ¶ added in v0.2.21
WithExcludedProviders will set a list of excluded providers
func WithHTTPClient ¶
func WithHTTPClient(client HTTPInterface) ClientOps
WithHTTPClient will set a custom HTTP client
func WithLogger ¶
func WithLogger(customLogger zLogger.GormLoggerInterface) ClientOps
WithLogger will set a custom logger
func WithMinercraft ¶
func WithMinercraft(client minercraft.ClientInterface) ClientOps
WithMinercraft will set a custom Minercraft client
func WithMonitoring ¶ added in v0.2.14
func WithMonitoring(ctx context.Context, monitorOptions *MonitorOptions) ClientOps
WithMonitoring will create a new monitorConfig interface with the given options
func WithMonitoringInterface ¶ added in v0.2.14
func WithMonitoringInterface(monitor MonitorService) ClientOps
WithMonitoringInterface will set the interface to use for monitoring the blockchain
func WithNetwork ¶
WithNetwork will set the network to use
func WithNowNodes ¶
func WithNowNodes(client nownodes.ClientInterface) ClientOps
WithNowNodes will set a custom NowNodes client
func WithNowNodesAPIKey ¶
WithNowNodesAPIKey will set a custom NowNodes API key
func WithQueryMiners ¶
WithQueryMiners will set a list of miners for querying transactions
func WithQueryTimeout ¶
WithQueryTimeout will set a different timeout for transaction querying
func WithUserAgent ¶ added in v0.2.14
WithUserAgent will set the custom user agent
func WithWhatsOnChain ¶
func WithWhatsOnChain(client whatsonchain.ClientInterface) ClientOps
WithWhatsOnChain will set a custom WhatsOnChain client
func WithWhatsOnChainAPIKey ¶ added in v0.1.1
WithWhatsOnChainAPIKey will set a custom WhatsOnChain API key
type HTTPInterface ¶
HTTPInterface is the HTTP client interface
type Logger ¶
type Logger interface { Info(ctx context.Context, message string, params ...interface{}) Error(ctx context.Context, message string, params ...interface{}) }
Logger is the logger interface for debug messages
type Miner ¶ added in v0.2.14
type Miner struct { FeeLastChecked time.Time `json:"fee_last_checked"` // Last time the fee was checked via mAPI FeeUnit *utils.FeeUnit `json:"fee_unit"` // The fee unit returned from Policy request Miner *minercraft.Miner `json:"miner"` // The minercraft miner }
Miner is the internal chainstate miner (wraps Minercraft miner with more information)
type MinercraftServices ¶ added in v0.2.14
type MinercraftServices interface { BroadcastMiners() []*Miner QueryMiners() []*Miner RefreshFeeQuotes(ctx context.Context) error }
MinercraftServices is the minercraft services interface
type Monitor ¶ added in v0.2.14
type Monitor struct {
// contains filtered or unexported fields
}
Monitor starts a new monitorConfig to monitor and filter transactions from a source
Internal struct with all options being private
func NewMonitor ¶ added in v0.2.14
func NewMonitor(_ context.Context, options *MonitorOptions) (monitor *Monitor)
NewMonitor starts a new monitorConfig and loads all addresses that need to be monitored into the bloom filter
func (*Monitor) AllowUnknownTransactions ¶ added in v0.4.9
AllowUnknownTransactions gets whether we allow recording transactions with no relation to our xpubs
func (*Monitor) Connected ¶ added in v0.2.14
func (m *Monitor) Connected()
Connected sets the connected state to true
func (*Monitor) Disconnected ¶ added in v0.2.14
func (m *Monitor) Disconnected()
Disconnected sets the connected state to false
func (*Monitor) GetFalsePositiveRate ¶ added in v0.2.14
GetFalsePositiveRate gets the falsePositiveRate option
func (*Monitor) GetMaxNumberOfDestinations ¶ added in v0.2.14
GetMaxNumberOfDestinations gets the monitorDays option
func (*Monitor) GetMonitorDays ¶ added in v0.2.14
GetMonitorDays gets the monitorDays option
func (*Monitor) GetProcessMempoolOnConnect ¶ added in v0.2.14
GetProcessMempoolOnConnect gets whether the whole mempool should be processed when connecting
func (*Monitor) IsConnected ¶ added in v0.2.14
IsConnected returns whether we are connected to the socket
func (*Monitor) LoadMonitoredDestinations ¶ added in v0.2.14
LoadMonitoredDestinations gets where we want to add the monitored destinations from the database into the processor
func (*Monitor) ProcessMempool ¶ added in v0.2.14
ProcessMempool processes all current transactions in the mempool
func (*Monitor) Processor ¶ added in v0.2.14
func (m *Monitor) Processor() MonitorProcessor
Processor gets the monitor processor
func (*Monitor) SaveDestinations ¶ added in v0.2.14
SaveDestinations gets whether we should save destinations from transactions that pass monitor filter
func (*Monitor) SetChainstateOptions ¶ added in v0.2.14
func (m *Monitor) SetChainstateOptions(options *clientOptions)
SetChainstateOptions sets the chainstate options on the monitor to allow more syncing capabilities
type MonitorClient ¶ added in v0.2.14
type MonitorClient interface { AddFilter(regex, item string) (centrifuge.PublishResult, error) Connect() error Disconnect() error SetToken(token string) }
MonitorClient interface
type MonitorHandler ¶ added in v0.2.14
type MonitorHandler interface { whatsonchain.SocketHandler GetWhatsOnChain() whatsonchain.ClientInterface RecordBlockHeader(ctx context.Context, bh bc.BlockHeader) error RecordTransaction(ctx context.Context, txHex string) error SetMonitor(monitor *Monitor) }
MonitorHandler interface
type MonitorOptions ¶ added in v0.2.14
type MonitorOptions struct { AuthToken string `json:"token"` BuxAgentURL string `json:"bux_agent_url"` Debug bool `json:"debug"` FalsePositiveRate float64 `json:"false_positive_rate"` LoadMonitoredDestinations bool `json:"load_monitored_destinations"` LockID string `json:"lock_id"` MaxNumberOfDestinations int `json:"max_number_of_destinations"` MonitorDays int `json:"monitor_days"` ProcessMempoolOnConnect bool `json:"process_mempool_on_connect"` ProcessorType string `json:"processor_type"` SaveTransactionDestinations bool `json:"save_transaction_destinations"` AllowUnknownTransactions bool `json:"allow_unknown_transactions"` // whether to allow transactions that do not have an xpub_in_id or xpub_out_id }
MonitorOptions options for starting this monitorConfig
type MonitorProcessor ¶ added in v0.2.14
type MonitorProcessor interface { Add(regexString, item string) error Debug(bool) FilterTransaction(txHex string) (string, error) FilterTransactionPublishEvent(eData []byte) (string, error) GetFilters() map[string]*BloomProcessorFilter GetHash() string IsDebug() bool Logger() Logger Reload(regexString string, items []string) error SetFilter(regex string, filter []byte) error SetLogger(logger Logger) Test(regexString string, item string) bool }
MonitorProcessor struct that defines interface to all filter processors
type MonitorService ¶ added in v0.2.14
type MonitorService interface { Add(regexpString string, item string) error Connected() Disconnected() GetFalsePositiveRate() float64 GetLockID() string GetMaxNumberOfDestinations() int GetMonitorDays() int GetProcessMempoolOnConnect() bool IsConnected() bool IsDebug() bool LoadMonitoredDestinations() bool AllowUnknownTransactions() bool Logger() Logger ProcessMempool(ctx context.Context) error Processor() MonitorProcessor SaveDestinations() bool Start(ctx context.Context, handler MonitorHandler, onStop func()) error Stop(ctx context.Context) error }
MonitorService for the monitoring
type Network ¶
type Network string
Network is the supported Bitcoin networks
const ( MainNet Network = mainNet // Main public network StressTestNet Network = stn // Stress Test Network (https://bitcoinscaling.io/) TestNet Network = testNet // Test public network )
Supported networks
func (Network) WhatsOnChain ¶
func (n Network) WhatsOnChain() whatsonchain.NetworkType
WhatsOnChain will return the WhatsOnChain network type
type ProviderServices ¶
type ProviderServices interface { Minercraft() minercraft.ClientInterface NowNodes() nownodes.ClientInterface WhatsOnChain() whatsonchain.ClientInterface }
ProviderServices is the chainstate providers interface
type RegexProcessor ¶ added in v0.2.14
type RegexProcessor struct {
// contains filtered or unexported fields
}
RegexProcessor simple regex processor This processor just uses regex checks to see if a raw hex string exists in a tx This is bound to have some false positives but is somewhat performant when filter set is small
func NewRegexProcessor ¶ added in v0.2.14
func NewRegexProcessor() *RegexProcessor
NewRegexProcessor initialize a new regex processor
func (*RegexProcessor) Add ¶ added in v0.2.14
func (p *RegexProcessor) Add(regex string, _ string) error
Add a new item to the processor
func (*RegexProcessor) Debug ¶ added in v0.2.14
func (p *RegexProcessor) Debug(debug bool)
Debug set debugging
func (*RegexProcessor) FilterTransaction ¶ added in v0.2.14
func (p *RegexProcessor) FilterTransaction(hex string) (string, error)
FilterTransaction filters transaction
func (*RegexProcessor) FilterTransactionPublishEvent ¶ added in v0.2.14
func (p *RegexProcessor) FilterTransactionPublishEvent(eData []byte) (string, error)
FilterTransactionPublishEvent check whether a filter matches a tx event
func (*RegexProcessor) GetFilters ¶ added in v0.2.14
func (p *RegexProcessor) GetFilters() map[string]*BloomProcessorFilter
GetFilters get all filters from the bloom processor
func (*RegexProcessor) GetHash ¶ added in v0.2.14
func (p *RegexProcessor) GetHash() string
GetHash get the hash of the filter
func (*RegexProcessor) IsDebug ¶ added in v0.2.14
func (p *RegexProcessor) IsDebug() bool
IsDebug return whether debugging is on/off
func (*RegexProcessor) Logger ¶ added in v0.2.14
func (p *RegexProcessor) Logger() Logger
Logger return the logger
func (*RegexProcessor) Reload ¶ added in v0.2.14
func (p *RegexProcessor) Reload(_ string, items []string) (err error)
Reload the items of the processor to match against
func (*RegexProcessor) SetFilter ¶ added in v0.2.14
func (p *RegexProcessor) SetFilter(_ string, _ []byte) error
SetFilter replace and set a filter
func (*RegexProcessor) SetLogger ¶ added in v0.2.14
func (p *RegexProcessor) SetLogger(logger Logger)
SetLogger set the logger
type RequiredIn ¶
type RequiredIn string
RequiredIn is the requirements for querying transaction information
const ( // RequiredInMempool is the transaction in mempool? (minimum requirement for a valid response) RequiredInMempool RequiredIn = requiredInMempool // RequiredOnChain is the transaction in on-chain? (minimum requirement for a valid response) RequiredOnChain RequiredIn = requiredOnChain )
type SetFilterMessage ¶ added in v0.2.14
type SetFilterMessage struct { Filter []byte `json:"filter"` Hash string `json:"hash"` Regex string `json:"regex"` Timestamp int64 `json:"timestamp"` }
SetFilterMessage defines a new filter message with a list of filters
type TransactionInfo ¶
type TransactionInfo struct { BlockHash string `json:"block_hash,omitempty"` // mAPI, WOC BlockHeight int64 `json:"block_height"` // mAPI, WOC Confirmations int64 `json:"confirmations,omitempty"` // mAPI, WOC ID string `json:"id"` // Transaction ID (Hex) MinerID string `json:"miner_id,omitempty"` // mAPI ONLY - miner_id found Provider string `json:"provider,omitempty"` // Provider is our internal source }
TransactionInfo is the universal information about the transaction found from a chain provider
type TransactionType ¶ added in v0.2.14
type TransactionType string
TransactionType tx types
const Metanet TransactionType = "metanet"
Metanet type
const PlanariaB TransactionType = "planaria-b"
PlanariaB type
const PlanariaD TransactionType = "planaria-d"
PlanariaD type
const PubKeyHash TransactionType = "pubkeyhash"
PubKeyHash type
const RareCandyFrogCartel TransactionType = "rarecandy-frogcartel"
RareCandyFrogCartel type