README
¶
title: "Records" excerpt: "" category: 6392913957c533007128548e
The Records Module
The records module handles record keeping and accounting for the Stride blockchain.
It is IBC middleware. IBC middleware wraps core IBC modules and other middlewares. Specifically, the records module adds a middleware stack to app.go
with the following structure: records -> transfer
. All ibc packets routed to the transfer
module will first pass through records
, where we can apply custom logic (record keeping) before passing messages to the underlying transfer
module.
Note:
- The middleware stack is added in
app.go
- The custom handler logic is added in
ibc_module.go
by implementing the IBCModule interface
Keeper functions
Deposit Records
GetDepositRecordCount()
SetDepositRecordCount()
AppendDepositRecord()
SetDepositRecord()
GetDepositRecord()
RemoveDepositRecord()
GetAllDepositRecord()
GetTransferDepositRecordByEpochAndChain()
Epoch Unbonding Records
SetEpochUnbondingRecord()
GetEpochUnbondingRecord()
RemoveEpochUnbondingRecord()
GetAllEpochUnbondingRecord()
GetAllPreviousEpochUnbondingRecords()
GetHostZoneUnbondingByChainId()
AddHostZoneToEpochUnbondingRecord()
SetHostZoneUnbondings()
User Redemption Records
SetUserRedemptionRecord()
GetUserRedemptionRecord()
RemoveUserRedemptionRecord()
GetAllUserRedemptionRecord()
IterateUserRedemptionRecords()
State
Callbacks
TransferCallback
Genesis
UserRedemptionRecord
Params
RecordsPacketData
NoData
DepositRecord
HostZoneUnbonding
EpochUnbondingRecord
GenesisState
Queries
Params
GetDepositRecord
AllDepositRecord
GetUserRedemptionRecord
AllUserRedemptionRecord
AllUserRedemptionRecordForUser
GetEpochUnbondingRecord
AllEpochUnbondingRecord
Events
The records
module emits does not currently emit any events.
Documentation
¶
Index ¶
- func ExportGenesis(ctx sdk.Context, k keeper.Keeper) *types.GenesisState
- func InitGenesis(ctx sdk.Context, k keeper.Keeper, genState types.GenesisState)
- func NewHandler(k keeper.Keeper) sdk.Handler
- type AppModule
- func (am AppModule) BeginBlock(_ sdk.Context, _ abci.RequestBeginBlock)
- func (AppModule) ConsensusVersion() uint64
- func (am AppModule) EndBlock(_ sdk.Context, _ abci.RequestEndBlock) []abci.ValidatorUpdate
- func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONCodec) json.RawMessage
- func (AppModule) GenerateGenesisState(simState *module.SimulationState)
- func (am AppModule) InitGenesis(ctx sdk.Context, cdc codec.JSONCodec, gs json.RawMessage) []abci.ValidatorUpdate
- func (am AppModule) Name() string
- func (am AppModule) NegotiateAppVersion(ctx sdk.Context, order channeltypes.Order, connectionID string, portID string, ...) (version string, err error)
- func (am AppModule) OnAcknowledgementPacket(ctx sdk.Context, modulePacket channeltypes.Packet, acknowledgement []byte, ...) error
- func (am AppModule) OnChanCloseConfirm(ctx sdk.Context, portID, channelID string) error
- func (am AppModule) OnChanCloseInit(ctx sdk.Context, portID, channelID string) error
- func (am AppModule) OnChanOpenAck(ctx sdk.Context, portID, channelID string, counterpartyVersion string) error
- func (am AppModule) OnChanOpenConfirm(ctx sdk.Context, portID, channelID string) error
- func (am AppModule) OnChanOpenInit(ctx sdk.Context, order channeltypes.Order, connectionHops []string, ...) (string, error)
- func (am AppModule) OnChanOpenTry(ctx sdk.Context, order channeltypes.Order, connectionHops []string, ...) error
- func (am AppModule) OnRecvPacket(ctx sdk.Context, modulePacket channeltypes.Packet, relayer sdk.AccAddress) ibcexported.Acknowledgement
- func (am AppModule) OnTimeoutPacket(ctx sdk.Context, modulePacket channeltypes.Packet, relayer sdk.AccAddress) error
- func (AppModule) ProposalContents(_ module.SimulationState) []simtypes.WeightedProposalMsg
- func (AppModule) QuerierRoute() string
- func (am AppModule) RandomizedParams(_ *rand.Rand) []simtypes.LegacyParamChange
- func (am AppModule) RegisterInvariants(_ sdk.InvariantRegistry)
- func (am AppModule) RegisterServices(cfg module.Configurator)
- func (am AppModule) RegisterStoreDecoder(_ sdk.StoreDecoderRegistry)
- func (am AppModule) WeightedOperations(simState module.SimulationState) []simtypes.WeightedOperation
- type AppModuleBasic
- func (AppModuleBasic) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage
- func (AppModuleBasic) GetQueryCmd() *cobra.Command
- func (a AppModuleBasic) GetTxCmd() *cobra.Command
- func (AppModuleBasic) Name() string
- func (AppModuleBasic) RegisterCodec(cdc *codec.LegacyAmino)
- func (AppModuleBasic) RegisterGRPCGatewayRoutes(clientCtx client.Context, mux *runtime.ServeMux)
- func (a AppModuleBasic) RegisterInterfaces(reg cdctypes.InterfaceRegistry)
- func (AppModuleBasic) RegisterLegacyAminoCodec(cdc *codec.LegacyAmino)
- func (AppModuleBasic) RegisterRESTRoutes(clientCtx client.Context, rtr *mux.Router)
- func (AppModuleBasic) ValidateGenesis(cdc codec.JSONCodec, config client.TxEncodingConfig, bz json.RawMessage) error
- type IBCModule
- func (im IBCModule) GetAppVersion(ctx sdk.Context, portID, channelID string) (string, bool)
- func (im IBCModule) OnAcknowledgementPacket(ctx sdk.Context, packet channeltypes.Packet, acknowledgement []byte, ...) error
- func (im IBCModule) OnChanCloseConfirm(ctx sdk.Context, portID, channelID string) error
- func (im IBCModule) OnChanCloseInit(ctx sdk.Context, portID, channelID string) error
- func (im IBCModule) OnChanOpenAck(ctx sdk.Context, portID, channelID string, counterpartyChannelId string, ...) error
- func (im IBCModule) OnChanOpenConfirm(ctx sdk.Context, portID, channelID string) error
- func (im IBCModule) OnChanOpenInit(ctx sdk.Context, order channeltypes.Order, connectionHops []string, ...) (string, error)
- func (im IBCModule) OnChanOpenTry(ctx sdk.Context, order channeltypes.Order, connectionHops []string, ...) (string, error)
- func (im IBCModule) OnRecvPacket(ctx sdk.Context, packet channeltypes.Packet, relayer sdk.AccAddress) ibcexported.Acknowledgement
- func (im IBCModule) OnTimeoutPacket(ctx sdk.Context, packet channeltypes.Packet, relayer sdk.AccAddress) error
- func (im IBCModule) SendPacket(ctx sdk.Context, chanCap *capabilitytypes.Capability, ...) error
- func (im IBCModule) WriteAcknowledgement(ctx sdk.Context, chanCap *capabilitytypes.Capability, ...) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ExportGenesis ¶
ExportGenesis returns the capability module's exported genesis.
func InitGenesis ¶
InitGenesis initializes the capability module's state from a provided genesis state.
Types ¶
type AppModule ¶
type AppModule struct { AppModuleBasic // contains filtered or unexported fields }
AppModule implements the AppModule interface for the capability module.
func NewAppModule ¶
func NewAppModule( cdc codec.Codec, keeper keeper.Keeper, accountKeeper types.AccountKeeper, bankKeeper types.BankKeeper, ) AppModule
func (AppModule) BeginBlock ¶
func (am AppModule) BeginBlock(_ sdk.Context, _ abci.RequestBeginBlock)
BeginBlock executes all ABCI BeginBlock logic respective to the capability module.
func (AppModule) ConsensusVersion ¶
ConsensusVersion implements ConsensusVersion.
func (AppModule) EndBlock ¶
func (am AppModule) EndBlock(_ sdk.Context, _ abci.RequestEndBlock) []abci.ValidatorUpdate
EndBlock executes all ABCI EndBlock logic respective to the capability module. It returns no validator updates.
func (AppModule) ExportGenesis ¶
ExportGenesis returns the capability module's exported genesis state as raw JSON bytes.
func (AppModule) GenerateGenesisState ¶
func (AppModule) GenerateGenesisState(simState *module.SimulationState)
GenerateGenesisState creates a randomized GenState of the module
func (AppModule) InitGenesis ¶
func (am AppModule) InitGenesis(ctx sdk.Context, cdc codec.JSONCodec, gs json.RawMessage) []abci.ValidatorUpdate
InitGenesis performs the capability module's genesis initialization It returns no validator updates.
func (AppModule) NegotiateAppVersion ¶
func (am AppModule) NegotiateAppVersion( ctx sdk.Context, order channeltypes.Order, connectionID string, portID string, counterparty channeltypes.Counterparty, proposedVersion string, ) (version string, err error)
func (AppModule) OnAcknowledgementPacket ¶
func (am AppModule) OnAcknowledgementPacket( ctx sdk.Context, modulePacket channeltypes.Packet, acknowledgement []byte, relayer sdk.AccAddress, ) error
OnAcknowledgementPacket implements the IBCModule interface
func (AppModule) OnChanCloseConfirm ¶
OnChanCloseConfirm implements the IBCModule interface
func (AppModule) OnChanCloseInit ¶
OnChanCloseInit implements the IBCModule interface
func (AppModule) OnChanOpenAck ¶
func (am AppModule) OnChanOpenAck( ctx sdk.Context, portID, channelID string, counterpartyVersion string, ) error
OnChanOpenAck implements the IBCModule interface
func (AppModule) OnChanOpenConfirm ¶
OnChanOpenConfirm implements the IBCModule interface
func (AppModule) OnChanOpenInit ¶
func (am AppModule) OnChanOpenInit( ctx sdk.Context, order channeltypes.Order, connectionHops []string, portID string, channelID string, chanCap *capabilitytypes.Capability, counterparty channeltypes.Counterparty, version string, ) (string, error)
APP MODULE IMPLEMENTATION OnChanOpenInit implements the IBCModule interface
func (AppModule) OnChanOpenTry ¶
func (am AppModule) OnChanOpenTry( ctx sdk.Context, order channeltypes.Order, connectionHops []string, portID, channelID string, chanCap *capabilitytypes.Capability, counterparty channeltypes.Counterparty, version, counterpartyVersion string, ) error
OnChanOpenTry implements the IBCModule interface
func (AppModule) OnRecvPacket ¶
func (am AppModule) OnRecvPacket( ctx sdk.Context, modulePacket channeltypes.Packet, relayer sdk.AccAddress, ) ibcexported.Acknowledgement
OnRecvPacket implements the IBCModule interface
func (AppModule) OnTimeoutPacket ¶
func (am AppModule) OnTimeoutPacket( ctx sdk.Context, modulePacket channeltypes.Packet, relayer sdk.AccAddress, ) error
OnTimeoutPacket implements the IBCModule interface
func (AppModule) ProposalContents ¶
func (AppModule) ProposalContents(_ module.SimulationState) []simtypes.WeightedProposalMsg
ProposalContents doesn't return any content functions for governance proposals
func (AppModule) QuerierRoute ¶
QuerierRoute returns the capability module's query routing key.
func (AppModule) RandomizedParams ¶
func (am AppModule) RandomizedParams(_ *rand.Rand) []simtypes.LegacyParamChange
RandomizedParams creates randomized param changes for the simulator
func (AppModule) RegisterInvariants ¶
func (am AppModule) RegisterInvariants(_ sdk.InvariantRegistry)
RegisterInvariants registers the capability module's invariants.
func (AppModule) RegisterServices ¶
func (am AppModule) RegisterServices(cfg module.Configurator)
RegisterServices registers a GRPC query service to respond to the module-specific GRPC queries.
func (AppModule) RegisterStoreDecoder ¶
func (am AppModule) RegisterStoreDecoder(_ sdk.StoreDecoderRegistry)
RegisterStoreDecoder registers a decoder
func (AppModule) WeightedOperations ¶
func (am AppModule) WeightedOperations(simState module.SimulationState) []simtypes.WeightedOperation
WeightedOperations returns the all the gov module operations with their respective weights.
type AppModuleBasic ¶
type AppModuleBasic struct {
// contains filtered or unexported fields
}
AppModuleBasic implements the AppModuleBasic interface for the capability module.
func NewAppModuleBasic ¶
func NewAppModuleBasic(cdc codec.BinaryCodec) AppModuleBasic
func (AppModuleBasic) DefaultGenesis ¶
func (AppModuleBasic) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage
DefaultGenesis returns the capability module's default genesis state.
func (AppModuleBasic) GetQueryCmd ¶
func (AppModuleBasic) GetQueryCmd() *cobra.Command
GetQueryCmd returns the capability module's root query command.
func (AppModuleBasic) GetTxCmd ¶
func (a AppModuleBasic) GetTxCmd() *cobra.Command
GetTxCmd returns the capability module's root tx command.
func (AppModuleBasic) Name ¶
func (AppModuleBasic) Name() string
Name returns the capability module's name.
func (AppModuleBasic) RegisterCodec ¶
func (AppModuleBasic) RegisterCodec(cdc *codec.LegacyAmino)
func (AppModuleBasic) RegisterGRPCGatewayRoutes ¶
func (AppModuleBasic) RegisterGRPCGatewayRoutes(clientCtx client.Context, mux *runtime.ServeMux)
RegisterGRPCGatewayRoutes registers the gRPC Gateway routes for the module.
func (AppModuleBasic) RegisterInterfaces ¶
func (a AppModuleBasic) RegisterInterfaces(reg cdctypes.InterfaceRegistry)
RegisterInterfaces registers the module's interface types
func (AppModuleBasic) RegisterLegacyAminoCodec ¶
func (AppModuleBasic) RegisterLegacyAminoCodec(cdc *codec.LegacyAmino)
func (AppModuleBasic) RegisterRESTRoutes ¶
func (AppModuleBasic) RegisterRESTRoutes(clientCtx client.Context, rtr *mux.Router)
RegisterRESTRoutes registers the capability module's REST service handlers.
func (AppModuleBasic) ValidateGenesis ¶
func (AppModuleBasic) ValidateGenesis(cdc codec.JSONCodec, config client.TxEncodingConfig, bz json.RawMessage) error
ValidateGenesis performs genesis state validation for the capability module.
type IBCModule ¶
type IBCModule struct {
// contains filtered or unexported fields
}
IBC MODULE IMPLEMENTATION IBCModule implements the ICS26 interface for transfer given the transfer keeper.
func NewIBCModule ¶
NewIBCModule creates a new IBCModule given the keeper
func (IBCModule) GetAppVersion ¶
GetAppVersion returns the interchain accounts metadata.
func (IBCModule) OnAcknowledgementPacket ¶
func (im IBCModule) OnAcknowledgementPacket( ctx sdk.Context, packet channeltypes.Packet, acknowledgement []byte, relayer sdk.AccAddress, ) error
OnAcknowledgementPacket implements the IBCModule interface
func (IBCModule) OnChanCloseConfirm ¶
OnChanCloseConfirm implements the IBCModule interface
func (IBCModule) OnChanCloseInit ¶
OnChanCloseInit implements the IBCModule interface
func (IBCModule) OnChanOpenAck ¶
func (im IBCModule) OnChanOpenAck( ctx sdk.Context, portID, channelID string, counterpartyChannelId string, counterpartyVersion string, ) error
OnChanOpenAck implements the IBCModule interface
func (IBCModule) OnChanOpenConfirm ¶
OnChanOpenConfirm implements the IBCModule interface
func (IBCModule) OnChanOpenInit ¶
func (im IBCModule) OnChanOpenInit( ctx sdk.Context, order channeltypes.Order, connectionHops []string, portID string, channelID string, channelCap *capabilitytypes.Capability, counterparty channeltypes.Counterparty, version string, ) (string, error)
OnChanOpenInit implements the IBCModule interface
func (IBCModule) OnChanOpenTry ¶
func (im IBCModule) OnChanOpenTry( ctx sdk.Context, order channeltypes.Order, connectionHops []string, portID, channelID string, chanCap *capabilitytypes.Capability, counterparty channeltypes.Counterparty, counterpartyVersion string, ) (string, error)
OnChanOpenTry implements the IBCModule interface.
func (IBCModule) OnRecvPacket ¶
func (im IBCModule) OnRecvPacket( ctx sdk.Context, packet channeltypes.Packet, relayer sdk.AccAddress, ) ibcexported.Acknowledgement
OnRecvPacket implements the IBCModule interface. A successful acknowledgement is returned if the packet data is successfully decoded and the receive application logic returns without error.
func (IBCModule) OnTimeoutPacket ¶
func (im IBCModule) OnTimeoutPacket( ctx sdk.Context, packet channeltypes.Packet, relayer sdk.AccAddress, ) error
OnTimeoutPacket implements the IBCModule interface
func (IBCModule) SendPacket ¶
func (im IBCModule) SendPacket( ctx sdk.Context, chanCap *capabilitytypes.Capability, packet ibcexported.PacketI, ) error
This is implemented by ICS4 and all middleware that are wrapping base application. The base application will call `sendPacket` or `writeAcknowledgement` of the middleware directly above them which will call the next middleware until it reaches the core IBC handler. SendPacket implements the ICS4 Wrapper interface
func (IBCModule) WriteAcknowledgement ¶
func (im IBCModule) WriteAcknowledgement( ctx sdk.Context, chanCap *capabilitytypes.Capability, packet ibcexported.PacketI, ack ibcexported.Acknowledgement, ) error
WriteAcknowledgement implements the ICS4 Wrapper interface