Crate gauge

source · []
Expand description

Allows Tribeca Voting Escrows to vote on token allocations between different Quarries.

Detailed documentation is available on the Tribeca documentation site.

License

The Quarry Gauge program and SDK are distributed under the Affero GPL v3.0 license.

Modules

An Anchor generated module, providing a set of structs mirroring the structs deriving Accounts, where each field is a Pubkey. This is useful for specifying accounts for a client.

The gauge program.

An Anchor generated module containing the program’s set of instructions, where each method handler in the #[program] mod is associated with a struct defining the input arguments to the method. These should be used directly, when one wants to serialize Anchor instruction data, for example, when speciying instructions on a client.

Module representing the program.

Macros

Generates the signer seeds for a Gaugemeister.

Structs

An EpochGauge is a Gauge’s total committed votes for a given epoch.

An EpochGaugeVote is a user’s committed votes for a given Gauge at a given epoch.

An EpochGaugeVoter is a GaugeVoter’s total committed votes for a given Gauge at a given epoch.

A Gauge determines the rewards shares to give to a quarry_mine::Quarry.

A GaugeVote is a user’s vote for a given Gauge.

A GaugeVoter represents an locked_voter::Escrow that can vote on gauges.

Manages the rewards shares of all Gauges of a quarry_mine::rewarder.

Enums

Errors.

Statics

The static program ID

Functions

Confirms that a given pubkey is equivalent to the program ID

The Anchor codegen exposes a programming model where a user defines a set of methods inside of a #[program] module in a way similar to writing RPC request handlers. The macro then generates a bunch of code wrapping these user defined methods into something that can be executed on Solana.

Returns the program ID