Cosmos-- 三.教程 -- 4.Keeper

cosmos主网即将上线,对文档做了大量更新。特地翻译了一下,方便小伙伴们阅览, 之后会持续更新

第三章教程:

  1. 开始
  2. 程序目标
  3. 开始编写你的程序
  4. Keeper
  5. Msg和Handler
  6. SetName
  7. BuyName
  8. Querier
  9. Codec文件
  10. Nameservice模块的CLI
  11. nameservice模块的REST接口
  12. 引入你的模块并完成程序
  13. Entrypoint
  14. 编译你的程序
  15. 编译并运行程序
  16. 运行REST路由

Keeper

Cosmos SDK模块的主要核心是名为Keeper的部分。它处理同存储的交互,引用其他的keeper进行跨模块的交互,并包含模块的大部分核心功能。

首先创建文件./x/nameservice/keeper.go来保存模块的keeper。在Cosmos SDK应用程序中,模块通常放在./x/文件夹中。

Keeper结构

开始制作你的SDK模块,请在./x/nameservice/keeper.go文件中定义nameservice.Keeper

package nameservice

import (
    "github.com/cosmos/cosmos-sdk/codec"
    "github.com/cosmos/cosmos-sdk/x/bank"

    sdk "github.com/cosmos/cosmos-sdk/types"
)

// Keeper maintains the link to data storage and exposes getter/setter methods for the various parts of the state machine
type Keeper struct {
    coinKeeper bank.Keeper

    namesStoreKey  sdk.StoreKey // Unexposed key to access name store from sdk.Context
    ownersStoreKey sdk.StoreKey // Unexposed key to access owners store from sdk.Context
    pricesStoreKey sdk.StoreKey // Unexposed key to access prices store from sdk.Context

    cdc *codec.Codec // The wire codec for binary encoding/decoding.
}

关于上述代码的几点说明:

  • 3个不同的cosmos-sdk包被引入:
    • codec : 提供负责Cosmos编码格式的工具——Amino
    • bank : bank模块控制账户和转账。
    • codec : types包含了整个SDK常用的类型。
  • Keeper结构体。在keeper中有几个关键部分:
    • bank.Keeper : 这是bank模块的Keeper引用。包括它来允许该模块中的代码调用bank模块的函数。SDK使用对象能力来访问应用程序状态的各个部分。这是为了允许开发人员采用小权限准入原则,限制错误或恶意模块的去影响其不需要访问的状态的能力。
    • *codec.Codec : 这是被Amino用于编码及解码二进制机构的编码解码器的指针。
    • sdk.StoreKey : 通过它来访问一个持久化保存你的应用程序状态的sdk.KVStore
  • 模块有3个StoreKey:
    • namesStoreKey - 存储域名所指向的字符串值的主存储(即map[name]value)。
    • ownerStoreKey - 保存给定域名的当前所有者(即map[name]sdk_address)。
    • pricesStoreKey - 保存给定域名的当前所有者为其支付的价格。任何人要购买此域名的花费都必须超过当前所有者(即map[name]price)。

Getter和Setter

现在要添加通过Keeper来与存储交互的方法了。首先,添加一个函数来为指定域名设置解析字符串值:

// SetName - sets the value string that a name resolves to
func (k Keeper) SetName(ctx sdk.Context, name string, value string) {
    store := ctx.KVStore(k.namesStoreKey)
    store.Set([]byte(name), []byte(value))
}

在此方法中,首先使用Keeper中的namesStoreKey获取map[name]value的存储对象。

注意:这个函数使用sdk.Context。该对象持有访问像blockHeightchainID这样重要部分状态的函数。

接下来,你可以使用方法.Set([]byte,[]byte)向存储中插入<name, value>键值对。由于存储只接受[]byte,想要把string转化成[]byte再把它们作为参数传给Set方法。

接下来,添加一个函数来解析域名(即查找域名对应的解析值):

// ResolveName - returns the string that the name resolves to
func (k Keeper) ResolveName(ctx sdk.Context, name string) string {
    store := ctx.KVStore(k.namesStoreKey)
    bz := store.Get([]byte(name))
    return string(bz)
}

这里,与SetName方法一样,首先使用StoreKey访问存储。接下来,不使用使用.Get([] byte) []byte方法而不是Set方法。向函数传参,传递key值,要把name字符串转化成[]byte,并以[]byte的形式返回结果。将此转换成字符串再返回。

添加类似的函数来获取和设置域名所有者:

// HasOwner - returns whether or not the name already has an owner
func (k Keeper) HasOwner(ctx sdk.Context, name string) bool {
    store := ctx.KVStore(k.ownersStoreKey)
    bz := store.Get([]byte(name))
    return bz != nil
}

// GetOwner - get the current owner of a name
func (k Keeper) GetOwner(ctx sdk.Context, name string) sdk.AccAddress {
    store := ctx.KVStore(k.ownersStoreKey)
    bz := store.Get([]byte(name))
    return bz
}

// SetOwner - sets the current owner of a name
func (k Keeper) SetOwner(ctx sdk.Context, name string, owner sdk.AccAddress) {
    store := ctx.KVStore(k.ownersStoreKey)
    store.Set([]byte(name), owner)
}

注意在上述代码中:

  • sdk.Coins : 没有自己的字节编码器,这意味着价格需要使用Amino进行序列化和反序列化,以便从存储中插入或删除。
  • 在获取所有者暂缺(因此也没有价格)的域名时,返回1mycoin作为价格。

最后需要在./x/nameservice/keeper.go文件中加上Keeper的构造函数:

// NewKeeper creates new instances of the nameservice Keeper
func NewKeeper(coinKeeper bank.Keeper, namesStoreKey sdk.StoreKey, ownersStoreKey sdk.StoreKey, priceStoreKey sdk.StoreKey, cdc *codec.Codec) Keeper {
    return Keeper{
        coinKeeper:     coinKeeper,
        namesStoreKey:  namesStoreKey,
        ownersStoreKey: ownersStoreKey,
        pricesStoreKey: priceStoreKey,
        cdc:            cdc,
    }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,907评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,987评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,298评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,586评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,633评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,488评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,275评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,176评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,619评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,819评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,932评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,655评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,265评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,871评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,994评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,095评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,884评论 2 354

推荐阅读更多精彩内容