Skip to content

Commit

Permalink
refactor(docs): nits
Browse files Browse the repository at this point in the history
  • Loading branch information
Reecepbcups committed Nov 7, 2024
1 parent 46f57c7 commit 0ac33a6
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 18 deletions.
2 changes: 1 addition & 1 deletion docs/docs/00-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ slug: /
sidebar_position: 0
---

# Unreleased Docs Here
# Unreleased
9 changes: 3 additions & 6 deletions docs/versioned_docs/version-v0.50.x/00-meet-spawn.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,16 @@ title: Meet Spawn
sidebar_label: "Spawn Documentation"
---

Spawn is the easiest way to build, maintain and scale a Cosmos SDK blockchain. Spawn solves all the key pain points engineers face when building new Cosmos-SDK networks.
Spawn is the easiest way to build, maintain and scale an Interchain blockchain. Spawn solves all the key pain points engineers face when building Interchain networks.
- **Tailor-fit**: Pick and choose modules to create a network for your needs.
- **Commonality**: Use native Cosmos tools and standards you're already familiar with.
- **Commonality**: Use native Interchain tools and standards you're already familiar with.
- **Integrations**: Github actions and end-to-end testing are configured right from the start.
- **Iteration**: Quickly test between your new chain and established networks like the local Cosmos-Hub devnet.
- **Iteration**: Quickly test between your new chain and established networks as a devnet.

## NameService Demo

[Follow Along with the NameService demo](./02-build-your-application/01-nameservice.md)

<video src="https://github.com/rollchains/spawn/assets/31943163/ecc21ce4-c42c-4ff2-8e73-897c0ede27f0" width="100%" height="100%" controls></video>


## Testimonials

> "Spawn is a marked transformation in CosmosSDK protocol development, allowing scaffolding and upgrading from 0.47 to 0.50 to be achievable and understandable. Without the tool, this would have been a dedicated multi-month effort" - Ash, [Burnt.com](https://twitter.com/burnt_xion)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ slug: /build/name-service
# Overview

:::note Synopsis
Building your first Cosmos-SDK blockchain with Spawn. This tutorial focuses on a 'nameservice' where you set your account to a name you choose.
Building your first Interchain blockchain with Spawn. This tutorial focuses on a 'nameservice' where you set your account to a name you choose.

* Generating a new chain
* Creating a new module
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ slug: /build/name-service-client

# Command Line Client

Using the Cosmos-SDKs AutoCLI, you will easily set up the CLI client for transactions and queries.
Using the AutoCLI, you will easily set up the CLI client for transactions and queries.

### Query

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ slug: /demo/ibc

# IBC Demo

In this tutorial, we'll create and interact with a new Cosmos-SDK blockchain called "rollchain", with the token denomination "uroll". This chain has tokenfactory and Proof of Authority, but we'll disable cosmwasm.
In this tutorial, we'll create and interact with a new Interchain blockchain called "rollchain", with the token denomination "uroll". This chain has tokenfactory and Proof of Authority, but we'll disable cosmwasm.

## Prerequisites
- [System Setup](../01-setup/01-system-setup.md)
Expand Down Expand Up @@ -74,7 +74,7 @@ rolld tx ibc-transfer transfer transfer channel-0 cosmos1hj5fveer5cjtn4wd6wstzug
# Query the other side to confirm it went through
sleep 10

# Interact with the other chain without having to install the cosmos binary
# Interact with the other chain without having to install the binary
# - Endpoints found at: GET http://127.0.0.1:8080/info
# - make get-localic
local-ic interact localcosmos-1 query 'bank balances cosmos1hj5fveer5cjtn4wd6wstzugjfdxzl0xpxvjjvr'
Expand All @@ -91,4 +91,4 @@ gh repo create rollchain --source=. --remote=upstream --push --private
## Conclusion

In this tutorial, you configured a new custom chain, launched a testnet for it, tested a cross chain token transfer, and confirmed it was successful. This tutorial demonstrates just how easy it is to create a brand new custom Cosmos-SDK blockchain from scratch with spawn.
In this tutorial, you configured a new custom chain, launched a testnet for it, tested a cross chain token transfer, and confirmed it was successful. This tutorial demonstrates just how easy it is to create a new Interchain blockchain from scratch with spawn.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ slug: /demo/cw-validator-reviews

# CosmWasm Validator Reviews

You will build a new chain with [CosmWasm](https://cosmwasm.com), enabling a proof-of-stake validator review system. You will write a contract to collect and manage validator reviews, integrate it with the chain, and update validator data automatically through a Cosmos-SDK endblocker module.
You will build a new chain with [CosmWasm](https://cosmwasm.com), enabling a proof-of-stake validator review system. You will write a contract to collect and manage validator reviews, integrate it with the chain, and update validator data automatically through the Cosmos-SDK endblocker module.

There are easy ways to get validators in a cosmwasm smart contract. The goal of this tutorial is to teach how to pass data from the SDK to a contract.

Expand Down Expand Up @@ -34,7 +34,7 @@ spawn new rollchain \
# move into the chain directory
cd rollchain

# Generate the Cosmos-SDK reviews module
# Generate the reviews module
spawn module new reviews

# build the proto to code
Expand Down Expand Up @@ -64,7 +64,7 @@ code validator-reviews-contract/

The contract state and base structure is set in the state.rs file. There are 2 groups of data that must be managed, validators and the reviews for validators.

- `Validators` have unique addresses and name stored on the chain. This data will be passed from the Cosmos-SDK to the contract.
- `Validators` have unique addresses and name stored on the chain. This data will be passed from the SDK to the contract.
- `Reviews` will save a user wallets address and their text reviews for a validator.

```rust title="src/state.rs"
Expand Down Expand Up @@ -95,7 +95,7 @@ By default contracts get 3 messages, `InstantiateMsg`, `ExecuteMsg`, and `QueryM
- **Execute** is where the main logic of the contract is. Add a `WriteReview` message to allow users to write reviews. The user must know who they want to write a review for and what it says.
- **Query** is for reading data from the contract. Add 2 queries, one to get all validators available and one to get reviews for a specific validator.

The `SudoMsg` is a default type not typically used. `Sudo` stands for `Super User DO` where the super user is the chain. **Only** the chain can submit data to this message type. A `SetValidators` message is added to allow the chain to update the validators list within the contract. This is the pass through from the Cosmos-SDK to the contract.
The `SudoMsg` is a default type not typically used. `Sudo` stands for `Super User DO` where the super user is the chain. **Only** the chain can submit data to this message type. A `SetValidators` message is added to allow the chain to update the validators list within the contract. This is the pass through from the SDK to the contract.

```rust title="src/msg.rs"
use cosmwasm_schema::{cw_serde, QueryResponses};
Expand Down Expand Up @@ -288,7 +288,7 @@ The .wasm file is then saved to `./artifacts/validator_reviews_contract.wasm`.

## Modify the Module

The contract is complete but we need to pass the data into the contract from the chain. This is done through the cosmos-sdk reviews module generated earlier. The module will be updated to include the wasm contract and the endblocker will be updated to pass the validator data to the contract.
The contract is complete but we need to pass the data into the contract from the chain. This is done through the sdk reviews module generated earlier. The module will be updated to include the wasm contract and the endblocker will be updated to pass the validator data to the contract.

### Setup the Keeper

Expand Down Expand Up @@ -360,7 +360,7 @@ func SetupTest(t *testing.T) *testFixture

### Dependency Inject (v2)

Similar to the keeper_test issue, CosmWasm does not have support for Cosmos-SDK v2 depinject. This will be updated in the future. For now, set the keeper to nil and provide Staking reference. You do not need to know what this does. Just resolve the error on the line with a copy paste.
Similar to the keeper_test issue, CosmWasm does not have support for SDK v2 depinject. This will be updated in the future. For now, set the keeper to nil and provide Staking reference. You do not need to know what this does. Just resolve the error on the line with a copy paste.

```go title="x/reviews/depinject.go"
func ProvideModule(in ModuleInputs) ModuleOutputs {
Expand Down

0 comments on commit 0ac33a6

Please sign in to comment.