Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Readme update links to binaries #4806

Merged
merged 6 commits into from
Jul 26, 2023
Merged

Readme update links to binaries #4806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3a1bea1
make binaries and chainspec easier to find
mnaamani Jul 20, 2023
65303f5
exclude docs from code shasum calculation
mnaamani Jul 20, 2023
b6ae1be
drop any remaining ref to joystream testnet
mnaamani Jul 20, 2023
e0e8022
Merge branch 'master' into readme-links-to-binaries
mnaamani Jul 22, 2023
59df56d
Merge branch 'master' into readme-links-to-binaries
mnaamani Jul 26, 2023
0bff496
drop reference to sudo in runtime readme
mnaamani Jul 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,15 @@ WASM_BUILD_TOOLCHAIN=nightly-2022-05-11 cargo build --release

Learn more about [joystream-node](bin/node/README.md).

A step by step guide to setup a full node and validator on the Joystream testnet, can be found [here](https://joystream.gitbook.io/testnet-workspace/system/validation#validator).
A step by step guide to setup a full node and validator on the Joystream main network, can be found [here](https://handbook.joystream.org/system/validation).

### Pre-built joystream-node binaries
Look under the 'Assets' section:

- Ephesus release [v8.3.0](https://github.com/Joystream/joystream/releases/tag/v12.2001.0)

### Mainnet chainspec file
- [joy-mainnet.json](https://github.com/Joystream/joystream/releases/download/v12.1000.0/joy-mainnet.json)

### Integration tests

Expand Down
9 changes: 5 additions & 4 deletions bin/node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The joystream-node is the main server application that connects to the network,
### Pre-built binaries

The latest pre-built binaries can be downloaded from the [releases](https://github.com/Joystream/joystream/releases) page.
Generally these will be built from `master` branch and will pertain to the currently active testnet.
Generally these will be built from `master` branch and will pertain to the currently active network.

### Building from source

Expand Down Expand Up @@ -42,9 +42,10 @@ this script will build and run a fresh new local development chain (purging exis
./scripts/run-dev-chain.sh
```

### Joystream Public Testnets
### Joystream Public Networks

Use the `--chain` argument, and specify the path to the genesis `chain.json` file for that public network. The JSON "chain spec" files for Joystream public networks can be found in [../testnets/](../testnets/).
Use the `--chain` argument, and specify the path to the genesis `chain.json` file for that public network.
Here is the JSON "chain spec" file for the Joystream mainnet [joy-mainnet.json](../../joy-mainnet.json).

```bash
./target/release/joystream-node --chain joy-mainnet.json
Expand Down Expand Up @@ -81,7 +82,7 @@ This will install the executable `joystream-node` to your `~/.cargo/bin` folder,
WASM_BUILD_TOOLCHAIN=nightly-2022-05-11 cargo +nightly-2022-05-11 install joystream-node --path bin/node/ --locked
```

Now you can run and connect to the testnet:
Now you can run and connect to the network:

```bash
joystream-node --chain joy-mainnet.json
Expand Down
10 changes: 5 additions & 5 deletions runtime/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ When building joystream-node as described in [../bin/node/README.md](../bin/node

### Deployment

Deploying the compiled runtime on a live system can be done in one of two ways:

1. By creating a proposal for upgrading the Joystream runtime, which will then be voted on by the council. If the proposal is approved, the upgrade will go through after a grace period. When the Joystream platform is live, this will be the only way to upgrade the chain's runtime code.

2. By creating an extrinsic (transaction) signed with the sudo key invoking `system::setCode()`. This can be done either from the [polkadot-js/apps](https://polkadot.js.org/apps/) extrinsics tab, or directly with an admin script. This way of upgrading the runtime code is intended for development and testnet phases only.
Deploying the compiled runtime on a live system is done by creating a proposal for upgrading the Joystream runtime, which will then be voted on by the council. If the proposal is approved, the upgrade will go through after a grace period.

### Versioning the runtime

Versioning of the runtime is set in `runtime/src/lib.rs`
For detailed information about how to set correct version numbers when developing a new runtime, [see this](https://github.com/Joystream/joystream/issues/1)

### Contributing

For more details about how to contribute to the runtime check [RUNTIME-CONTRIBUTING.md](../RUNTIME-CONTRIBUTING.md).
1 change: 1 addition & 0 deletions scripts/runtime-code-shasum.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ fi

# sort/owner/group/mtime arguments only work with gnu version of tar!
${TAR} -c --sort=name --owner=root:0 --group=root:0 --mode 644 --mtime='UTC 2020-01-01' \
--exclude='*.md' \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this hash actually referred to anywhere?

Cargo.lock \
Cargo.toml \
runtime \
Expand Down
Loading
Loading