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

Docs clichain guide test #925

Merged
merged 6 commits into from
Oct 8, 2024
Merged

Docs clichain guide test #925

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e8e30d9
a minor fix
ijonele Oct 7, 2024
4575482
improved the clichain guide and related guides
ijonele Oct 7, 2024
c38f9a0
Merge remote-tracking branch 'origin/main' into docs-clichain-guide-test
ijonele Oct 7, 2024
e36ab43
coderabbit
ijonele Oct 7, 2024
4f082d1
a minor fix
ijonele Oct 7, 2024
985a684
deleted mentions of dev snapshot
ijonele Oct 8, 2024
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
195 changes: 118 additions & 77 deletions docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,74 +8,80 @@ sidebar_position: 2

To become a **Keychain operator**, you need to create and configure a Keychain entity on-chain, as shown in this guide.

## 1. Run a node

1. Run a local chain as explained here: [Run a local chain](/operate-a-node/run-a-local-chain).
:::tip
In the steps below, you'll interact with a [local chain](/operate-a-node/run-a-local-chain). To become an actual Keychain operator, you need to [join Buenavista](/operate-a-node/buenavista-testnet/join-buenavista) instead. However, we recommend running a local chain first to test your configuration.
:::

To become an actual Keychain operator, you need to [join Buenavista](/operate-a-node/buenavista-testnet/join-buenavista) instead. However, we recommend running a local chain first to test your configuration.
:::tip
You can skip this guide and test a preconfigured Keychain. Just run a local node using a [`just` script](/operate-a-node/run-a-local-chain#option-1-run-a-just-script) or a [devnet snapshot](/operate-a-node/run-a-local-chain#option-2-use-a-devnet-snapshot) and [start fulfilling requests](fulfill-requests-from-cli).
:::

For the rest of this guide, we'll assume you have a running Warden Protocol node with a local account (key) that has a few [WARD tokens](/tokens/ward-token/ward). You'll use these tokens to fund the Keychain and its Writers.
## 1. Run a node

2. The next steps require your local account name, or **key name**. It's referenced as `my-key-name` in the provided command-line examples.
1. Run a local chain as explained here: [Run a local chain](/operate-a-node/run-a-local-chain).

For the rest of this guide, we'll assume you have a running Warden Protocol node with a local account (key) that has a few [WARD tokens](/tokens/ward-token/ward). You'll use these tokens to fund the Keychain and its Writers.

2. The next steps require your local account name, or key name. It's referenced as `my-key-name` in the provided command-line examples.

You can check the list of available keys by executing this command:
You can check the list of available keys by executing this command:

```bash
wardend keys list
```
To check the local account balance, run this:
```bash
wardend query bank balances my-key-name
```
:::tip
If you used a `just` script or a devnet snapshot to run your node, the local account name is `shulgin`.
:::
```bash
wardend keys list
```

To check the local account balance, run this:

```bash
wardend query bank balances my-key-name
```

:::tip
If you used a `just` script or a devnet snapshot to run your node, the local account name is `shulgin`.
:::

3. In some of the commands, you'll also need to specify your **chain ID**. The actual value depends on the configuration you used when running your node.
3. In some of the commands, you'll also need to specify your chain ID. The actual value depends on the configuration you used when running your node.

To check your chain ID, run this:
To check your chain ID, run this:

```
wardend status
```
```
wardend status
```

See the `network` field in the output.
See the `network` field in the output.

:::tip
If you used a `just` script or a devnet snapshot to run your node, the chain ID is `warden_1337-1`.
:::
:::tip
If you used a `just` script or a devnet snapshot to run your node, the chain ID is `warden_1337-1`.
ijonele marked this conversation as resolved.
Show resolved Hide resolved
:::

## 2. Register a Keychain

The following steps show how to register a new Keychain entity on-chain.

1. Run this command to create a new Keychain:

```bash
wardend tx warden new-keychain \
--name 'my-keychain-name' \
--from my-key-name \
--chain-id chain_123-1 \
--description 'my-keychain-description' \
--keychain-fees "{\"key_req\":[{\"amount\":\"100\",\"denom\":\"award\"}],\"sig_req\":[{\"amount\":\"1\",\"denom\":\"award\"}]}"
```
```bash
wardend tx warden new-keychain \
--name 'my-keychain-name' \
--from my-key-name \
--chain-id chain_123-1 \
```

Specify the required details:

Specify the following details:
- `name`: The Keychain name
- `from`: Your local account name (key name)
- `chain-id`: The ID of the chain you're running

- `name`: The Keychain name
- `from`: Your local account name (key name)
- `chain-id`: The ID of the chain you're running
- `description` (optional): The Keychain description
- `keychainFees`(optional):
- `key_req`: A fee in aWARD for creating a key pair
- `key_req`: A fee in aWARD for signing a transaction
Optionally, you can also set the following:

**Note**: aWARD equals 0.000000000000000001 WARD.
- `description`: The Keychain description
- `keychain-fees`: Keychain fees in aWARD (0.000000000000000001 WARD)
- `key_req`: A fee for creating a key pair
- `sig_req`: A fee for signing a transaction
- For more settings, see `wardend tx warden new-keychain --help`.

2. Enter your passphrase if needed and confirm the transaction. A new Keychain object will be created on-chain.
2. Confirm the transaction. A new Keychain object will be created on-chain.

3. Every Keychain is created with a **Keychain ID** that identifies it in key and signature requests and collects fees from users. You'll need this ID to operate your Keychain. Run the following command and check the `id` field in the output:

Expand Down Expand Up @@ -107,46 +113,81 @@ A Keychain Writer is an account that can write Keychain results (public keys and

To add a Keychain Writer, take these steps:

1. Run this command to add a Keychain Writer with a preferred name:
1. Create a new key (account) with a preferred name:

```bash
wardend keys add my-keychain-writer-name
```
The output should look like this:
```bash
wardend keys add my-keychain-writer-name
```
The output should look like this:

```bash
- address: warden18my6wqsrf5ek85znp8x202wwyg8rw4fqhy54k2
name: my-keychain-writer-name
pubkey: '{"@type":"/cosmos.crypto.secp256k1.PubKey","key":"A2cECb3ziw5/LzUBUZIChyek3bnGQv/PSXHAH28xd9/Q"}'
type: local


**Important** write this mnemonic phrase in a safe place. It is the only way to recover your account if you ever forget your password.

virus boat radio apple pilot ask vault exhaust again state doll stereo slide exhibit scissors miss attack boat budget egg bird mask more trick
```
```bash
- address: warden18my6wqsrf5ek85znp8x202wwyg8rw4fqhy54k2
name: my-keychain-writer-name
pubkey: '{"@type":"/cosmos.crypto.secp256k1.PubKey","key":"A2cECb3ziw5/LzUBUZIChyek3bnGQv/PSXHAH28xd9/Q"}'
type: local


**Important** write this mnemonic phrase in a safe place. It is the only way to recover your account if you ever forget your password.

virus boat radio apple pilot ask vault exhaust again state doll stereo slide exhibit scissors miss attack boat budget egg bird mask more trick
```

2. Write down the **mnemonic phrase** and the **address** of the new account. You'll need this information to interact with the chain and restore the account. Note that only this address will be able to publish signatures and public keys on behalf of the Keychain.

3. Fund the account with some tokens. Specify your key name, the Keychain Writer name, and chain ID:

2. Note down the **mnemonic phrase** and the **address** of the new account. You'll need this information to interact with the chain.
```bash
wardend tx bank send my-key-name $(wardend keys show -a my-keychain-writer-name) \
1000000000000000000award \
--chain-id chain_123-1
```

To check the Keychain Writer balance, run this:

```bash
wardend query bank balances my-keychain-writer-name
```
ijonele marked this conversation as resolved.
Show resolved Hide resolved

:::tip
Only the Keychain Writer address will be able to publish signatures and public keys on behalf of the Keychain.
In this example, we used `$(wardend keys show -a my-keychain-writer-name)` to get the Keychain Writer address by its name. Alternatively, you can just specify the address obtained in the previous step.
:::

4. Finally, add the Writer account to your Keychain. Specify the Keychain ID from [Step 2.3](#2-register-a-keychain) and other details:

```
wardend tx warden add-keychain-writer --from my-key-name \
--keychain-id 1 --writer $(wardend keys show -a my-keychain-writer-name) \
--chain-id chain_123-1
```

3. Fund the new account with some tokens. Specify your key name, the Keychain Writer address, and chain ID:
To check the result, get the list of Keychains:

```bash
wardend tx bank send my-key-name \
$(wardend keys show -a my-keychain-writer-name) \
1000000000000000000award \
--chain-id chain_123-1
```
```
wardend query warden keychains
```

To check the Keychain Writer balance, run this:

```bash
wardend query bank balances my-keychain-writer-name
```
In the output, find your Keychain and check the `writers` list:

```
keychains:
- admins:
- warden1h7akmejqcrafp3mfpjqamghh89kzmkgjzsy3mc
creator: warden1h7akmejqcrafp3mfpjqamghh89kzmkgjzsy3mc
description: my-keychain-description
fees:
key_req:
- amount: "100"
denom: award
sig_req:
- amount: "1"
denom: award
id: "1"
name: my-keychain-name
writers:
- warden18my6wqsrf5ek85znp8x202wwyg8rw4fqhy54k2
pagination:
total: "1"
```
ijonele marked this conversation as resolved.
Show resolved Hide resolved

## Next steps

Expand Down
Loading
Loading