gno.land/r/gnoswap/protocol_fee/v1

Realm

Overview

Kind: Realm (renderable)
Name: v1
Namespace: gnoswap / protocol_fee
Files: 12 (README)(gnomod.toml)
Exported functions: 2
Module: gno.land/r/gnoswap/protocol_fee/v1
gno: 0.9

Files (12)

getter.gnogno

1package protocol_fee23// GetDevOpsPct returns the percentage allocated to devOps.4//5// Returns:6//   - pct: DevOps' protocol-fee allocation percentage in basis points (0 through 10000).7func (pf *protocolFeeV1) GetDevOpsPct() int64

Functions

NewProtocolFeeStateBy(protocolFeeStore interface {AddAccrualBucket func(int, .uverse.realm, string, int64, int64) .uverse.error; AddAccrualPendingToken func(int, .uverse.realm, string) .uverse.error; AddReservedToken func(int, .uverse.realm, string) .uverse.error; GetAccrualBuckets func(string, int) ([]int64, []int64); GetAccrualEpoch func() int64; GetAccrualPendingTokens func() []string; GetAccuToDevOps func() *gno.land/p/nt/bptree/v0.BPTree; GetAccuToDevOpsItem func(string) (int64, bool); GetAccuToGovStaker func() *gno.land/p/nt/bptree/v0.BPTree; GetAccuToGovStakerItem func(string) (int64, bool); GetDevOpsPct func() int64; GetDistributedToDevOpsHistory func() *gno.land/p/nt/bptree/v0.BPTree; GetDistributedToDevOpsHistoryItem func(string) (int64, bool); GetDistributedToGovStakerHistory func() *gno.land/p/nt/bptree/v0.BPTree; GetDistributedToGovStakerHistoryItem func(string) (int64, bool); GetReservedTokens func() []string; HasAccrualBucketsStoreKey func() bool; HasAccrualEpochStoreKey func() bool; HasAccrualPendingTokensStoreKey func() bool; HasAccuToDevOpsStoreKey func() bool; HasAccuToGovStakerStoreKey func() bool; HasDevOpsPctStoreKey func() bool; HasDistributedToDevOpsHistoryStoreKey func() bool; HasDistributedToGovStakerHistoryStoreKey func() bool; HasReservedToken func(string) bool; HasReservedTokensStoreKey func() bool; InitializeAccrualBuckets func(int, .uverse.realm) .uverse.error; InitializeAccrualEpoch func(int, .uverse.realm) .uverse.error; InitializeAccrualPendingTokens func(int, .uverse.realm) .uverse.error; InitializeAccuToDevOps func(int, .uverse.realm) .uverse.error; InitializeAccuToGovStaker func(int, .uverse.realm) .uverse.error; InitializeDevOpsPct func(int, .uverse.realm) .uverse.error; InitializeDistributedToDevOpsHistory func(int, .uverse.realm) .uverse.error; InitializeDistributedToGovStakerHistory func(int, .uverse.realm) .uverse.error; InitializeReservedTokens func(int, .uverse.realm) .uverse.error; RemoveAccrualBuckets func(int, .uverse.realm, string, []int64) .uverse.error; RemoveAccrualPendingToken func(int, .uverse.realm, string) .uverse.error; RemoveReservedToken func(int, .uverse.realm, string) .uverse.error; SetAccrualEpoch func(int, .uverse.realm, int64) .uverse.error; SetAccuToDevOpsItem func(int, .uverse.realm, string, int64) .uverse.error; SetAccuToGovStakerItem func(int, .uverse.realm, string, int64) .uverse.error; SetDevOpsPct func(int, .uverse.realm, int64) .uverse.error; SetDistributedToDevOpsHistoryItem func(int, .uverse.realm, string, int64) .uverse.error; SetDistributedToGovStakerHistoryItem func(int, .uverse.realm, string, int64) .uverse.error}) *gno.land/r/gnoswap/protocol_fee/v1.protocolFeeState
NewProtocolFeeV1(protocolFeeStore interface {AddAccrualBucket func(int, .uverse.realm, string, int64, int64) .uverse.error; AddAccrualPendingToken func(int, .uverse.realm, string) .uverse.error; AddReservedToken func(int, .uverse.realm, string) .uverse.error; GetAccrualBuckets func(string, int) ([]int64, []int64); GetAccrualEpoch func() int64; GetAccrualPendingTokens func() []string; GetAccuToDevOps func() *gno.land/p/nt/bptree/v0.BPTree; GetAccuToDevOpsItem func(string) (int64, bool); GetAccuToGovStaker func() *gno.land/p/nt/bptree/v0.BPTree; GetAccuToGovStakerItem func(string) (int64, bool); GetDevOpsPct func() int64; GetDistributedToDevOpsHistory func() *gno.land/p/nt/bptree/v0.BPTree; GetDistributedToDevOpsHistoryItem func(string) (int64, bool); GetDistributedToGovStakerHistory func() *gno.land/p/nt/bptree/v0.BPTree; GetDistributedToGovStakerHistoryItem func(string) (int64, bool); GetReservedTokens func() []string; HasAccrualBucketsStoreKey func() bool; HasAccrualEpochStoreKey func() bool; HasAccrualPendingTokensStoreKey func() bool; HasAccuToDevOpsStoreKey func() bool; HasAccuToGovStakerStoreKey func() bool; HasDevOpsPctStoreKey func() bool; HasDistributedToDevOpsHistoryStoreKey func() bool; HasDistributedToGovStakerHistoryStoreKey func() bool; HasReservedToken func(string) bool; HasReservedTokensStoreKey func() bool; InitializeAccrualBuckets func(int, .uverse.realm) .uverse.error; InitializeAccrualEpoch func(int, .uverse.realm) .uverse.error; InitializeAccrualPendingTokens func(int, .uverse.realm) .uverse.error; InitializeAccuToDevOps func(int, .uverse.realm) .uverse.error; InitializeAccuToGovStaker func(int, .uverse.realm) .uverse.error; InitializeDevOpsPct func(int, .uverse.realm) .uverse.error; InitializeDistributedToDevOpsHistory func(int, .uverse.realm) .uverse.error; InitializeDistributedToGovStakerHistory func(int, .uverse.realm) .uverse.error; InitializeReservedTokens func(int, .uverse.realm) .uverse.error; RemoveAccrualBuckets func(int, .uverse.realm, string, []int64) .uverse.error; RemoveAccrualPendingToken func(int, .uverse.realm, string) .uverse.error; RemoveReservedToken func(int, .uverse.realm, string) .uverse.error; SetAccrualEpoch func(int, .uverse.realm, int64) .uverse.error; SetAccuToDevOpsItem func(int, .uverse.realm, string, int64) .uverse.error; SetAccuToGovStakerItem func(int, .uverse.realm, string, int64) .uverse.error; SetDevOpsPct func(int, .uverse.realm, int64) .uverse.error; SetDistributedToDevOpsHistoryItem func(int, .uverse.realm, string, int64) .uverse.error; SetDistributedToGovStakerHistoryItem func(int, .uverse.realm, string, int64) .uverse.error}) interface {AddToProtocolFee func(int, .uverse.realm, string, int64) .uverse.error; AdvanceAccrualEpoch func(int, .uverse.realm) int64; ConsumeAccrualBuckets func(int, .uverse.realm, string, int) ([]int64, []int64); DistributeProtocolFee func(int, .uverse.realm); DistributeProtocolFeeByTokenPath func(int, .uverse.realm, string); GetAccrualBuckets func(string, int) ([]int64, []int64); GetAccrualEpoch func() int64; GetAccrualPendingTokens func() []string; GetAccuTransferToDevOpsByTokenPath func(string) int64; GetAccuTransferToGovStakerByTokenPath func(string) int64; GetAccuTransfersToDevOps func() map[string]int64; GetAccuTransfersToGovStaker func() map[string]int64; GetActualDistributedToDevOps func() map[string]int64; GetActualDistributedToDevOpsByTokenPath func(string) int64; GetActualDistributedToGovStaker func() map[string]int64; GetActualDistributedToGovStakerByTokenPath func(string) int64; GetDevOpsPct func() int64; GetGovStakerPct func() int64; GetReservedTokens func() []string; Render func(string) string; SetDevOpsPct func(int, .uverse.realm, int64); SetGovStakerPct func(int, .uverse.realm, int64)}

Signatures reconstructed verbatim from vm/qfuncs — interface params keep their inline definitions.

Rendered

Rendered Raw gnoweb ↗

This realm does not provide renderable output (vm/qrender → NoRenderDeclError). View on gnoweb ↗

vm/qrender output, sanitized (docs/render-security.md) and displayed in an empty-sandbox iframe — scripts, forms and popups cannot run. Links stay inert in-preview; right-click to open.

8 return pf.getProtocolFeeState().DevOpsPct()

11// GetGovStakerPct returns the percentage allocated to gov/staker.

14// - pct: Gov/Staker's protocol-fee allocation percentage in basis points, computed as 10000 minus the stored DevOps percentage.

15func (pf *protocolFeeV1) GetGovStakerPct() int64 {

16 return pf.getProtocolFeeState().GovStakerPct()

19// GetReservedTokens returns token paths reserved for distribution.

22// - tokenPaths: Token paths currently reserved for protocol-fee distribution.

23func (pf *protocolFeeV1) GetReservedTokens() []string {

24 return pf.getProtocolFeeState().ReservedTokens()

27// GetAccrualEpoch returns the accrual epoch fees are currently bucketed under.

30// - epoch: Current accrual epoch under which newly collected Gov/Staker amounts are bucketed.

31func (pf *protocolFeeV1) GetAccrualEpoch() int64 {

32 return pf.getProtocolFeeState().store.GetAccrualEpoch()

35// GetAccrualPendingTokens returns the token paths that still own pending accrual buckets.

38// - tokenPaths: Token paths that still have one or more pending Gov/Staker accrual buckets.

39func (pf *protocolFeeV1) GetAccrualPendingTokens() []string {

40 return pf.getProtocolFeeState().store.GetAccrualPendingTokens()

43// GetAccrualBuckets returns up to limit of the oldest pending buckets of tokenPath

44// without clearing them. A limit of zero or less returns every pending bucket.

47// - tokenPath: Token path whose pending Gov/Staker accrual buckets should be read.

48// - limit: Maximum number of buckets to return; zero or a negative value returns all pending buckets.

51// - epochs: Epoch numbers for the returned buckets in ascending epoch order.

52// - amounts: Gov/Staker amounts for the returned epochs; amounts[i] corresponds to epochs[i].

53func (pf *protocolFeeV1) GetAccrualBuckets(tokenPath string, limit int) ([]int64, []int64) {

54 return pf.getProtocolFeeState().store.GetAccrualBuckets(tokenPath, limit)

57// GetAccuTransfersToGovStaker returns all accumulated transfers to gov/staker.

60// - transfers: Snapshot map from token path to cumulative amount allocated to Gov/Staker, including amounts still pending distribution.

61func (pf *protocolFeeV1) GetAccuTransfersToGovStaker() map[string]int64 {

62 accuTransfers := make(map[string]int64)

64 pf.getProtocolFeeState().AccuToGovStaker().Iterate("", "", func(key string, value any) bool {

65 amount, ok := value.(int64)

70 accuTransfers[key] = amount

74 return accuTransfers

77// GetAccuTransfersToDevOps returns all accumulated transfers to devOps.

80// - transfers: Snapshot map from token path to cumulative amount allocated to DevOps, including amounts still pending distribution.

81func (pf *protocolFeeV1) GetAccuTransfersToDevOps() map[string]int64 {

82 accuTransfers := make(map[string]int64)

84 pf.getProtocolFeeState().AccuToDevOps().Iterate("", "", func(key string, value any) bool {

85 amount, ok := value.(int64)

90 accuTransfers[key] = amount

94 return accuTransfers

97// GetAccuTransferToGovStakerByTokenPath returns the accumulated transfer to gov/staker by token path.

100// - path: Token path whose cumulative Gov/Staker allocation should be read.

103// - amount: Cumulative Gov/Staker amount allocated for path, or zero when no allocation is recorded.

104func (pf *protocolFeeV1) GetAccuTransferToGovStakerByTokenPath(path string) int64 {

105 return pf.getProtocolFeeState().GetAccuTransferToGovStakerByTokenPath(path)

108// GetAccuTransferToDevOpsByTokenPath returns the accumulated transfer to devOps by token path.

111// - path: Token path whose cumulative DevOps allocation should be read.

114// - amount: Cumulative DevOps amount allocated for path, or zero when no allocation is recorded.

115func (pf *protocolFeeV1) GetAccuTransferToDevOpsByTokenPath(path string) int64 {

116 return pf.getProtocolFeeState().GetAccuTransferToDevOpsByTokenPath(path)

119// GetActualDistributedToGovStaker returns all actual transfers to gov/staker.

122// - transfers: Snapshot map from token path to cumulative amount actually distributed to Gov/Staker.

123func (pf *protocolFeeV1) GetActualDistributedToGovStaker() map[string]int64 {

124 actualDistributed := make(map[string]int64)

126 pf.getProtocolFeeState().ActualDistributedToGovStaker().Iterate("", "", func(key string, value any) bool {

127 amount, ok := value.(int64)

132 actualDistributed[key] = amount

136 return actualDistributed

139// GetActualDistributedToDevOps returns all actual transfers to devOps.

142// - transfers: Snapshot map from token path to cumulative amount actually distributed to DevOps.

143func (pf *protocolFeeV1) GetActualDistributedToDevOps() map[string]int64 {

144 actualDistributed := make(map[string]int64)

146 pf.getProtocolFeeState().ActualDistributedToDevOps().Iterate("", "", func(key string, value any) bool {

147 amount, ok := value.(int64)

152 actualDistributed[key] = amount

156 return actualDistributed

159// GetActualDistributedToGovStakerByTokenPath returns the actual transfer to gov/staker by token path.

162// - path: Token path whose cumulative actual Gov/Staker distribution should be read.

165// - amount: Cumulative amount actually distributed to Gov/Staker for path, or zero when no history is recorded.

166func (pf *protocolFeeV1) GetActualDistributedToGovStakerByTokenPath(path string) int64 {

167 return pf.getProtocolFeeState().GetActualDistributedToGovStakerByTokenPath(path)

170// GetActualDistributedToDevOpsByTokenPath returns the actual transfer to devOps by token path.

173// - path: Token path whose cumulative actual DevOps distribution should be read.

176// - amount: Cumulative amount actually distributed to DevOps for path, or zero when no history is recorded.

177func (pf *protocolFeeV1) GetActualDistributedToDevOpsByTokenPath(path string) int64 {

178 return pf.getProtocolFeeState().GetActualDistributedToDevOpsByTokenPath(path)

gno.land/r/gnoswap/protocol_fee/v1⧉

gno.land/r/gnoswap/protocol_fee/v1