Skip to content

Commit

Permalink
feat: update
Browse files Browse the repository at this point in the history
  • Loading branch information
MohsenNz committed Jan 27, 2025
1 parent de88d2b commit a800a3f
Show file tree
Hide file tree
Showing 12 changed files with 163 additions and 79 deletions.
14 changes: 8 additions & 6 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,20 @@
# Guide

- [JungoAI Components](guide/jungoai-components.md)
- [Create a Wallet (Coldkey)](guide/create-a-wallet.md)
- [Create a Hotkey](guide/create-a-hotkey.md)
- [Run a Subnet node](guide/run-a-subnet-node.md)
- [Register UID](guide/register-uid.md)
- [Run Worker node](guide/run-worker.md)
- [Run Monitor node](guide/run-monitor.md)
- [Create a Subnet]()
- [Register UID](guide/register-uid.md)
- [Run Worker node](guide/run-worker.md)
- [Run Monitor node](guide/run-monitor.md)
- [Create a Subnet](guide/create-a-subnet.md)
- [Run Jungochain RPC node](guide/run_jungochain_rpc_node.md)
- [Use Subnet services as a user]()

# Tools

- [JungoAI CLI]()
- [JungoAI SDK]()
- [Jungo CLI](tools/jungo-cli.md)
- [Jungo SDK]()

# More

Expand Down
5 changes: 4 additions & 1 deletion src/assets/subnet.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 34 additions & 0 deletions src/guide/create-a-hotkey.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Create a Hotkey

<div class="warning">
Pre requirements

You need to have `jucli` (Jungo-CLI) on your system.
You can install it from [here](../tools/jungo-cli.md#Installation).

</div>

A hotkey is another address that placed under a coldkey. The coldkey is used to hold and transfer tokens.
A hotkey (alongside coldkey) is used to register node (worker or monitor).
Stake and reward distribution also done in the hotkeys.
The purpose of hotkey is to provide more security, coldkey to be used for transfer tokens,
and hotkey to be used in JungoAI ecosystem e.g stake.

```bash
jucli wallet new_hotkey
```

Fill the prompts. For example:

```
Enter the wallet name (default): alan
Enter the name of the new hotkey (default): alan-hotkey1
Enter the wallet path (Hint: You can set this with `jucli config set --wallet-path`) (~/.jungoai/wallets/):
Choose the number of words [12/15/18/21/24]: 12
```

Now check your wallet:

```bash
jucli wallet list
```
32 changes: 32 additions & 0 deletions src/guide/create-a-subnet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Create a Subnet

<div class="warning">
Pre requirements

You need to have `jucli` (Jungo-CLI) on your system.
You can install it from [here](../tools/jungo-cli.md#Installation).
</div>

Run command below to create a new Subnet:

```bash
jucli subnet create --wallet.name <your-coldkey> --chain_endpoint wss://devnet-rpc.jungoai.xyz
```

You will see something like this:

```
>> Your balance is: 200.000000000
>> Do you want to register a subnet for 1000.000000000? [y/n]:
>> Enter password to unlock key: <YOUR_PASSWORD>
>> ✅ Registered subnetwork with netuid: 1002
```

After that you will be the owner of the Subnet.

<div class="warning">
Note

User Subnet's netuid is an incremental id start from 1001,
netuids from 1 to 1000 are reserved for base layer apps and netuid 0 is root subnet.
</div>
39 changes: 39 additions & 0 deletions src/guide/create-a-wallet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Create a Wallet (Coldkey)

<div class="warning">
Pre requirements

You need to have `jucli` (Jungo-CLI) on your system.
You can install it from [here](../tools/jungo-cli.md#Installation).
</div>

Coldkey is a synonym name for Wallet in JungoAI.

Run command below to generate a new wallet:

```bash
jucli wallet new_coldkey
```

You will see the following prompts:

- `Enter the path to the wallets directory (~/.jungoai/wallets/):`<br>
Default is `~/.jungoai/wallets/`, press enter or write another path as you want.

- `Enter the wallet name (default): alan`<br>
Enter your desire name for your coldkey (wallet name). In this example we used `alan`.

- `Choose the number of words [12/15/18/21/24]:`<br>
Write number of words for secret phrase.

- `Enter your password:`<br>
Write a password for your wallet.

- `The mnemonic to the new coldkey is: ...`<br>
Save your mnemonic in a safe place, it will used to recover the coldkey.

Now check your wallet:

```bash
jucli wallet list
```
10 changes: 5 additions & 5 deletions src/guide/jungoai-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
JungoAI consisted of this components:


Main Componenet of JungoAI ecosystem would be:
Main Components of JungoAI ecosystem would be:

- Jungochain
- Subnet
Expand All @@ -25,7 +25,7 @@ To get more details checkout [terminologies](../more/terminologies.md)
A Subnet is a subnetwork under Jungochain, running an AI or Big Data service.

Everyone can run a Subnet on Jungochain by staking amount of JUNGO token,
set configuration parameters for it and define the service API (to be used by the end-user).
set configuration parameters for that and define the service API (to be used by the end-user).
After than other persons can run Worker and Monitor nodes that follow
that rules (service API and configuration) on the subnet and get emission too.

Expand All @@ -35,13 +35,13 @@ Subnet is made of Worker nodes and Monitor nodes.

### Worker

Is actual node that run Big Data or AI service and serve end-user
Is actual node that run Big Data or AI service and serve end-user.

### Monitor

A Monitor analyze performance of Workers and send result (scores of Workers) back to the Jungochain.
Then Jungochain distribute emission among Workers according to it.
A Monitor also gets reward according to the average of Monitors result.
Then Jungochain distribute reward among Workers according to it.
A Monitor also gets reward according to the average of Monitor results.
See [emission](../more/emissions.md) section for more details.

Here is a diagram of a Subnet:
Expand Down
72 changes: 8 additions & 64 deletions src/guide/register-uid.md
Original file line number Diff line number Diff line change
@@ -1,75 +1,19 @@
# Register UID

- First of all you need to install [Jungo-CLI](https://github.com/jungoai/jungo-cli) (JungoAI command line tool).
- Create a Coldkey (Wallet)
- Create a Hotkey
<div class="warning">
Pre requirements

## Install Jungo-CLI
You need to have `jucli` (Jungo-CLI) on your system.
You can install it from [here](../tools/jungo-cli.md#Installation).

1- Install Rye:
```bash
curl -sSf https://rye.astral.sh/get | bash
```

2- Install Jungo-CLI via Rye:
```bash
rye install jungo-cli --git https://github.com/jungoai/jungo-cli.git
```

Verify installation:
```bash
jucli --version
```

## Create a Coldkey
```bash
jucli wallet new_coldkey
```
`Enter the path to the wallets directory (~/.jungoai/wallets/):`,
Default is ~/.jungoai/wallets/, press enter or write another path as you want

`Enter the wallet name (default): alan`,
Enter your desire name for your coldkey (wallet name). In this example we use `alan`.

`Choose the number of words [12/15/18/21/24]:`,
Write number of words for secret phrase.

`Enter your password:`
Write a password for your wallet.
You should have a coldkey. Follow [here](create-a-wallet.md) to create one.

`The mnemonic to the new coldkey is: ...`,
Save your mnemonic in a safe place, it will used to recover the coldkey.

```bash
jucli wallet list
```

## Create a Hotkey
A hotkey is another address that placed under a coldkey. The coldkey is used to hold and transfer tokens.
A hotkey (alongside coldkey) is used to register node (worker or monitor) and get staked to get reward
in JungoAI ecosystem. The purpose of hotkey is to provide more security,
coldkey for causal use like transfer tokens, and hotkey to be used in JungoAI ecosystem.

```bash
jucli wallet new_hotkey
```

Fill the prompts. For example:
```
Enter the wallet name (default): alan
Enter the name of the new hotkey (default): alan-hotkey1
Enter the wallet path (Hint: You can set this with `jucli config set --wallet-path`) (~/.jungoai/wallets/):
Choose the number of words [12/15/18/21/24]: 12
```

Now check your wallet.
```bash
jucli wallet list
```
You should have hotkey. Follow [here](create-a-hotkey.md) to create one.
</div>

## Get Token

Currently to get token you can DM Mr.Bakhshandeh at Telegram ([@rbakhshandeh](https://t.me/rbakhshandeh)).
Currently you can get token by DM Mr.Bakhshandeh at Telegram ([@rbakhshandeh](https://t.me/rbakhshandeh)).

## Register UID

Expand Down
2 changes: 1 addition & 1 deletion src/guide/run-a-subnet-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ If you want to run an AI or Big Data app to serve users and get reward run a wor
Otherwise if you want to get reward for monitoring existent Workers in a subnet you
should run a Monitor node.

Before running a node you should register a UID on desired Subnet on Jungochian:
Before running a node you should register a UID in desired Subnet in Jungochian:

- [Register UID](register-uid.md)
- [Run a Worker node](run-worker.md)
Expand Down
6 changes: 5 additions & 1 deletion src/guide/run-monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,11 @@ Install echo-subnet:
rye install echo-subnet --git https://github.com/jungoai/jungo-echo-subnet.git
```

*Note: you can install `rye` by `curl -sSf https://rye.astral.sh/get | bash`*
<div class="warning">
Note

You can install `rye` by running `curl -sSf https://rye.astral.sh/get | bash`.
</div>

Run echo-worker:

Expand Down
6 changes: 5 additions & 1 deletion src/guide/run-worker.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,11 @@ Install echo-subnet:
rye install echo-subnet --git https://github.com/jungoai/jungo-echo-subnet.git
```

*Note: you can install `rye` by `curl -sSf https://rye.astral.sh/get | bash`*
<div class="warning">
Note

You can install `rye` by running `curl -sSf https://rye.astral.sh/get | bash`.
</div>

Run echo-monitor:

Expand Down
21 changes: 21 additions & 0 deletions src/tools/jungo-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Jungo CLI

## Installation

Install Rye:

```bash
curl -sSf https://rye.astral.sh/get | bash
```

Install Jungo-CLI via Rye:

```bash
rye install jungo-cli --git https://github.com/jungoai/jungo-cli.git
```

Verify installation:

```bash
jucli --version
```
1 change: 1 addition & 0 deletions src/tools/jungoai-cli.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# JungoAI CLI

0 comments on commit a800a3f

Please sign in to comment.