vsp

Documentation

Index

• func UseLogger(logger slog.Logger)
• type Client
  • func New(cfg Config) (*Client, error)
  • func (c *Client) FeePercentage(ctx context.Context) (float64, error)
  • func (c *Client) Process(ctx context.Context, ticketHash *chainhash.Hash, feeTx *wire.MsgTx) error
  • func (c *Client) ProcessManagedTickets(ctx context.Context) error
  • func (c *Client) ProcessTicket(ctx context.Context, hash *chainhash.Hash) error
  • func (c *Client) ProcessUnprocessedTickets(ctx context.Context)
  • func (c *Client) SetVoteChoice(ctx context.Context, hash *chainhash.Hash, choices map[string]string, ...) error
  • func (c *Client) TrackedTickets() []*TicketInfo
• type Config
• type DialFunc
• type Policy
• type TicketInfo

Functions

func UseLogger

func UseLogger(logger slog.Logger)

UseLogger uses a specified Logger to output package logging info. This should be used in preference to SetLogWriter if the caller is also using slog.

Types

type Client

type Client struct {
	*vspd.Client
	// contains filtered or unexported fields
}

func New

func New(cfg Config) (*Client, error)

func (*Client) FeePercentage

func (c *Client) FeePercentage(ctx context.Context) (float64, error)

func (*Client) Process

func (c *Client) Process(ctx context.Context, ticketHash *chainhash.Hash, feeTx *wire.MsgTx) error

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

func (c *Client) ProcessManagedTickets(ctx context.Context) error

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) ProcessTicket

func (c *Client) ProcessTicket(ctx context.Context, hash *chainhash.Hash) error

ProcessTicket attempts to process a given ticket based on the hash provided.

func (*Client) ProcessUnprocessedTickets

func (c *Client) ProcessUnprocessedTickets(ctx context.Context)

ProcessUnprocessedTickets processes all tickets that don't currently have any association with a VSP.

func (*Client) SetVoteChoice

func (c *Client) SetVoteChoice(ctx context.Context, hash *chainhash.Hash,
	choices map[string]string, tspendPolicy map[string]string, treasuryPolicy map[string]string) error

SetVoteChoice takes the provided consensus, tspend and treasury key voting preferences, and checks if they match the status of the specified ticket from the connected VSP. The status provides the current voting preferences so we can just update from there if need be.

func (*Client) TrackedTickets

func (c *Client) TrackedTickets() []*TicketInfo

TrackedTickets returns information about all outstanding tickets tracked by a vsp.Client instance.

Currently this returns only info about tickets which fee hasn't been paid or confirmed at enough depth to be considered committed to.

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
}

type DialFunc

type DialFunc func(ctx context.Context, network, addr string) (net.Conn, error)

type Policy

type Policy struct {
	MaxFee     dcrutil.Amount
	ChangeAcct uint32 // to derive fee addresses
	FeeAcct    uint32 // to pay fees from, if inputs are not provided to Process
}

type TicketInfo

type TicketInfo struct {
	TicketHash     chainhash.Hash
	CommitmentAddr stdaddr.StakeAddress
	VotingAddr     stdaddr.StakeAddress
	State          uint32
	Fee            dcrutil.Amount
	FeeHash        chainhash.Hash
}

TicketInfo stores per-ticket info tracked by a VSP Client instance.