
事件
类型化事件
事件在Cosmos SDK中作为ABCI事件类型的别名实现,并采用以下形式:{eventType}.{attributeKey}={attributeValue}。
// Event allows application developers to attach additional information to
// ResponseBeginBlock, ResponseEndBlock, ResponseCheckTx and ResponseDeliverTx.
// Later, transactions may be queried using these events.
message Event {
string type = 1;
repeated EventAttribute attributes = 2 [(gogoproto.nullable) = false, (gogoproto.jsontag) = "attributes,omitempty"];
}
一个事件包含:
- 一种在高层对事件进行分类的类型;例如,Cosmos SDK使用“消息”类型通过Msgs过滤事件。
- 属性列表是提供关于分类事件的更多信息的键值对。例如,对于“消息”类型,我们可以使用message.action={some_action}、message.module={some_module}或message.sender={some_sender}的键值对来过滤事件。
要将属性值解析为字符串,请确保在每个属性值周围添加'(单引号)。
类型化事件是Cosmos SDK用于发射和查询Protobuf定义的消息。它们在每个模块的event.proto文件中定义。它们通过使用EventManager从模块的Protobuf Msg服务中被触发,它们被读取为作proto.Message。
此外,每个模块都在spec/xx_events.md下记录其事件。
最后,事件在以下ABCI消息的响应中返回给底层共识引擎:
- BeginBlock
- EndBlock
- CheckTx
- DeliverTx
例子
下面的例子展示了如何使用Cosmos SDK查询事件。

事件管理器
在Cosmos SDK应用程序中,事件由称为EventManager的抽象管理。在内部,EventManager跟踪事务或BeginBlock/EndBlock的整个执行流程的事件列表。
// ----------------------------------------------------------------------------
// Event Manager
// ----------------------------------------------------------------------------
// EventManager implements a simple wrapper around a slice of Event objects that
// can be emitted from.
type EventManager struct {
events Events
}
EventManager带有一组有用的方法来管理事件。模块和应用程序开发人员使用最多的方法是EmitTypedEvent,它在EventManager中跟踪事件。
// EmitTypedEvent takes typed event and emits converting it into Event
func (em *EventManager) EmitTypedEvent(tev proto.Message) error {
event, err := TypedEventToEvent(tev)
if err != nil {
return err
}
em.EmitEvent(event)
return nil
}
模块开发人员应通过每个消息处理程序和每个BeginBlock/EndBlock处理程序中的EventManager#EmitTypedEvent处理事件发射。EventManager是通过Context访问的,其中Event应该已经注册,并像这样发出:
err = ctx.EventManager().EmitTypedEvent(&group.EventCreateGroup{GroupId: groupID})
if err != nil {
return nil, err
}
模块的处理函数还应该为context设置一个新的EventManager以隔离每条消息发出的事件:
func NewHandler(keeper Keeper) sdk.Handler {
return func(ctx sdk.Context, msg sdk.Msg) (*sdk.Result, error) {
ctx = ctx.WithEventManager(sdk.NewEventManager())
switch msg := msg.(type) {
订阅事件
可以使用Tendermint 的 Websocket通过调用subscribe RPC方法来订阅事件:
{
"jsonrpc": "2.0",
"method": "subscribe",
"id": "0",
"params": {
"query": "tm.event='eventCategory' AND eventType.eventAttribute='attributeValue'"
}
}
可以订阅的主要事件类别有:
- NewBlock:包含在BeginBlock和EndBlock期间触发的事件。
- Tx:包含在DeliverTx(即交易处理)期间触发的事件。
- ValidatorSetUpdates:包含区块的验证器设置更新。
这些事件是在一个区块提交后从状态包中触发的,可以在Tendermint Go文档中获得完整的事件类别列表。
查询的类型和属性值允许你过滤你正在寻找的特定事件。例如,Mint交易触发了一个EventMint类型的事件,并且有Id和Owner作为属性(在NFT模块的events.proto文件中定义)。
订阅这个事件的方法是这样的:
{
"jsonrpc": "2.0",
"method": "subscribe",
"id": "0",
"params": {
"query": "tm.event='Tx' AND mint.owner='ownerAddress'"
}
}
其中ownerAddress是遵循AccAddress格式的地址:
事件(已弃用)
以前,Cosmos SDK支持发射在 types/events.go 中定义的事件。定义事件类型和事件属性是模块开发者的责任。除了在spec/XX_events.md文件中,这些事件类型和属性很不幸地不容易被发现。
这就是为什么这种方法被弃用,而被_Typed事件取代。
遥测
Cosmos SDK使运营商和开发者能够通过使用遥测包深入了解其应用程序的性能和行为。要启用遥测功能,在app.toml配置文件中设置telemetry.enabled = true。
Cosmos SDK目前支持启用内存中和prometheus作为遥测接收器。内存接收器是以10秒的间隔和1分钟的保留来连接(启用遥测时)。这意味着指标将在10秒内汇总,指标将保持活动状态1分钟。
要查询活动指标(见上面的保留说明),必须启用API服务器(api.enabled = true in the app.toml)。单个API端点被暴露:http://localhost:1317/metrics?format={text|prometheus},默认为text。
发射指标
如果通过配置启用了遥测功能,就会通过go-metrics库注册单一的全局指标收集器。这允许通过简单的API发射和收集指标。例子:
func EndBlocker(ctx sdk.Context, k keeper.Keeper) {
defer telemetry.ModuleMeasureSince(types.ModuleName, time.Now(), telemetry.MetricKeyEndBlocker)
// ...
}
开发人员可以直接使用遥测包,它提供了包含添加有用标签的度量API的包装器,或者他们必须直接使用go-metrics库。最好为指标添加尽可能多的上下文和足够的维度,因此建议使用遥测包。无论使用何种包或方法,Cosmos SDK都支持以下指标类型:
- gauges
- summaries
- counters
标签
模块的某些组件将被自动添加其名称作为标签(如BeginBlock)。操作员也可以为应用程序提供一组全局标签,这些标签将被应用于所有使用遥测包发射的度量(例如,chain-ID)。全局标签是以[name, value]元组的列表形式提供的。
示例:
global-labels = [ ["chain_id", "chain-OfXo4V"], ]
基数
基数是关键,特别是标签和关键基数。基数是指某事物有多少个独特的价值。因此,在粒度和遥测接收器在索引、抓取和查询性能方面的压力有多大之间自然会有一个权衡。
开发人员应该注意支持具有足够维度和粒度的指标以使其有用,但不要将基数增加超过接收器的极限。一般的经验法则是基数不超过10。
考虑以下有足够的粒度和足够基数的示例:
- 开始/结束阻断器时间
- 使用的Tx气体
- 使用的块状气体
- 铸造的代币数量
- 创建的账户数量
下面的例子暴露了太多的基数,甚至可能证明没有用:
- 账户之间的转账金额
- 投票/存款金额来自唯一地址
支持的指标


对象能力模型
介绍
在考虑安全问题时,最好从一个特定的威胁模型开始。威胁模型如下:
假设一个繁荣的Cosmos SDK模块的生态系统,很容易组成一个区块链应用程序,将包含有问题或恶意的模块。
Cosmos SDK旨在通过作为对象能力系统的基础来解决这一威胁。
对象能力系统的结构属性有利于代码设计中的模块化,并确保代码实现中的可靠封装。
这些结构属性有利于分析对象能力程序或操作系统的一些安全属性。其中一些——特别是信息流属性——可以在对象引用和连接的层面上进行分析,独立于决定对象行为的代码的任何知识或分析。
因此,这些安全属性可以在包含未知和可能的恶意代码的新对象存在的情况下被建立和维护。
这些结构属性来自于管理对现有对象访问的两个规则:
- 只有当对象A持有对B的引用时,对象A才能向B发送消息。
- 只有当对象A收到含有对C的引用的消息时,对象A才能获得对C的引用。作为这两条规则的结果,一个对象只能通过预先存在的引用链获得对另一个对象的引用。简而言之,“只有连接才能产生连接性。”
相关术语表
对象能力系统:
- 对象:对象具有本地状态和行为。 这种意义上的客体既是访问控制文献中使用的意义上的主体又是客体。
- 引用:一个不可伪造的通信通道(受保护的指针,不透明的地址),它明确指定单个对象,并提供向该对象发送消息的权限。
- 消息:在参考上发送的内容。 根据系统的不同,消息本身可能是也可能不是一等对象。
- 请求:对引用发送消息的操作。收到消息后,接收者将有权访问消息中包含的任何引用。
- 衰减:对象能力系统中的一种常见设计模式:给定对象的一个引用,为具有某些安全限制的代理对象创建另一个引用,例如只允许只读访问或允许撤销。代理对象对它接收的消息执行安全检查,并传递任何允许的消息。深度衰减是指将相同的衰减传递到通过原始衰减对象获得的任何对象的情况,通常通过使用“膜”。
实践中的Ocaps
想法是只揭示完成工作所必需的东西。
例如,下面的代码片断违反了对象能力原则:
type AppAccount struct {...}
account := &AppAccount{
Address: pub.Address(),
Coins: sdk.Coins{sdk.NewInt64Coin("ATM", 100)},
}
sumValue := externalModule.ComputeSumValue(account)
ComputeSumValue方法隐含了一个纯函数,但接受指针值的隐含能力是修改该值的能力。首选方法签名应取而代之。
sumValue := externalModule.ComputeSumValue(*account)
在Cosmos SDK中,可以看到这个原理在simapp中的应用。
// add keepers app.AccountKeeper = authkeeper.NewAccountKeeper( appCodec, keys[authtypes.StoreKey], app.GetSubspace(authtypes.ModuleName), authtypes.ProtoBaseAccount, maccPerms, sdk.Bech32MainPrefix, ) app.BankKeeper = bankkeeper.NewBaseKeeper( appCodec, keys[banktypes.StoreKey], app.AccountKeeper, app.GetSubspace(banktypes.ModuleName), app.ModuleAccountAddrs(), ) stakingKeeper := stakingkeeper.NewKeeper( appCodec, keys[stakingtypes.StoreKey], app.AccountKeeper, app.BankKeeper, app.GetSubspace(stakingtypes.ModuleName), ) app.MintKeeper = mintkeeper.NewKeeper( appCodec, keys[minttypes.StoreKey], app.GetSubspace(minttypes.ModuleName), &stakingKeeper, app.AccountKeeper, app.BankKeeper, authtypes.FeeCollectorName, ) app.DistrKeeper = distrkeeper.NewKeeper( appCodec, keys[distrtypes.StoreKey], app.GetSubspace(distrtypes.ModuleName), app.AccountKeeper, app.BankKeeper, &stakingKeeper, authtypes.FeeCollectorName, ) app.SlashingKeeper = slashingkeeper.NewKeeper( appCodec, keys[slashingtypes.StoreKey], &stakingKeeper, app.GetSubspace(slashingtypes.ModuleName), ) app.CrisisKeeper = crisiskeeper.NewKeeper( app.GetSubspace(crisistypes.ModuleName), invCheckPeriod, app.BankKeeper, authtypes.FeeCollectorName, ) app.FeeGrantKeeper = feegrantkeeper.NewKeeper(appCodec, keys[feegrant.StoreKey], app.AccountKeeper)
下图显示了 Keeper 之间的当前依赖关系。

原文链接:https://docs.cosmos.network/main/core/events.html
https://docs.cosmos.network/main/core/telemetry.html
https://docs.cosmos.network/main/core/ocap.html
---煤油灯科技victorlamp.com翻译整理---









