https://github.com/cosmosregistry/example

Cosmos SDK Module Template
https://github.com/cosmosregistry/example

cosmos-sdk example template

Last synced: 3 months ago
JSON representation

Cosmos SDK Module Template

• Host: GitHub
• URL: https://github.com/cosmosregistry/example
• Owner: cosmosregistry
• Created: 2023-05-26T10:30:25.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-27T23:16:41.000Z (3 months ago)
• Last Synced: 2024-10-28T03:24:25.115Z (3 months ago)
• Topics: cosmos-sdk, example, template
• Language: Go
• Homepage: https://cosmod.xyz
• Size: 363 KB
• Stars: 27
• Watchers: 2
• Forks: 12
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-ccamel - cosmosregistry/example - Cosmos SDK Module Template (Go)
• awesome-cosmos - cosmosregistry/example - Template and example repository of a Cosmos SDK module. (Templates / Terminal Block Explorers)

README

        
> This is an example module for the v0.52.x Cosmos SDK.

> Looking for the v0.50.x example? Check the [v0.50.x branch](https://github.com/cosmosregistry/example/tree/v0.50.x).

# `{Module Name}`

Overview of the module.

## Concepts

Describe specialized concepts and definitions used throughout the spec.

## State

Specify and describe structures expected to marshalled into the store, and their keys

## State Transitions

Standard state transition operations triggered by hooks, messages, etc.

## Messages

Specify message structure(s) and expected state machine behaviour(s).

## Begin Block

Specify any begin-block operations.

## End Block

Specify any end-block operations.

## Hooks

Describe available hooks to be called by/from this module.

## Events

List and describe event tags used.

## Client

List and describe CLI commands and gRPC and REST endpoints.

## Params

List all module parameters, their types (in JSON) and examples.

## Future Improvements

Describe future improvements of this module.

## Tests

Acceptance tests.

## Appendix

Supplementary details referenced elsewhere within the spec.