Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

minercraft

package module

Go to main page

Versions in this module

v2

v2.1.0

May 3, 2024

v2.0.8

Nov 21, 2023

v2.0.7

Nov 8, 2023

v2.0.6

Oct 25, 2023

v2.0.5

Sep 20, 2023

v2.0.4

Sep 8, 2023

v2.0.3

Aug 3, 2023

v2.0.2

Jul 24, 2023

v2.0.1

Jun 30, 2023

Changes in this version

+ const KnownMinersAPIsAll

+ const KnownMinersAll

v2.0.0

Jun 12, 2023

Changes in this version

+ const KnownMiners

+ const KnownMinersAPIs

+ const MerkleFormatTSC

+ const MinerGorillaPool

+ const MinerMatterpool

+ const MinerMempool

+ const MinerTaal

+ const QueryTransactionFailure

+ const QueryTransactionInMempoolFailure

+ const QueryTransactionSuccess

+ var Routes = []APIRoute

+ func ActionRouteByAPIType(actionName APIActionName, apiType APIType) (string, error)

+ func IsRetryable(err error) bool

+ type API struct

+ Token string

+ Type APIType

+ URL string

+ type APIActionName string

+ const FeeQuote

+ const PolicyQuote

+ const QueryTx

+ const SubmitTx

+ const SubmitTxs

+ type APINotFoundError struct

+ APIType APIType

+ MinerID string

+ func (e *APINotFoundError) Error() string

+ type APIRoute struct

+ Name APIActionName

+ Routes []APISpecificRoute

+ type APISpecificRoute struct

+ APIType APIType

+ Route string

+ type APIType string

+ const Arc

+ const MAPI

+ type ActionRouteNotFoundError struct

+ APIType APIType

+ ActionName APIActionName

+ func (e *ActionRouteNotFoundError) Error() string

+ type Client struct

+ Options *ClientOptions

+ func (c *Client) APIType() APIType

+ func (c *Client) AddMiner(miner Miner, apis []API) error

+ func (c *Client) BestQuote(ctx context.Context, feeCategory, feeType string) (*FeeQuoteResponse, error)

+ func (c *Client) FastestQuote(ctx context.Context, timeout time.Duration) (*FeeQuoteResponse, error)

+ func (c *Client) FeeQuote(ctx context.Context, miner *Miner) (*FeeQuoteResponse, error)

+ func (c *Client) MinerAPIByMinerID(minerID string, apiType APIType) (*API, error)

+ func (c *Client) MinerAPIsByMinerID(minerID string) *MinerAPIs

+ func (c *Client) MinerByID(minerID string) *Miner

+ func (c *Client) MinerByName(name string) *Miner

+ func (c *Client) MinerUpdateToken(name, token string, apiType APIType)

+ func (c *Client) Miners() []*Miner

+ func (c *Client) PolicyQuote(ctx context.Context, miner *Miner) (*PolicyQuoteResponse, error)

+ func (c *Client) QueryTransaction(ctx context.Context, miner *Miner, txID string, ...) (*QueryTransactionResponse, error)

+ func (c *Client) RemoveMiner(miner *Miner) bool

+ func (c *Client) SubmitTransaction(ctx context.Context, miner *Miner, tx *Transaction) (*SubmitTransactionResponse, error)

+ func (c *Client) SubmitTransactions(ctx context.Context, miner *Miner, txs []Transaction) (*SubmitTransactionsResponse, error)

+ func (c *Client) UserAgent() string

+ type ClientInterface interface

+ APIType func() APIType

+ UserAgent func() string

+ func NewClient(clientOptions *ClientOptions, customHTTPClient HTTPInterface, apiType APIType, ...) (client ClientInterface, err error)

+ type ClientOptions struct

+ BackOffExponentFactor float64

+ BackOffInitialTimeout time.Duration

+ BackOffMaxTimeout time.Duration

+ BackOffMaximumJitterInterval time.Duration

+ DialerKeepAlive time.Duration

+ DialerTimeout time.Duration

+ RequestRetryCount int

+ RequestTimeout time.Duration

+ TransportExpectContinueTimeout time.Duration

+ TransportIdleTimeout time.Duration

+ TransportMaxIdleConnections int

+ TransportTLSHandshakeTimeout time.Duration

+ UserAgent string

+ func DefaultClientOptions() (clientOptions *ClientOptions)

+ type ErrRetryable struct

+ func (e ErrRetryable) As(target interface{}) bool

+ func (e ErrRetryable) Error() string

+ func (e ErrRetryable) Is(err error) bool

+ func (e ErrRetryable) IsRetryable()

+ type ErrorResponse struct

+ Detail string

+ Errors map[string][]string

+ Status int

+ Title string

+ TraceID string

+ Type string

+ func (e ErrorResponse) Error() string

+ type FeeQuoteResponse struct

+ Quote *mapi.FeePayload

+ type HTTPInterface interface

+ Do func(req *http.Request) (*http.Response, error)

+ type JSONEnvelope struct

+ APIType APIType

+ Miner *Miner

+ Validated bool

+ type Miner struct

+ MinerID string

+ Name string

+ func DefaultMiners() (miners []*Miner, err error)

+ func MinerByID(miners []*Miner, minerID string) *Miner

+ func MinerByName(miners []*Miner, minerName string) *Miner

+ type MinerAPIs struct

+ APIs []API

+ MinerID string

+ func DefaultMinersAPIs() (minerAPIs []*MinerAPIs, err error)

+ type MinerService interface

+ AddMiner func(miner Miner, apis []API) error

+ MinerAPIByMinerID func(minerID string, apiType APIType) (*API, error)

+ MinerAPIsByMinerID func(minerID string) *MinerAPIs

+ MinerByID func(minerID string) *Miner

+ MinerByName func(name string) *Miner

+ MinerUpdateToken func(name, token string, apiType APIType)

+ Miners func() []*Miner

+ RemoveMiner func(miner *Miner) bool

+ type PolicyPayload struct

+ Callbacks []*mapi.PolicyCallback

+ Policies *UnifiedPolicy

+ type PolicyQuoteArcAdapter struct

+ func (a *PolicyQuoteArcAdapter) GetPolicyData() *PolicyPayload

+ type PolicyQuoteMapiAdapter struct

+ func (a *PolicyQuoteMapiAdapter) GetPolicyData() *PolicyPayload

+ type PolicyQuoteModelAdapter interface

+ GetPolicyData func() *PolicyPayload

+ type PolicyQuoteResponse struct

+ Quote *PolicyPayload

+ type QueryTransactionOptFunc func(o *queryTransactionOpts)

+ func WithQueryMerkleFormat(s string) QueryTransactionOptFunc

+ func WithQueryMerkleProof() QueryTransactionOptFunc

+ func WithQueryTSCMerkleFormat() QueryTransactionOptFunc

+ func WithoutQueryMerkleProof() QueryTransactionOptFunc

+ type QueryTransactionResponse struct

+ Query *QueryTxResponse

+ type QueryTxArcAdapter struct

+ func (m *QueryTxArcAdapter) GetQueryTxResponse() *QueryTxResponse

+ type QueryTxMapiAdapter struct

+ func (m *QueryTxMapiAdapter) GetQueryTxResponse() *QueryTxResponse

+ type QueryTxModelAdapter interface

+ GetQueryTxResponse func() *QueryTxResponse

+ type QueryTxResponse struct

+ APIVersion string

+ BlockHash string

+ BlockHeight int64

+ Confirmations int64

+ MerkleProof *bc.MerkleProof

+ MinerID string

+ ResultDescription string

+ ReturnResult string

+ Timestamp string

+ TxID string

+ TxSecondMempoolExpiry int64

+ TxStatus arc.TxStatus

+ type QuoteService interface

+ BestQuote func(ctx context.Context, feeCategory, feeType string) (*FeeQuoteResponse, error)

+ FastestQuote func(ctx context.Context, timeout time.Duration) (*FeeQuoteResponse, error)

+ FeeQuote func(ctx context.Context, miner *Miner) (*FeeQuoteResponse, error)

+ PolicyQuote func(ctx context.Context, miner *Miner) (*PolicyQuoteResponse, error)

+ type RawSubmitTransactionsResponse struct

+ Encoding string

+ MimeType string

+ Payload string

+ PublicKey string

+ Signature string

+ type RequestResponse struct

+ BodyContents []byte

+ Error error

+ Method string

+ PostData string

+ StatusCode int

+ URL string

+ type Retryable interface

+ IsRetryable func()

+ type SubmitTransactionResponse struct

+ Results *UnifiedSubmissionPayload

+ type SubmitTransactionsResponse struct

+ Encoding string

+ MimeType string

+ Payload UnifiedTxsPayload

+ PublicKey string

+ Signature string

+ type SubmitTxArcAdapter struct

+ func (a *SubmitTxArcAdapter) GetSubmitTxResponse() *UnifiedSubmissionPayload

+ type SubmitTxMapiAdapter struct

+ func (a *SubmitTxMapiAdapter) GetSubmitTxResponse() *UnifiedSubmissionPayload

+ type SubmitTxModelAdapter interface

+ GetSubmitTxResponse func() *UnifiedSubmissionPayload

+ type Transaction struct

+ CallBackEncryption string

+ CallBackToken string

+ CallBackURL string

+ DsCheck bool

+ MerkleFormat string

+ MerkleProof bool

+ RawTx string

+ WaitForStatus arc.TxStatus

+ type TransactionService interface

+ QueryTransaction func(ctx context.Context, miner *Miner, txID string, ...) (*QueryTransactionResponse, error)

+ SubmitTransaction func(ctx context.Context, miner *Miner, tx *Transaction) (*SubmitTransactionResponse, error)

+ SubmitTransactions func(ctx context.Context, miner *Miner, txs []Transaction) (*SubmitTransactionsResponse, error)

+ type UnifiedFeePayload struct

+ Fees []*bt.Fee

+ type UnifiedPolicy struct

+ AcceptNonStdConsolidationInput bool

+ AcceptNonStdOutputs bool

+ DataCarrier bool

+ DataCarrierSize uint32

+ LimitAncestorCount uint32

+ LimitCpfpGroupMembersCount uint32

+ MaxConsolidationFactor uint32

+ MaxConsolidationInputScriptSize uint32

+ MaxNonStdTxValidationDuration uint32

+ MaxScriptNumLengthPolicy uint32

+ MaxScriptSizePolicy uint32

+ MaxStackMemoryUsagePolicy uint64

+ MaxStdTxValidationDuration uint32

+ MaxTxSigOpsCount uint32

+ MaxTxSizePolicy uint32

+ MinConfConsolidationInput uint32

+ SkipScriptFlags []mapi.ScriptFlag

+ type UnifiedSubmissionPayload struct

+ APIVersion string

+ BlockHash string

+ BlockHeight int64

+ ConflictedWith []*mapi.ConflictedWith

+ CurrentHighestBlockHash string

+ CurrentHighestBlockHeight int64

+ ExtraInfo string

+ FailureRetryable bool

+ MinerID string

+ ResultDescription string

+ ReturnResult string

+ Status int

+ Timestamp string

+ Title string

+ TxID string

+ TxSecondMempoolExpiry int64

+ TxStatus arc.TxStatus

+ type UnifiedTx struct

+ BlockHash string

+ BlockHeight int64

+ ConflictedWith []mapi.ConflictedWith

+ ExtraInfo string

+ FailureRetryable bool

+ ResultDescription string

+ ReturnResult string

+ Status int

+ Timestamp time.Time

+ Title string

+ TxID string

+ TxStatus arc.TxStatus

+ type UnifiedTxsPayload struct

+ APIVersion string

+ CurrentHighestBlockHash string

+ CurrentHighestBlockHeight int

+ FailureCount int

+ MinerID string

+ Timestamp time.Time

+ TxSecondMempoolExpiry int

+ Txs []UnifiedTx

Other modules containing this package

github.com/tonicpow/go-minercraft