Skip to content

Commit 3cdfde8

Browse files
update readme: archived repo (#7654)
* Update README.md * Update README.md
1 parent 89fd980 commit 3cdfde8

File tree

1 file changed

+7
-258
lines changed

1 file changed

+7
-258
lines changed

polkadot/README.md

Lines changed: 7 additions & 258 deletions
Original file line numberDiff line numberDiff line change
@@ -1,264 +1,13 @@
1-
# Polkadot
1+
Dear contributors and users,
22

3-
Implementation of a <https://polkadot.network> node in Rust based on the Substrate framework.
3+
We would like to inform you that we have recently made significant changes to our repository structure. In order to streamline our development process and foster better contributions, we have merged three separate repositories Cumulus, Substrate and Polkadot into a single new repository: [the Polkadot SDK](https://github.com/paritytech/polkadot-sdk). Go ahead and make sure to support us by giving a star ⭐️ to the new repo.
44

5-
> **NOTE:** In 2018, we split our implementation of "Polkadot" from its development framework
6-
> "Substrate". See the [Substrate][substrate-repo] repo for git history prior to 2018.
5+
By consolidating our codebase, we aim to enhance collaboration and provide a more efficient platform for future development.
76

8-
[substrate-repo]: https://github.com/paritytech/substrate
7+
If you currently have an open pull request in any of the merged repositories, we kindly request that you resubmit your PR in the new repository. This will ensure that your contributions are considered within the updated context and enable us to review and merge them more effectively.
98

10-
This repo contains runtimes for the Polkadot, Kusama, and Westend networks. The README provides
11-
information about installing the `polkadot` binary and developing on the codebase. For more
12-
specific guides, like how to be a validator, see the
13-
[Polkadot Wiki](https://wiki.polkadot.network/docs/getting-started).
9+
We appreciate your understanding and ongoing support throughout this transition. Should you have any questions or require further assistance, please don't hesitate to [reach out to us](https://forum.polkadot.network/t/psa-parity-is-currently-working-on-merging-the-polkadot-stack-repositories-into-one-single-repository/2883).
1410

15-
## Installation
11+
Best Regards,
1612

17-
If you just wish to run a Polkadot node without compiling it yourself, you may
18-
either run the latest binary from our
19-
[releases](https://github.com/paritytech/polkadot/releases) page, or install
20-
Polkadot from one of our package repositories.
21-
22-
Installation from the Debian repository will create a `systemd`
23-
service that can be used to run a Polkadot node. This is disabled by default,
24-
and can be started by running `systemctl start polkadot` on demand (use
25-
`systemctl enable polkadot` to make it auto-start after reboot). By default, it
26-
will run as the `polkadot` user. Command-line flags passed to the binary can
27-
be customized by editing `/etc/default/polkadot`. This file will not be
28-
overwritten on updating polkadot. You may also just run the node directly from
29-
the command-line.
30-
31-
### Debian-based (Debian, Ubuntu)
32-
33-
Currently supports Debian 10 (Buster) and Ubuntu 20.04 (Focal), and
34-
derivatives. Run the following commands as the `root` user.
35-
36-
```bash
37-
# Import the [email protected] GPG key
38-
gpg --recv-keys --keyserver hkps://keys.mailvelope.com 9D4B2B6EB8F97156D19669A9FF0812D491B96798
39-
gpg --export 9D4B2B6EB8F97156D19669A9FF0812D491B96798 > /usr/share/keyrings/parity.gpg
40-
# Add the Parity repository and update the package index
41-
echo 'deb [signed-by=/usr/share/keyrings/parity.gpg] https://releases.parity.io/deb release main' > /etc/apt/sources.list.d/parity.list
42-
apt update
43-
# Install the `parity-keyring` package - This will ensure the GPG key
44-
# used by APT remains up-to-date
45-
apt install parity-keyring
46-
# Install polkadot
47-
apt install polkadot
48-
49-
```
50-
51-
## Building
52-
53-
### Install via Cargo
54-
55-
Make sure you have the support software installed from the **Build from Source** section
56-
below this section.
57-
58-
If you want to install Polkadot in your PATH, you can do so with:
59-
60-
```bash
61-
cargo install --git https://github.com/paritytech/polkadot --tag <version> polkadot --locked
62-
```
63-
64-
### Build from Source
65-
66-
If you'd like to build from source, first install Rust. You may need to add Cargo's bin directory
67-
to your PATH environment variable. Restarting your computer will do this for you automatically.
68-
69-
```bash
70-
curl https://sh.rustup.rs -sSf | sh
71-
```
72-
73-
If you already have Rust installed, make sure you're using the latest version by running:
74-
75-
```bash
76-
rustup update
77-
```
78-
79-
Once done, finish installing the support software:
80-
81-
```bash
82-
sudo apt install build-essential git clang libclang-dev pkg-config libssl-dev protobuf-compiler
83-
```
84-
85-
Build the client by cloning this repository and running the following commands from the root
86-
directory of the repo:
87-
88-
```bash
89-
git checkout <latest tagged release>
90-
./scripts/init.sh
91-
cargo build --release
92-
```
93-
94-
**Note:** compilation is a memory intensive process. We recommend having 4 GiB of physical RAM or swap available (keep in mind that if a build hits swap it tends to be very slow).
95-
96-
**Note:** if you want to move the built `polkadot` binary somewhere (e.g. into $PATH) you will also need to move `polkadot-execute-worker` and `polkadot-prepare-worker`. You can let cargo do all this for you by running:
97-
98-
```sh
99-
cargo install --path . --locked
100-
```
101-
102-
#### Build from Source with Docker
103-
104-
You can also build from source using
105-
[Parity CI docker image](https://github.com/paritytech/scripts/tree/master/dockerfiles/ci-linux):
106-
107-
```bash
108-
git checkout <latest tagged release>
109-
docker run --rm -it -w /shellhere/polkadot \
110-
-v $(pwd):/shellhere/polkadot \
111-
paritytech/ci-linux:production cargo build --release
112-
sudo chown -R $(id -u):$(id -g) target/
113-
```
114-
115-
If you want to reproduce other steps of CI process you can use the following
116-
[guide](https://github.com/paritytech/scripts#gitlab-ci-for-building-docker-images).
117-
118-
## Networks
119-
120-
This repo supports runtimes for Polkadot, Kusama, and Westend.
121-
122-
### Connect to Polkadot Mainnet
123-
124-
Connect to the global Polkadot Mainnet network by running:
125-
126-
```bash
127-
./target/release/polkadot --chain=polkadot
128-
```
129-
130-
You can see your node on [telemetry] (set a custom name with `--name "my custom name"`).
131-
132-
[telemetry]: https://telemetry.polkadot.io/#list/Polkadot
133-
134-
### Connect to the "Kusama" Canary Network
135-
136-
Connect to the global Kusama canary network by running:
137-
138-
```bash
139-
./target/release/polkadot --chain=kusama
140-
```
141-
142-
You can see your node on [telemetry] (set a custom name with `--name "my custom name"`).
143-
144-
[telemetry]: https://telemetry.polkadot.io/#list/Kusama
145-
146-
### Connect to the Westend Testnet
147-
148-
Connect to the global Westend testnet by running:
149-
150-
```bash
151-
./target/release/polkadot --chain=westend
152-
```
153-
154-
You can see your node on [telemetry] (set a custom name with `--name "my custom name"`).
155-
156-
[telemetry]: https://telemetry.polkadot.io/#list/Westend
157-
158-
### Obtaining DOTs
159-
160-
If you want to do anything on Polkadot, Kusama, or Westend, then you'll need to get an account and
161-
some DOT, KSM, or WND tokens, respectively. See the
162-
[claims instructions](https://claims.polkadot.network/) for Polkadot if you have DOTs to claim. For
163-
Westend's WND tokens, see the faucet
164-
[instructions](https://wiki.polkadot.network/docs/learn-DOT#getting-westies) on the Wiki.
165-
166-
## Hacking on Polkadot
167-
168-
If you'd actually like to hack on Polkadot, you can grab the source code and build it. Ensure you have
169-
Rust and the support software installed. This script will install or update Rust and install the
170-
required dependencies (this may take up to 30 minutes on Mac machines):
171-
172-
```bash
173-
curl https://getsubstrate.io -sSf | bash -s -- --fast
174-
```
175-
176-
Then, grab the Polkadot source code:
177-
178-
```bash
179-
git clone https://github.com/paritytech/polkadot.git
180-
cd polkadot
181-
```
182-
183-
Then build the code. You will need to build in release mode (`--release`) to start a network. Only
184-
use debug mode for development (faster compile times for development and testing).
185-
186-
```bash
187-
./scripts/init.sh # Install WebAssembly. Update Rust
188-
cargo build # Builds all native code
189-
```
190-
191-
You can run the tests if you like:
192-
193-
```bash
194-
cargo test --workspace --release
195-
```
196-
197-
You can start a development chain with:
198-
199-
```bash
200-
cargo build
201-
cargo run -- --dev
202-
```
203-
204-
Detailed logs may be shown by running the node with the following environment variables set:
205-
206-
```bash
207-
RUST_LOG=debug RUST_BACKTRACE=1 cargo run -- --dev
208-
```
209-
210-
### Development
211-
212-
You can run a simple single-node development "network" on your machine by running:
213-
214-
```bash
215-
polkadot --dev
216-
```
217-
218-
You can muck around by heading to <https://polkadot.js.org/apps> and choose "Local Node" from the
219-
Settings menu.
220-
221-
### Local Two-node Testnet
222-
223-
If you want to see the multi-node consensus algorithm in action locally, then you can create a
224-
local testnet. You'll need two terminals open. In one, run:
225-
226-
```bash
227-
polkadot --chain=polkadot-local --alice -d /tmp/alice
228-
```
229-
230-
And in the other, run:
231-
232-
```bash
233-
polkadot --chain=polkadot-local --bob -d /tmp/bob --port 30334 --bootnodes '/ip4/127.0.0.1/tcp/30333/p2p/ALICE_BOOTNODE_ID_HERE'
234-
```
235-
236-
Ensure you replace `ALICE_BOOTNODE_ID_HERE` with the node ID from the output of the first terminal.
237-
238-
### Monitoring
239-
240-
[Setup Prometheus and Grafana](https://wiki.polkadot.network/docs/maintain-guides-how-to-monitor-your-node).
241-
242-
Once you set this up you can take a look at the [Polkadot Grafana dashboards](grafana/README.md) that we currently maintain.
243-
244-
### Using Docker
245-
246-
[Using Docker](doc/docker.md)
247-
248-
### Shell Completion
249-
250-
[Shell Completion](doc/shell-completion.md)
251-
252-
## Contributing
253-
254-
### Contributing Guidelines
255-
256-
[Contribution Guidelines](CONTRIBUTING.md)
257-
258-
### Contributor Code of Conduct
259-
260-
[Code of Conduct](CODE_OF_CONDUCT.md)
261-
262-
## License
263-
264-
Polkadot is [GPL 3.0 licensed](LICENSE).
13+
Parity Technologies

0 commit comments

Comments
 (0)