Skip to content

Commit b0f1ace

Browse files
jincan39anaye1997
andauthored
feat: atlantic collator (#201)
* update: manta collator docs * feat: calamari collation * chore: rewards * 📝 update manta collators docs Signed-off-by: Anathan (Ana) Ye <[email protected]> * 📝 update manta collators docs Signed-off-by: Anathan (Ana) Ye <[email protected]> * update: review * 📝 update manta collators docs Signed-off-by: Anathan (Ana) Ye <[email protected]> * 📝 update manta collators docs Signed-off-by: Anathan (Ana) Ye <[email protected]> * 📝 update manta collators docs Signed-off-by: Anathan (Ana) Ye <[email protected]> * 📝 update manta collators docs Signed-off-by: Anathan (Ana) Ye <[email protected]> * 📝 update manta collators docs Signed-off-by: Anathan (Ana) Ye <[email protected]> * 📝 update manta collators docs Signed-off-by: Anathan (Ana) Ye <[email protected]> * chore: rm unnecessary files --------- Signed-off-by: Anathan (Ana) Ye <[email protected]> Signed-off-by: Chan J <[email protected]> Co-authored-by: Anathan (Ana) Ye <[email protected]>
1 parent 7396f9b commit b0f1ace

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+1226
-757
lines changed

docs/concepts/TrustedSetup.md

-82
This file was deleted.

docs/learn/MantaPayWalletSpec.md

-3
This file was deleted.

docs/learn/Papers.md

-5
This file was deleted.

docs/learn/Spec.md

-5
This file was deleted.

docs/learn/ZkpChallenge.md

-76
This file was deleted.

docs/learn/resources/decryption-full.png

-3
This file was deleted.

docs/learn/resources/encryption-full.png

-3
This file was deleted.

docs/learn/resources/generalized-protocol.png

-3
This file was deleted.

docs/learn/resources/my-crypto-1.png

-3
This file was deleted.

docs/learn/resources/my-crypto-2.png

-3
This file was deleted.

docs/learn/resources/polakdot-submit.png

-3
This file was deleted.

docs/learn/resources/receive-protocol.png

-3
This file was deleted.

docs/learn/resources/send-protocol.png

-3
This file was deleted.
-132 Bytes
Binary file not shown.

docs/learn/resources/tech-talk-1-thumbnail.jpg

-3
This file was deleted.

docs/learn/resources/utxo-construction.png

-3
This file was deleted.

docs/learn/resources/utxo-explanation.png

-3
This file was deleted.

docs/learn/resources/void-number-construction.png

-3
This file was deleted.

docs/learn/resources/zkp-details.png

-3
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# 🧩 Overview
2+
3+
Node maintainers are encouraged and welcome to run Manta collators. No centralized permission is required but a MANTA bond must be posted.
4+
5+
Free-Market competition between high-performing collators for delegations will ensure a Manta Network runs at maximum performance and censorship resistance.
6+
7+
## Benefits of Running a Collator
8+
9+
- Participation in staking rewards
10+
- Boosted APY compared to delegation through 10% commision on delegator's share of rewards
11+
- 10% of transaction fees in every block produced by the collator
12+
- 2% of the total supply goes directly to block producers on an annual basis.
13+
14+
## Join the collator maintainer community discussion
15+
16+
- Discord: [Collator Program](https://discord.com/channels/795390654628102165/936300292536942592)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## MANTA Bond
2+
3+
400_000 MANTA must be available to post as collator bond
4+
5+
## Hardware and Infrastructure
6+
7+
a. Running on your own hardware and within you own premises (recommended):
8+
9+
- collator system host (note that a substrate collator will utilize all available system ram and all available cpu cores unless specifically configured not to do so)
10+
- cpu: 8 cores
11+
- memory: 32 gb of ram (more is better)
12+
- disk space: 500 gb of disk space dedicated to the blockchain basepath (more is better)
13+
- infrastructure and environment
14+
- network bandwidth: 100 mbps+
15+
- internet-accessible ports:
16+
- **31333**: default manta peer-to-peer port
17+
- **31334**: default (embedded-relay) polkadot peer-to-peer port
18+
- **9615**: default manta metrics port
19+
- **9616**: default (embedded-relay) polkadot metrics port
20+
21+
you should monitor your own collator using the techniques described on the [polkadot wiki](https://wiki.polkadot.network/docs/maintain-guides-how-to-monitor-your-node). the metrics exposed on ports 9615 and 9616 facilitate this, so these ports should be accessible both from your own prometheus/alertmanager server (which should be configured to alert you) and manta devops' [pulse server](https://pulse.pelagos.systems) at `18.156.192.254` (monitored by manta devops).
22+
- an uninterrupted power supply to both the collator node and the network switches and routers that provide its connectivity must be capable of keeping the system online during provider power outages
23+
- a failover 4g or 5g router should be included in your network topology to provide connectivity in the event of a wired or fibre connection failure
24+
- your network management should include automatic dns updates in the event of changes to your nodes publicly accessible ip addressing
25+
26+
b. Running on AWS EC2
27+
- instance type: r5ad.xlarge or similar
28+
- image: Ubuntu 22.04 (latest ubuntu server ami from Canonical/099720109477)
29+
30+
c. Azure/GCP or other cloud/datacenter provider
31+
- Please use your judgement to match or surpass the requirements for other environments above
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
---
2+
sidebar_position: 1
3+
sidebar_label: 🥡 Installation
4+
title: 🚄 Setup and run a Collator
5+
hide_title: false
6+
---
7+
8+
import Tabs from '@theme/Tabs';
9+
import TabItem from '@theme/TabItem';
10+
11+
Installation > [Configuration](configuration) > [Running](running) > [Sync](sync) > [Session keys](keys)> [Bond](bond)
12+
13+
## 🥡 Installation
14+
15+
<Tabs groupId="os">
16+
<TabItem value="docker" label="docker">
17+
18+
- pull the latest manta container
19+
20+
```bash
21+
#!/bin/bash
22+
23+
# Depending on your setup, here are some steps to get started
24+
25+
# Upgrade to latest version
26+
sudo apt update && sudo apt upgrade -y
27+
28+
# Install docker
29+
sudo apt install docker.io
30+
31+
# Add current user to docker
32+
sudo usermod -aG docker $USER
33+
34+
# Pull the manta image
35+
docker pull mantanetwork/manta:latest
36+
```
37+
38+
</TabItem>
39+
<TabItem value="fedora" label="fedora">
40+
41+
the manta .rpm package contains:
42+
43+
- the manta binary (which is also used to run manta)
44+
- manta and manta systemd services
45+
- manta, manta, polkadot and kusama chain specifications
46+
- a script which runs after installation and creates the manta system account which the systemd service runs under
47+
48+
get started (see also: [rpm.manta.systems](https://rpm.manta.systems/)):
49+
50+
- add the manta .rpm repository
51+
52+
```bash
53+
#!/bin/bash
54+
55+
sudo dnf install dnf-plugins-core
56+
sudo dnf config-manager --add-repo https://rpm.manta.systems/manta.repo
57+
sudo dnf config-manager --set-enabled manta
58+
sudo dnf update
59+
```
60+
61+
- install manta
62+
63+
```bash
64+
#!/bin/bash
65+
66+
sudo dnf install manta
67+
```
68+
69+
</TabItem>
70+
<TabItem value="ubuntu" label="ubuntu">
71+
72+
the manta .deb package contains:
73+
74+
- the manta binary (which is also used to run manta)
75+
- manta and manta systemd services
76+
- manta, manta, polkadot and kusama chain specifications
77+
- a script which runs after installation and creates the manta system account which the systemd service runs under
78+
79+
get started (see also: [deb.manta.systems](https://deb.manta.systems/)):
80+
81+
- add the manta .deb repository
82+
83+
```bash
84+
#!/bin/bash
85+
86+
sudo curl -o /usr/share/keyrings/manta.gpg https://deb.manta.systems/manta.gpg
87+
sudo curl -o /etc/apt/sources.list.d/manta.list https://deb.manta.systems/manta.list
88+
sudo apt update
89+
```
90+
91+
- install manta
92+
93+
```bash
94+
#!/bin/bash
95+
96+
sudo apt install manta
97+
```
98+
99+
</TabItem>
100+
<TabItem value="linux" label="other linux">
101+
102+
- download binary, chain specifications and systemd unit file
103+
104+
```bash
105+
#!/bin/bash
106+
107+
# intall jq on ubuntu
108+
sudo apt install jq
109+
110+
# or on fedora
111+
sudo dnf install jq
112+
113+
# get the latest version of binary
114+
manta_version=$(curl -s https://api.github.com/repos/Manta-Network/Manta/releases/latest | jq -r .tag_name | cut -c 2-)
115+
116+
# binary
117+
sudo curl -Lo /usr/local/bin/manta https://github.com/Manta-Network/Manta/releases/download/v${manta_version}/manta
118+
sudo ln -srf /usr/local/bin/manta /usr/local/bin/manta
119+
120+
# chainspecs
121+
sudo mkdir -p /usr/share/substrate
122+
sudo curl -Lo /usr/share/substrate/manta.json https://raw.githubusercontent.com/Manta-Network/Manta/v3.0.9/genesis/manta-genesis.json
123+
sudo curl -Lo /usr/share/substrate/polkadot.json https://raw.githubusercontent.com/paritytech/polkadot/master/node/service/chain-specs/polkadot.json
124+
125+
# systemd unit file
126+
sudo curl -Lo /etc/systemd/system/manta.service https://raw.githubusercontent.com/Manta-Network/Manta/deb-rpm/scripts/package/manta.service
127+
```
128+
129+
- create the manta system account which the systemd service runs under
130+
131+
```bash
132+
#!/bin/bash
133+
134+
sudo groupadd --system manta
135+
sudo useradd \
136+
--system \
137+
--gid manta \
138+
--home-dir /var/lib/substrate \
139+
--create-home \
140+
--shell /sbin/nologin \
141+
--comment 'service account for manta and calamari services' \
142+
manta
143+
```
144+
145+
</TabItem>
146+
</Tabs>

0 commit comments

Comments
 (0)