Skip to content

Commit

Permalink
Fix spec docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ulbqb committed Jan 28, 2024
1 parent 98018f1 commit 1fc4047
Show file tree
Hide file tree
Showing 10 changed files with 32 additions and 99 deletions.
32 changes: 32 additions & 0 deletions x/stakingplus/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
sidebar_position: 1
---

# `x/stakingplus`

## Abstract

This paper specifies the Staking Plus module of the Finschia-sdk, which extends existing [Staking module](https://github.com/cosmos/cosmos-sdk/blob/v0.50.2/x/staking/README.md) of the Cosmos-SDK.

The module enables Finschia-sdk based blockchain to support an advanced Proof-of-Stake system. In this system, holders of the native staking token of the chain can become validators and can delegate tokens to validators, ultimately determining the effective validator set for the system.

This module is almost identical to the previous Staking module of the Cosmos-SDK, but introduces some breaking changes. For example, you must have x/foundation UpdateValidatorAuthsProposal passed before sending x/stakingplus MsgCreateValidator, or the message would fail.

In this document, we describe only the changes introduced by Finschia-SDK. Refer to the [original document](https://github.com/cosmos/cosmos-sdk/blob/v0.50.2/x/staking/README.md) for more information.

# Messages

## Msg/CreateValidator

A validator is created using the `Msg/CreateValidator` service message.

+++ https://github.com/cosmos/cosmos-sdk/blob/v0.50.2/proto/cosmos/staking/v1beta1/tx.proto#L20-L21

+++ https://github.com/cosmos/cosmos-sdk/blob/v0.50.2/proto/cosmos/staking/v1beta1/tx.proto#L50-L73

This service message is expected to fail if:

- one of the conditions described in the staking module of the Cosmos-SDK is met.
- the operator address is not registered on x/foundation through UpdateValidatorAuthsProposal. TODO: add a ref to x/foundation spec file.

The other [statements](https://github.com/cosmos/cosmos-sdk/blob/v0.50.2/x/staking/README.md#msgcreatevalidator) on this message in the exising document are still valid.
7 changes: 0 additions & 7 deletions x/stakingplus/spec/01_state.md

This file was deleted.

7 changes: 0 additions & 7 deletions x/stakingplus/spec/02_state_transitions.md

This file was deleted.

22 changes: 0 additions & 22 deletions x/stakingplus/spec/03_messages.md

This file was deleted.

7 changes: 0 additions & 7 deletions x/stakingplus/spec/04_begin_block.md

This file was deleted.

7 changes: 0 additions & 7 deletions x/stakingplus/spec/05_end_block.md

This file was deleted.

7 changes: 0 additions & 7 deletions x/stakingplus/spec/06_hooks.md

This file was deleted.

7 changes: 0 additions & 7 deletions x/stakingplus/spec/07_events.md

This file was deleted.

7 changes: 0 additions & 7 deletions x/stakingplus/spec/08_params.md

This file was deleted.

28 changes: 0 additions & 28 deletions x/stakingplus/spec/README.md

This file was deleted.

0 comments on commit 1fc4047

Please sign in to comment.