package
1.0.0-rc.3
Repository: https://github.com/babylonlabs-io/babylon.git
Documentation: pkg.go.dev

# Functions

DefaultGenesis returns the default genesis state.
DefaultParams returns a default set of parameters.
IncrementJailedFinalityProviderCounter increments the counter for the jailed finality providers.
IncrementUnjailedFinalityProviderCounter increments the counter for the unjailed finality providers.
No description provided by the author
No description provided by the author
No description provided by the author
NewFinalityProviderSigningInfo creates a new FinalityProviderSigningInfo instance.
NewMockBTCStakingKeeper creates a new mock instance.
NewMockCheckpointingKeeper creates a new mock instance.
NewMockIncentiveKeeper creates a new mock instance.
No description provided by the author
NewQueriedBlockStatus takes a human-readable queried block status format and returns our custom enum.
No description provided by the author
No description provided by the author
No description provided by the author
RecordLastFinalizedHeight records the last finalized height.
RecordLastHeight records the last height.
No description provided by the author
No description provided by the author
No description provided by the author
RegisterQueryHandler registers the http handlers for service Query to "mux".
RegisterQueryHandlerClient registers the http handlers for service Query to "mux".
RegisterQueryHandlerFromEndpoint is same as RegisterQueryHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterQueryHandlerServer registers the http handlers for service Query to "mux".
No description provided by the author
SortFinalityProvidersWithZeroedVotingPower sorts the finality providers slice, from higher to lower voting power.
VerifyFinalitySig verifies the finality signature message w.r.t.

# Constants

For mainnet considering we want 48 hours at a block time of 10s that would be 17280 blocks considering the upgrade for Phase-2 will happen at block 220, the mainnet activation height for btcstaking should be 17280 + 220 = 17500.
Default parameter namespace.
1 day.
Default parameter namespace.
Default parameter namespace.
Default parameter namespace.
MemStoreKey defines the in-memory store key.
performance oriented metrics measuring the execution time of each message.
performance oriented metrics measuring the execution time of each message.
MetricsKeyJailedFinalityProviderCounter is the total number of finality providers that are labeled as jailed.
MetricsKeyLastFinalizedHeight is the key of the gauge recording the last height finalized by finality providers.
MetricsKeyLastHeight is the key of the gauge recording the last height of the ledger.
MetricsKeyUnjailedFinalityProviderCounter is the total number of finality providers that are unjailed the number of finality providers that are being jailed can be calculated by jailed_finality_provider_counter - unjailed_finality_provider_counter.
performance oriented metrics measuring the execution time of each message.
2^10 bits.
ModuleName defines the module name.
ANY means the block can be in any status.
FINALIZED means the block is finalized.
NON_FINALIZED means the block is not finalised.
RouterKey defines the module's message routing key.
StoreKey defines the primary module store key.

# Variables

No description provided by the author
key prefix for blocks.
No description provided by the author
x/finality module sentinel errors.
x/finality module sentinel errors.
x/finality module sentinel errors.
x/finality module sentinel errors.
x/finality module sentinel errors.
x/finality module sentinel errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
x/finality module sentinel errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
x/finality module sentinel errors.
x/finality module sentinel errors.
x/finality module sentinel errors.
x/finality module sentinel errors.
x/finality module sentinel errors.
x/finality module sentinel errors.
x/finality module sentinel errors.
x/finality module sentinel errors.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
x/finality module sentinel errors.
x/finality module sentinel errors.
key prefix for evidences.
key prefix for missed block bitmap.
key prefix for signing info.
No description provided by the author
key prefix for next height to finalise.
key prefix for next height to reward.
key prefix for the parameters.
key prefix for commitment of public randomness.
key prefix for public randomness.
No description provided by the author
No description provided by the author
key prefix for votes.
key prefix for voting power distribution cache.
key prefix for the voting power.

# Structs

ActiveFinalityProvidersAtHeightResponse wraps the FinalityProvider with metadata.
EventJailedFinalityProvider is the event emitted when a finality provider is jailed due to inactivity.
EventSlashedFinalityProvider is the event emitted when a finality provider is slashed due to signing two conflicting blocks.
Evidence is the evidence that a finality provider has signed finality signatures with correct public randomness on two conflicting Babylon headers.
Evidence is the evidence that a finality provider has signed finality signatures with correct public randomness on two conflicting Babylon headers.
FinalityProviderDistInfo is the reward distribution of a finality provider and its BTC delegations.
FinalityProviderMissedBlocks contains array of missed blocks of corresponding BTC public key.
FinalityProviderSigningInfo defines a finality provider's signing info for monitoring their liveness activity.
GenesisState defines the finality module's genesis state.
IndexedBlock is the necessary metadata and finalization status of a block.
MissedBlock contains height and missed status as boolean.
MockBTCStakingKeeper is a mock of BTCStakingKeeper interface.
MockBTCStakingKeeperMockRecorder is the mock recorder for MockBTCStakingKeeper.
MockCheckpointingKeeper is a mock of CheckpointingKeeper interface.
MockCheckpointingKeeperMockRecorder is the mock recorder for MockCheckpointingKeeper.
MockIncentiveKeeper is a mock of IncentiveKeeper interface.
MockIncentiveKeeperMockRecorder is the mock recorder for MockIncentiveKeeper.
MsgAddFinalitySig defines a message for adding a finality vote.
MsgAddFinalitySigResponse is the response to the MsgAddFinalitySig message.
MsgCommitPubRandList defines a message for committing a list of public randomness for EOTS.
MsgCommitPubRandListResponse is the response to the MsgCommitPubRandList message.
MsgResumeFinalityProposal is a governance proposal to resume finality from halting.
MsgResumeFinalityProposalResponse is the response to the MsgResumeFinalityProposal message.
MsgUnjailFinalityProvider defines the Msg/UnjailFinalityProvider request type.
MsgUnjailFinalityProviderResponse defines the Msg/UnjailFinalityProvider response type.
MsgUpdateParams defines a message for updating finality module parameters.
MsgUpdateParamsResponse is the response to the MsgUpdateParams message.
Params defines the parameters for the module.
PublicRandomness the block height and public randomness that the finality provider has submitted.
PubRandCommit is a commitment to a series of public randomness currently, the commitment is a root of a Merkle tree that includes a series of public randomness.
PubRandCommitResponse is the response type for a public randomness commitment.
PubRandCommitWithPK is the public randomness commitment with the finality provider's BTC public key.
QueryActivatedHeightRequest is the request type for the Query/ActivatedHeight RPC method.
QueryActivatedHeightResponse is the response type for the Query/ActivatedHeight RPC method.
QueryActiveFinalityProvidersAtHeightRequest is the request type for the Query/ActiveFinalityProvidersAtHeight RPC method.
QueryActiveFinalityProvidersAtHeightResponse is the response type for the Query/ActiveFinalityProvidersAtHeight RPC method.
QueryBlockRequest is the request type for the Query/Block RPC method.
QueryBlockResponse is the response type for the Query/Block RPC method.
QueryEvidenceRequest is the request type for the Query/Evidence RPC method.
QueryEvidenceResponse is the response type for the Query/Evidence RPC method.
QueryFinalityProviderCurrentPowerRequest is the request type for the Query/FinalityProviderCurrentPower RPC method.
QueryFinalityProviderCurrentPowerResponse is the response type for the Query/FinalityProviderCurrentPower RPC method.
QueryFinalityProviderPowerAtHeightRequest is the request type for the Query/FinalityProviderPowerAtHeight RPC method.
QueryFinalityProviderPowerAtHeightResponse is the response type for the Query/FinalityProviderPowerAtHeight RPC method.
QueryListBlocksRequest is the request type for the Query/ListBlocks RPC method.
QueryListBlocksResponse is the response type for the Query/ListBlocks RPC method.
QueryListEvidencesRequest is the request type for the Query/ListEvidences RPC method.
QueryListEvidencesResponse is the response type for the Query/ListEvidences RPC method.
QueryListPublicRandomnessRequest is the request type for the Query/ListPublicRandomness RPC method.
QueryListPublicRandomnessResponse is the response type for the Query/ListPublicRandomness RPC method.
QueryListPubRandCommitRequest is the request type for the Query/ListPubRandCommit RPC method.
QueryListPubRandCommitResponse is the response type for the Query/ListPubRandCommit RPC method.
QueryParamsRequest is request type for the Query/Params RPC method.
QueryParamsResponse is response type for the Query/Params RPC method.
QuerySigningInfoRequest is the request type for the Query/SigningInfo RPC method.
QuerySigningInfoResponse is the response type for the Query/SigningInfo RPC method.
QuerySigningInfosRequest is the request type for the Query/SigningInfos RPC method.
QuerySigningInfosResponse is the response type for the Query/SigningInfos RPC method.
QueryVotesAtHeightRequest is the request type for the Query/VotesAtHeight RPC method.
QueryVotesAtHeightResponse is the response type for the Query/VotesAtHeight RPC method.
SigningInfo stores finality provider signing info of corresponding BTC public key.
SigningInfoResponse defines the API response containing a finality provider's signing info for monitoring their liveness activity.
UnimplementedMsgServer can be embedded to have forward compatible implementations.
UnimplementedQueryServer can be embedded to have forward compatible implementations.
VoteSig the vote of an finality provider with the block of the vote, the finality provider btc public key and the vote signature.
VotingPowerDistCache is the cache for voting power distribution of finality providers and their BTC delegations at a height.
VotingPowerDistCacheBlkHeight the total voting power of the finality providers at one specific block height.
VotingPowerFP contains the information about the voting power of an finality provider in a specific block height.

# Interfaces

No description provided by the author
No description provided by the author
IncentiveKeeper defines the expected interface needed for distributing rewards and refund transaction fee for finality signatures.
MsgClient is the client API for Msg service.
MsgServer is the server API for Msg service.
QueryClient is the client API for Query service.
QueryServer is the server API for Query service.

# Type aliases

QueriedBlockStatus is the status of blocks that the querier wants to query.