Documentation ¶
Index ¶
- func UseLogger(logger slog.Logger)
- type BadRequestError
- type Client
- func (c *Client) FeePercentage(ctx context.Context) (float64, error)
- func (c *Client) ForUnspentUnexpiredTickets(ctx context.Context, f func(hash *chainhash.Hash) error) error
- func (c *Client) Process(ctx context.Context, ticketHash *chainhash.Hash, feeTx *wire.MsgTx) error
- func (c *Client) ProcessManagedTickets(ctx context.Context, policy Policy) error
- func (c *Client) ProcessUnprocessedTickets(ctx context.Context, policy Policy)
- func (c *Client) ProcessWithPolicy(ctx context.Context, ticketHash *chainhash.Hash, feeTx *wire.MsgTx, ...) error
- type Config
- type DialFunc
- type Policy
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type BadRequestError ¶
type BadRequestError struct { HTTPStatus int `json:"-"` Code int `json:"code"` Message string `json:"message"` }
func (*BadRequestError) Error ¶
func (e *BadRequestError) Error() string
type Client ¶
type Client struct { Wallet *wallet.Wallet Policy Policy // contains filtered or unexported fields }
func (*Client) ForUnspentUnexpiredTickets ¶
func (c *Client) ForUnspentUnexpiredTickets(ctx context.Context, f func(hash *chainhash.Hash) error) error
ForUnspentUnexpiredTickets performs a function on every unexpired and unspent ticket from the wallet.
func (*Client) Process ¶
Process begins processing a VSP fee payment for a ticket. If feeTx contains inputs, is used to pay the VSP fee. Otherwise, new inputs are selected and locked to prevent double spending the fee.
feeTx must not be nil, but may point to an empty transaction, and is modified with the inputs and the fee and change outputs before returning without an error. The fee transaction is also recorded as unpublised in the wallet, and the fee hash is associated with the ticket.
func (*Client) ProcessManagedTickets ¶
ProcessManagedTickets discovers tickets which were previously registered with a VSP and begins syncing them in the background. This is used to recover VSP tracking after seed restores, and is only performed on unspent and unexpired tickets.
func (*Client) ProcessUnprocessedTickets ¶
ProcessUnprocessedTickets ...
type Config ¶
type Config struct { // URL specifies the base URL of the VSP URL string // PubKey specifies the VSP's base64 encoded public key PubKey string // Dialer specifies an optional dialer when connecting to the VSP. Dialer DialFunc // Wallet specifies a loaded wallet. Wallet *wallet.Wallet // Default policy for fee payments unless another is provided by the // caller. Policy Policy }