wormhole/wormchain
Jeff Schroeder b175dd43c8
docs: quit the spelling spam typo fix PRs with cspell magic (#3845)
* Add cspell configuration and custom dictionary

The goal is to cut down on both incoming tyops, and well meaning but
spammy tyop fix PRs.

To run cspell locally install it and run:

    cspell '**/*.md' \
        --config cspell.config.yaml \
        --words-only \
        --unique \
        --quiet | sort --ignore-case

* docs: cspell updates

* wormchain: cspell updates

* aptos: cspell updates

* node: cspell updates

* algorand: cspell updates

* whitepapers: cspell updates

* near: cspell updates

* solana: cspell updates

* terra: cspell updates

* cosmwasm: cspell updates

* ethereum: cspell updates

* clients: cspell updates

* cspell updates for DEVELOP document

* github: run cspell github action

* sdk: cspell updates

* github: only run cspell on markdown files

* algorand: EMMITTER --> EMITTER

Suggested-by: @evan-gray

* cspell: removed from dictionary

Suggested-by: @evan-gray

* aptos and node: cspell updates

Suggested-by: @evan-gray

* cosmowasm: doc updates for terra2

Suggested-by: @evan-gray

* algorand: cspell updates

Suggested-by: @evan-gray

* algorand: cspell updates

Suggested-by: @evan-gray

* cspell: updated custom word dictionary

This resorts the dictionary and adds a few new words from the
algorand/MEMORY.md document around varints and integers.

* cspell: sort the dictionary how vscode does it

On macOS the sorting is locale dependent. To do this on macOS, you have
to invert the case, do a character insensitive sort, and then invert the
case again:

    LC_COLLATE="en_US.UTF-8" cspell '**/*.md' --config cspell.config.yaml \
        --words-only \
        --unique \
        --no-progress \
        --quiet \
    | tr 'a-zA-Z' 'A-Za-z' \
    | sort --ignore-case \
    | tr 'a-zA-Z' 'A-Za-z'

This requires the `LC_COLLATE` variable to be set to `en_US.UTF-8`, or it
will not do the right thing.

* docs: grammar clean up

---------

Co-authored-by: Evan Gray <battledingo@gmail.com>
2024-03-20 15:40:02 -04:00
..
.vscode rename all wormholechain and wormhole-chain references 2022-10-24 17:59:52 -04:00
app wormchain: rename v2.22.0 upgrade to v2.23.0 upgrade 2023-08-16 21:14:18 -04:00
build wormchain - config comments and defaults 2023-01-27 14:03:02 -05:00
cmd/wormchaind rename all wormholechain and wormhole-chain references 2022-10-24 17:59:52 -04:00
contracts/tools Tilt: Gateway deployment 2024-03-18 10:51:32 -04:00
design docs: quit the spelling spam typo fix PRs with cspell magic (#3845) 2024-03-20 15:40:02 -04:00
devnet docs: quit the spelling spam typo fix PRs with cspell magic (#3845) 2024-03-20 15:40:02 -04:00
docs docs: quit the spelling spam typo fix PRs with cspell magic (#3845) 2024-03-20 15:40:02 -04:00
ibc-relayer upgrade to golang 1.19.9 2023-05-04 07:22:38 -07:00
mainnet wormchain: add more persistent peers to wormchain 2023-01-24 08:25:14 -08:00
proto wormchain: setparams gov vaa (#3285) 2023-08-14 20:37:50 -04:00
testing/js rename all wormholechain and wormhole-chain references 2022-10-24 17:59:52 -04:00
testnet wormchain: add testnet files 2023-05-12 06:16:53 -04:00
testutil Instantiate allowlist (#3181) 2023-08-07 11:18:40 -07:00
ts-sdk sdk/wormchain: regen and initial release 2023-11-17 09:43:17 -05:00
x docs: quit the spelling spam typo fix PRs with cspell magic (#3845) 2024-03-20 15:40:02 -04:00
.gitignore wormchain: contracts env data (#2297) 2023-01-27 14:27:21 -05:00
Dockerfile upgrade to golang 1.19.9 2023-05-04 07:22:38 -07:00
Dockerfile.deploy tilt: remove additional root CA support 2023-12-12 14:22:05 -06:00
Dockerfile.proto wormchain: add ibc-composability-mw to gateway (#3273) 2023-08-14 10:49:02 -04:00
Makefile wormchain: dont remove v in tag name for release 2023-03-15 11:59:31 -05:00
README.md wormchain: address comments on wormchain allowlisting 2023-01-31 10:37:53 -06:00
development.md docs: fix typos with spell checker 2023-12-21 15:24:20 -06:00
go.mod wormchain: add PFM (#3271) 2023-08-11 10:16:10 -04:00
go.sum wormchain: add PFM (#3271) 2023-08-11 10:16:10 -04:00
syncing.md Update syncing.md 2024-02-07 16:25:02 -05:00

README.md

Wormchain

Wormchain is a blockchain built using Cosmos SDK and Tendermint and initially created with Ignite.

Building

Build and install wormchain. You will need golang version 1.16+ installed.

make build/wormchaind

Develop

See development.md

How to run the tests

run "tilt up -- --wormchain"
cd ./ts-sdk
npm ci
npm run build
cd ../testing/js
npm ci
npm run test

Learn more about Cosmos & Ignite

Allowlists

Accounts on wormchain are allowlisted. To be able to submit a tx on wormchain, you must have an account that is either:

  • A validator on wormchain that is part of a current or future guardian set, or
  • An account that is allowlisted by a current validator on wormchain.

To create or delete an allowlist entry, you use a validator account. Allowlist entries can become stale, meaning the owning validators are no longer part of the validator set. Any validator can delete or replace stale entries. To manage allowlists, use the wormchaind client.