Skip to content

Commit

Permalink
GITBOOK-143: No subject
Browse files Browse the repository at this point in the history
  • Loading branch information
0xOzgur authored and gitbook-bot committed Oct 15, 2024
1 parent b2acee5 commit 6573094
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 21 deletions.
2 changes: 1 addition & 1 deletion autoinstaller.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: >-

# 🤖 AutoInstaller

This page explains how to install ceremonyclient with automatic installation scripts. 
This page explains how to install ceremonyclient and qClient with automatic installation scripts. 

This script will install latest version.

Expand Down
33 changes: 22 additions & 11 deletions cli-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,18 @@ Then download binary of cqlient

```bash
wget https://releases.quilibrium.com/qclient-2.0.0-linux-amd64
chmod u+x qclient-2.0.0-linux-amd64
mv qclient-2.0.0-linux-amd64 qclient
chmod u+x qclient-2.0.0.2-linux-amd64
mv qclient-2.0.0.2-linux-amd64 qclient


```

{% hint style="info" %}
Please note that, you must downlod cqlient binary depends on your system architecture. There are 3 different binary option based on systems.

<pre class="language-markup" data-line-numbers><code class="lang-markup"><strong>qclient-2.0.0-darwin-arm64
</strong>qclient-2.0.0-linux-arm64
qclient-2.0.0-linux-amd64
<pre class="language-markup" data-line-numbers><code class="lang-markup"><strong>qclient-2.0.0.2-darwin-arm64
</strong>qclient-2.0.0.2-linux-arm64
qclient-2.0.0.2-linux-amd64
</code></pre>
{% endhint %}

Expand All @@ -50,7 +50,18 @@ The CLI tooling itself will be relatively simple, and the commands can be run as
```
{% endcode %}

### 2. Querying Balance
### 3. Merge Keys

For the example provided, it is assumed qclient lives in the `client/` folder alongside the `node/` folder where the `.config*/` folders are contained

{% code overflow="wrap" %}
```bash
./../client/qclient-2.0.0-linux-amd64 config prover merge --dry-run /root/ceremonyclient/node/.config /root/ceremonyclient/node/.config1

```
{% endcode %}

### 4. Querying Balance

The command line tool takes arguments in either decimal (xx.xxxxx) format or raw unit (0x00000) format. Note that raw units are a multiple of QUIL: 1 QUIL = 0x1DCD65000 units\
\
Expand All @@ -69,7 +80,7 @@ $ ./qclient token balance
```
{% endcode %}

### 3. Querying Individual Coins
### 5. Querying Individual Coins

Users may wish to view the individual coins:\
\
Expand All @@ -87,7 +98,7 @@ $ client token coins
25.0 QUIL (Coin 0x2dda9dc9770a1e5a01974fcd5af2a77147d0f19fb4935a1df677ec6050be0a9e)
```

### 4. Creating a Pending Transaction
### 6. Creating a Pending Transaction

Quilibrium's token application has two modes: a two-stage transfer/accept (or reject), or a single-stage mutual transfer.\
\
Expand Down Expand Up @@ -131,7 +142,7 @@ The first is a user-friendly version of a transfer, akin to what account-based n
```
{% endcode %}

### 5. Accepting a Pending Transaction
### 7. Accepting a Pending Transaction

To accept a pending transaction, you simply run:

Expand All @@ -154,7 +165,7 @@ The same applies for rejecting a pending transaction
\
This creates a separate pending transaction because if the refund address is specified by the originator, and were they to specify another of your own addresses, it would be no different than accepting.

### 6. Performing a Mutual Transfer
### 8. Performing a Mutual Transfer

Pending transactions introduce friction, but without that friction, users can be spammed coins they don't want, or sent coins from an address they do not wish to interact with. If both parties agree in advance to transact, they can perform a mutual transfer, where both parties must be online, but can avoid having to deal with the two-phase transaction. This is great for maintaining privacy (each party's account is private) as well as ensuring a timely completion of a transaction:\
\
Expand Down Expand Up @@ -195,7 +206,7 @@ Confirming rendezvous... OK

This will likely be the first unique experience Quilibrium provides to users already familiar with other networks, as privacy preservation is an immediately obvious and first class experience here by showing the user what it can (or _cannot_) see.

### 7. Claiming Rewards
### 9. Claiming Rewards

_Claiming rewards as wQuil, please visit_ [Claiming wQuil Token section](claiming-wquil-token.md).

Expand Down
10 changes: 5 additions & 5 deletions installation/running-as-a-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Restart=always
RestartSec=5s
WorkingDirectory=/root/ceremonyclient/node
Environment=GOEXPERIMENT=arenas
ExecStart=/root/ceremonyclient/node/node-2.0.0.1-linux-amd64
ExecStart=/root/ceremonyclient/node/node-2.0.0.3-linux-amd64
KillSignal=SIGINT
TimeoutStopSec=30s

Expand Down Expand Up @@ -91,23 +91,23 @@ sudo journalctl -u ceremonyclient.service -f --no-hostname -o cat
See Peer ID:

```bash
cd ~/ceremonyclient/node && ./node-2.0.0.1-linux-amd64 -peer-id
cd ~/ceremonyclient/node && ./node-2.0.0.3-linux-amd64 -peer-id
```

See Node Info:

```bash
cd ~/ceremonyclient/node && ./node-2.0.0.1-linux-amd64 -node-info
cd ~/ceremonyclient/node && ./node-2.0.0.3-linux-amd64 -node-info
```

Run the DB console:

```bash
cd ~/ceremonyclient/node && ./node-2.0.0.1-linux-amd64 -db-console
cd ~/ceremonyclient/node && ./node-2.0.0.3-linux-amd64 -db-console
```

Check Balances:

```bash
cd ~/ceremonyclient/node && ./node-2.0.0.1-linux-amd64 -balance
cd ~/ceremonyclient/node && ./node-2.0.0.3-linux-amd64 -balance
```
2 changes: 1 addition & 1 deletion installing-prerequisites.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 💾 Installing Prerequisites

We strongly recommend running your Node via binary after vv2.0.0.1 This documentation does not support running or building nodes using source.
We strongly recommend running your Node via binary after vv2.0.0.3 This documentation does not support running or building nodes using source.

When run with Binary, you do not need to install any additional requirements. But we still share these for those who want to use grpcurl.

Expand Down
2 changes: 1 addition & 1 deletion quilibrium-for-dummies.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: 'Version Info: Quilibrium for Dummies v2.0.0.1'
description: 'Version Info: Quilibrium for Dummies v2.0.0.3 & qClient v2.0.0.2'
---

# 🥟 Quilibrium for Dummies
Expand Down
2 changes: 1 addition & 1 deletion release-notes-and-prerequisites/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
description: 'Current Version: vv2.0.0.1 (Dusk) as of Oct 16, 2024'
description: 'Current Version: vv2.0.0.3 (Dusk) as of Oct 15, 2024'
---

# 💻 Release Notes And Prerequisites
Expand Down
4 changes: 3 additions & 1 deletion update-node.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
description: Please note that, these instructions would upgrade your node to v2.0.0.1
description: >-
Please note that, these instructions would upgrade your node to v2.0.0.3 and
qClient v2.0.0.2
---

# 📀 Update Node
Expand Down

0 comments on commit 6573094

Please sign in to comment.