Example SDK Module Tutorial

In this tutorial, you will build a functional Cosmos SDK module, and in the process, learn the basic concepts and structures in the SDK. Then you can get started building your own modules and include them in decentralized applications. By the end of this tutorial you will have a functional nameservice, a mapping of strings to other strings (map[string]string). This is similar to Namecoin, ENS, or Handshake, which all model the traditional DNS systems (map[domain]zonefile). Users will be able to buy unused names, or sell/trade their name.

All of the final source code for this tutorial project is in this directory (and compiles), however, it is best to follow along manually and try building the project yourself!

Requirements:

• golang >1.11 installed
• A working $GOPATH
• Desire to create your own blockchain!

Tutorial Parts:

1. Start by building your Keeper
2. Define interactions with your chain through Msgs and Handlers
   • SetName
   • BuyName
3. Make views on your state machine with Queriers
4. Register your types in the encoding format using sdk.Codec
5. Create CLI interactions for your module
6. Put it all together in ./app.go!
7. Create the nameserviced and nameservicecli entry points
8. Setup dependency management using dep

Build the nameservice application!

If you want to build the nameservice application in this repo to see the functionality, first you need to install dep. Below there is a command for using a shell script from dep's site to preform this install. If you are uncomfortable |ing curl output to sh (you should be) then check out your platform specific installation instructions.

# Install dep
curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh

# Initialize dep and install dependencies
dep init
dep ensure -v -upgrade

# Install the app into your $GOBIN
go install -v ./cmd/...

# Now you should be able to run the following commands:
nameserviced help
nameservicecli help

Running the live network and using the commands with nameservicecli

To initialize configuration and a genesis.json file for your application and an account for the transactions start by running:

NOTE: Copy the Address output here and save it for later use

# Copy the chain_id output here and save it for later use
nameserviced init

# Copy the `Address` output here and save it for later use
nameservicecli keys add jack

Next open the generated file ~/.nameserviced/config/genesis.json in a text editor and copy in the address output by adding a key above. This will give you control over a wallet with some coins when you start your local network. You can now start nameserviced by calling nameserviced start. You will see blocks being produced.

Open another terminal to run commands against the network you have just created:

NOTE: In the below commands --chain-id and accountaddr are pulled using terminal utilities. You can also just input the raw strings saved from bootstrapping the network above. The commands require jq to be installed on your machine.

# First check the account to ensure you have funds
nameservicecli query account $(nameservicecli keys list -o json | jq -r .[0].address) --chain-id $(cat ~/.nameserviced/config/genesis.json | jq -r .chain_id)

# Buy your first name using your coins from the genesis file
nameservicecli tx  buy-name jack.id 5mycoin --from $(nameservicecli keys list -o json | jq -r .[0].address) --chain-id $(cat ~/.nameserviced/config/genesis.json | jq -r .chain_id)

# Set the value for the name you just bought
nameservicecli tx set-name jack.id 8.8.8.8 --from $(nameservicecli keys list -o json | jq -r .[0].address) --chain-id $(cat ~/.nameserviced/config/genesis.json | jq -r .chain_id)

# Try out a resolve query against the name you registered
nameservicecli query resolve jack.id --chain-id $(cat ~/.nameserviced/config/genesis.json | jq -r .chain_id)
# > 8.8.8.8

# Try out a whois query against the name you just registered
nameservicecli query whois jack.id --chain-id $(cat ~/.nameserviced/config/genesis.json | jq -r .chain_id)
# > {"value":"8.8.8.8","owner":"cosmos1l7k5tdt2qam0zecxrx78yuw447ga54dsmtpk2s","price":[{"denom":"mycoin","amount":"5"}]}

Project directory structure

Through the course of this tutorial you will create the following files that make up your application:

./nameservice
├── Gopkg.toml
├── app.go
├── cmd
│   ├── nameservicecli
│   │   └── main.go
│   └── nameserviced
│       └── main.go
└── x
    └── nameservice
        ├── client
        │   └── cli
        │       ├── query.go
        │       └── tx.go
        ├── codec.go
        ├── handler.go
        ├── keeper.go
        ├── msgs.go
        └── querier.go