simapp

package module
v0.0.0-...-ffce332 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 23, 2025 License: MPL-2.0 Imports: 119 Imported by: 0

README

Chain

Chain is based on the ibc-go SimApp, and always will be. This will allow teams to test the latest and greatest of:

  • Cosmos-SDK
  • IBC-GO
  • Comet-BFT

in an approchable and minimal format. We're also satisfying a the spec requirements for a wyoming dao.

Chain is a CLI application built using the Cosmos SDK for testing and educational purposes.

Wyoming DAO Compatibility

Chain implements a Wyoming DAO.

The Cosmos SDK provides the foundational blockchain infrastructure that satisfies these requirements without requiring additional smart contract platforms like CosmWasm. Here's how Chain's architecture maps to the Wyoming DAO specifications:

Blockchain Requirements (W.S. 34-29-106(g)(i))

Cosmos SDK provides a complete blockchain framework that meets Wyoming's definition of a blockchain as a "digital ledger of transactions." Chain inherits these properties:

  • Immutable transaction records
  • Cryptographically secured blocks
  • Decentralized consensus mechanism via Comet BFT
Smart Contract Requirements (W.S. 17-31-102(a)(ix))

While Chain doesn't use a separate smart contract platform, Cosmos SDK modules themselves function as "smart contracts" under Wyoming's definition:

  • Governance Module: Functions as the automated transaction system for "administrating membership interest votes"
  • Bank Module: Handles the "taking custody of and transferring" of digital assets
  • Staking Module: Manages delegation relationships via code executed on the blockchain

Each of these modules executes deterministic code based on conditions specified in transactions, meeting the core definition of smart contracts.

Management Structure (W.S. 17-31-109)

Cosmos SDK's governance module fully satisfies the requirement that "Management of a decentralized autonomous organization shall be vested in its members." Specifically:

  • Token holders (members) submit and vote on proposals
  • Proposals execute automatically when passed
  • Governance parameters can be adjusted through the governance process itself
Upgradability (W.S. 17-31-109)

The Cosmos SDK upgrade module ensures all chain code can be "updated, modified or otherwise upgraded" as required by Wyoming law:

  • Governance proposals can include software upgrades
  • Approved upgrades execute automatically at predetermined heights
  • Ensures continuity while allowing evolution of the organization
Membership Interests and Voting (W.S. 17-31-111)

The bank module tracks token ownership, which represents membership interests:

  • Each token holder's voting power is proportional to their token balance
  • The governance module enforces voting periods and tallying
  • Delegation allows token holders to participate via trusted representatives
Transparency (W.S. 17-31-112)

As an "open blockchain," Chain ensures all records are publicly accessible:

  • Transaction history is transparent and immutable
  • Token ownership is publicly verifiable
  • Governance proposals and votes are publicly recorded
Withdrawal of Members (W.S. 17-31-113)

Token holders can freely transfer their tokens, effectively implementing withdrawal:

  • Members can transfer, sell, or alienate their tokens at any time
  • This satisfies W.S. 17-31-113(d)(ii) for member withdrawal
Dissolution Mechanisms (W.S. 17-31-114)

Governance proposals can implement any of the dissolution events specified in Wyoming law:

  • A governance proposal can halt the chain
  • If activity ceases for a year, it meets the legal condition for dissolution
  • Chain governance can implement time-based or condition-based termination

To fully comply with Wyoming DAO requirements, Chain must be registered as a Wyoming LLC with articles of organization that include the required notices and statements. The actual blockchain serves as the technical implementation of the DAO's operations.

Running Testnets with chain

Want to spin up a quick testnet with your friends? Follow these steps. Unless stated otherwise, all participants in the testnet must follow through with each step.

1. Download and Setup

Download IBC-go and unzip it. You can do this manually (via the GitHub UI) or with the git clone command:

git clone github.com/cosmos/ibc-go.git

Next, run this command to build the chaind binary in the build directory:

make build

Use the following command and skip all the next steps to configure your Chain node:

make init-chain

If you've run chaind in the past, you may need to reset your database before starting up a new testnet. You can do that with this command:

# you need to provide the moniker and chain ID
$ ./chaind init [moniker] --chain-id [chain-id]

The command should initialize a new working directory at the ~/.chain location. The moniker and chain-id can be anything, but you must use the same chain-id subsequently.

2. Create a New Key

Execute this command to create a new key:

 ./chaind keys add [key_name]

⚠️ The command will create a new key with your chosen name. Save the output somewhere safe; you'll need the address later.

3. Add Genesis Account

Add a genesis account to your testnet blockchain:

./chaind genesis add-genesis-account [key_name] [amount]

Where key_name is the same key name as before, and the amount is something like 10000000000000000000000000stake.

4. Add the Genesis Transaction

This creates the genesis transaction for your testnet chain:

./chaind genesis gentx [key_name] [amount] --chain-id [chain-id]

The amount should be at least 1000000000stake. Providing too much or too little may result in errors when you start your node.

5. Create the Genesis File

A participant must create the genesis file genesis.json with every participant's transaction. You can do this by gathering all the Genesis transactions under config/gentx and then executing this command:

./chaind genesis collect-gentxs

The command will create a new genesis.json file that includes data from all the validators. We sometimes call this the "super genesis file" to distinguish it from single-validator genesis files.

Once you've received the super genesis file, overwrite your original genesis.json file with the new super genesis.json.

Modify your config/config.toml (in the chain working directory) to include the other participants as persistent peers:

# Comma-separated list of nodes to keep persistent connections to
persistent_peers = "[validator_address]@[ip_address]:[port],[validator_address]@[ip_address]:[port]"

You can find validator_address by executing:

./chaind comet show-node-id

The output will be the hex-encoded validator_address. The default port is 26656.

6. Start the Nodes

Finally, execute this command to start your nodes:

./chaind start

Now you have a small testnet that you can use to try out changes to the Cosmos SDK or CometBFT!

⚠️ NOTE: Sometimes, creating the network through the collect-gentxs will fail, and validators will start in a funny state (and then panic).

If this happens, you can try to create and start the network first with a single validator and then add additional validators using a create-validator transaction.

Conclusion

A good phone with:

  1. Changing hardware addresses
  2. encrypted storage
  3. anonymous data access

Would be the core of a nation of sovereigns who fulfill the requirements recognized in U.S. and International law as legitimate.

Terms of service reflect the tenets of that nation. The tenets of said nation are:

  1. innocent until proven guilty
  2. property rights shall not be infringed upon
  3. no injured natural man or woman, no crime
  4. innocent until proven guilty

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// DefaultNodeHome default home directories for the application daemon.
	DefaultNodeHome string
)

Functions

func BlockedAddresses

func BlockedAddresses() map[string]bool

BlockedAddresses returns all the app's blocked account addresses.

func GetMaccPerms

func GetMaccPerms() map[string][]string

GetMaccPerms returns a copy of the module account permissions

NOTE: This is solely to be used for testing purposes.

func NewAnteHandler

func NewAnteHandler(options HandlerOptions) (sdk.AnteHandler, error)

NewAnteHandler returns an AnteHandler that checks and increments sequence numbers, checks signatures & account numbers, and deducts fees from the first signer.

Types

type GenesisState

type GenesisState map[string]json.RawMessage

GenesisState of the blockchain is represented here as a map of raw json messages key'd by an identifier string. The identifier is used to determine which module genesis information belongs to so it may be appropriately routed during init chain. Within this application default genesis information is retrieved from the ModuleBasicManager which populates json from each BasicModule object provided to it during init.

type HandlerOptions

type HandlerOptions struct {
	ante.HandlerOptions
	CircuitKeeper circuitante.CircuitBreaker
	IBCKeeper     *keeper.Keeper
}

HandlerOptions are the options required for constructing a default SDK AnteHandler.

type SimApp

type SimApp struct {
	*baseapp.BaseApp

	// keepers
	AccountKeeper         authkeeper.AccountKeeper
	BankKeeper            bankkeeper.Keeper
	StakingKeeper         *stakingkeeper.Keeper
	SlashingKeeper        slashingkeeper.Keeper
	MintKeeper            mintkeeper.Keeper
	DistrKeeper           distrkeeper.Keeper
	GovKeeper             govkeeper.Keeper
	CrisisKeeper          *crisiskeeper.Keeper
	UpgradeKeeper         *upgradekeeper.Keeper
	ParamsKeeper          paramskeeper.Keeper
	AuthzKeeper           authzkeeper.Keeper
	IBCKeeper             *ibckeeper.Keeper // IBC Keeper must be a pointer in the app, so we can SetRouter on it correctly
	ICAControllerKeeper   icacontrollerkeeper.Keeper
	ICAHostKeeper         icahostkeeper.Keeper
	EvidenceKeeper        evidencekeeper.Keeper
	TransferKeeper        ibctransferkeeper.Keeper
	FeeGrantKeeper        feegrantkeeper.Keeper
	GroupKeeper           groupkeeper.Keeper
	ConsensusParamsKeeper consensusparamkeeper.Keeper
	CircuitKeeper         circuitkeeper.Keeper

	// the module manager
	ModuleManager      *module.Manager
	BasicModuleManager module.BasicManager
	// contains filtered or unexported fields
}

SimApp extends an ABCI application, but with most of its parameters exported. They are exported for convenience in creating helper functions.

func NewSimApp

func NewSimApp(
	logger log.Logger,
	db dbm.DB,
	traceStore io.Writer,
	loadLatest bool,
	appOpts servertypes.AppOptions,
	baseAppOptions ...func(*baseapp.BaseApp),
) *SimApp

NewSimApp returns a reference to an initialized SimApp.

func (*SimApp) AppCodec

func (app *SimApp) AppCodec() codec.Codec

AppCodec returns SimApp's app codec.

NOTE: This is solely to be used for testing purposes as it may be desirable for modules to register their own custom testing types.

func (*SimApp) AutoCliOpts

func (app *SimApp) AutoCliOpts() autocli.AppOptions

AutoCliOpts returns the autocli options for the app.

func (*SimApp) BeginBlocker

func (app *SimApp) BeginBlocker(ctx sdk.Context) (sdk.BeginBlock, error)

BeginBlocker application updates every begin block.

func (*SimApp) Configurator

func (app *SimApp) Configurator() module.Configurator

Configurator returns the configurator for the app.

func (*SimApp) DefaultGenesis

func (app *SimApp) DefaultGenesis() map[string]json.RawMessage

DefaultGenesis returns a default genesis from the registered AppModuleBasic's.

func (*SimApp) EndBlocker

func (app *SimApp) EndBlocker(ctx sdk.Context) (sdk.EndBlock, error)

EndBlocker application updates every end block.

func (*SimApp) ExportAppStateAndValidators

func (app *SimApp) ExportAppStateAndValidators(
	forZeroHeight bool, jailAllowedAddrs []string, modulesToExport []string,
) (servertypes.ExportedApp, error)

ExportAppStateAndValidators exports the state of the application for a genesis file.

func (*SimApp) GetKey

func (app *SimApp) GetKey(storeKey string) *storetypes.KVStoreKey

GetKey returns the KVStoreKey for the provided store key.

NOTE: This is solely to be used for testing purposes.

func (*SimApp) GetStoreKeys

func (app *SimApp) GetStoreKeys() []storetypes.StoreKey

GetStoreKeys returns all the stored store keys.

func (*SimApp) GetSubspace

func (app *SimApp) GetSubspace(moduleName string) paramstypes.Subspace

GetSubspace returns a param subspace for a given module name.

NOTE: This is solely to be used for testing purposes.

func (*SimApp) InitChainer

func (app *SimApp) InitChainer(ctx sdk.Context, req *abci.InitChainRequest) (*abci.InitChainResponse, error)

InitChainer application update at chain initialization.

func (*SimApp) InterfaceRegistry

func (app *SimApp) InterfaceRegistry() types.InterfaceRegistry

InterfaceRegistry returns SimApp's InterfaceRegistry.

func (*SimApp) LegacyAmino

func (app *SimApp) LegacyAmino() *codec.LegacyAmino

LegacyAmino returns SimApp's amino codec.

NOTE: This is solely to be used for testing purposes as it may be desirable for modules to register their own custom testing types.

func (*SimApp) LoadHeight

func (app *SimApp) LoadHeight(height int64) error

LoadHeight loads a particular height.

func (*SimApp) Name

func (app *SimApp) Name() string

Name returns the name of the App.

func (*SimApp) PreBlocker

func (app *SimApp) PreBlocker(ctx sdk.Context, _ *abci.FinalizeBlockRequest) (*sdk.ResponsePreBlock, error)

PreBlocker application updates every pre block.

func (*SimApp) RegisterAPIRoutes

func (app *SimApp) RegisterAPIRoutes(apiSvr *api.Server, apiConfig config.APIConfig)

RegisterAPIRoutes registers all application module routes with the provided API server.

func (*SimApp) RegisterNodeService

func (app *SimApp) RegisterNodeService(clientCtx client.Context, cfg config.Config)

func (*SimApp) RegisterTendermintService

func (app *SimApp) RegisterTendermintService(clientCtx client.Context)

RegisterTendermintService implements the Application.RegisterTendermintService method.

func (*SimApp) RegisterTxService

func (app *SimApp) RegisterTxService(clientCtx client.Context)

RegisterTxService implements the Application.RegisterTxService method.

func (*SimApp) SimulationManager

func (app *SimApp) SimulationManager() *module.SimulationManager

SimulationManager implements the SimulationApp interface.

func (*SimApp) TxConfig

func (app *SimApp) TxConfig() client.TxConfig

TxConfig returns SimApp's TxConfig.

Directories

Path Synopsis
cmd
Package params defines the simulation parameters in the simapp.
Package params defines the simulation parameters in the simapp.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL