Skip to content

Commit dfd8567

Browse files
Sovereign docs update
1 parent 68f813d commit dfd8567

5 files changed

Lines changed: 81 additions & 5 deletions

File tree

docs/sovereign/distributed-setup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Before proceeding, ensure that a **SSH key** for GitHub is configured on your ma
1313
git clone git@github.com:multiversx/mx-chain-sovereign-go.git
1414
```
1515

16-
2. Navigate to testnet directory:
16+
2. Navigate to project directory:
1717
```bash
18-
cd mx-chain-sovereign-go/scripts/testnet
18+
cd mx-chain-sovereign-go
1919
```
2020

2121
### Step 2: Seeder Build
@@ -206,7 +206,7 @@ Adjust the flags as needed. You can find all the available flags in `/mx-chain-s
206206
207207
#### # observer
208208
```
209-
./sovereignnode --profile-mode --log-save --log-level *:INFO --log-logger-name --log-correlation --use-health-service --rest-api-interface :8080 --working-directory ~/my_observer_node
209+
./sovereignnode --profile-mode --log-save --log-level *:INFO --log-logger-name --log-correlation --use-health-service --destination-shard-as-observer 0 --rest-api-interface :8080 --operation-mode db-lookup-extension --working-directory ~/my_observer_node
210210
```
211211
212212
### Staking transaction

docs/sovereign/local-setup.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,17 @@ Before proceeding, ensure that a **SSH key** for GitHub is configured on your ma
3434

3535
### Step 2: Deploy Sovereign setup
3636

37+
#### Sovereign chain with no main chain connection
38+
39+
1. Update chain parameters in `variables.sh` file
40+
41+
2. Start the chain with local scripts:
42+
```bash
43+
./config.sh && ./sovereignStart.sh
44+
```
45+
46+
#### Sovereign chain with main chain connection
47+
3748
Navigate to the `sovereignBridge` folder:
3849
```bash
3950
cd sovereignBridge

docs/sovereign/sovereign-api.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,50 @@
11
# API service
22

3+
## Deploy Sovereign Proxy service
4+
5+
:::info
6+
Proxy service is automatically deployed if the sovereign chain was started with [local setup](/sovereign/local-setup)
7+
:::
8+
9+
### Step 1: Get the `mx-chain-proxy-sovereign-go` Repository
10+
11+
Before proceeding, ensure that a **SSH key** for GitHub is configured on your machine.
12+
13+
1. Clone the GitHub repository:
14+
```bash
15+
git clone git@github.com:multiversx/mx-chain-proxy-sovereign-go.git
16+
```
17+
18+
2. Navigate to proxy directory:
19+
```bash
20+
cd mx-chain-proxy-sovereign-go/cmd/proxy
21+
```
22+
23+
### Step 2: Edit Proxy `config.toml` file
24+
25+
Example:
26+
```
27+
[[Observers]]
28+
ShardId = 0
29+
Address = "http://127.0.0.1:10000"
30+
31+
[[Observers]]
32+
ShardId = 4294967295
33+
Address = "http://127.0.0.1:10000"
34+
```
35+
36+
:::note
37+
For sovereign proxy there are 2 Observers required for `ShardId` 0 and 4294967295. The `Address` should be the same for both.
38+
:::
39+
40+
### Step 3: Start Sovereign Proxy service
41+
42+
Build and run the proxy
43+
```bash
44+
go build
45+
./proxy --sovereign
46+
```
47+
348
## Deploy Sovereign API service
449

550
### Step 1: Get the `mx-api-service` Repository
@@ -28,6 +73,8 @@
2873
### Step 3: Start Sovereign API service
2974

3075
```bash
76+
npm install
77+
npm run init
3178
npm run start:testnet
3279
```
3380

docs/sovereign/sovereign-explorer.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,24 @@ git clone https://github.com/multiversx/mx-explorer-dapp.git
1717

1818
2. Update the parameters and URLs with your own configuration in `config.testnet.ts` file
1919

20+
Example configuration:
21+
```
22+
{
23+
default: true,
24+
id: 'sovereign',
25+
name: 'Sovereign',
26+
chainId: 'S',
27+
adapter: 'api',
28+
theme: 'default',
29+
egldLabel: 'SOV',
30+
walletAddress: 'https://localhost:3000',
31+
explorerAddress: 'https://localhost:3003',
32+
apiAddress: 'https://localhost:3002',
33+
hrp: 'erd',
34+
isSovereign: true
35+
}
36+
```
37+
2038
### Step 3: Start Sovereign Explorer
2139
2240
```bash

docs/sovereign/sovereign-wallet.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ git clone https://github.com/multiversx/mx-lite-wallet-dapp.git
1515
cd src/config
1616
```
1717

18-
2. Update the `config.sovereign.ts` file:
18+
2. Update the `sharedNetworks.ts` file:
1919
- for `sovereign` item
2020
- update the URLs with your own
2121
- update `sovereignContractAddress` with contract address from `sovereignConfig.toml` -> `SubscribedEvents` from `OutgoingSubscribedEvents`
@@ -26,7 +26,7 @@ git clone https://github.com/multiversx/mx-lite-wallet-dapp.git
2626

2727
```bash
2828
yarn install
29-
yarn start:sovereign
29+
yarn start-sovereign
3030
```
3131

3232
Read more about deploying lite wallet in [GitHub](https://github.com/multiversx/mx-lite-wallet-dapp/tree/main#multiversx-lite-wallet-dapp).

0 commit comments

Comments
 (0)