Skip to content

Commit f339950

Browse files
committed
Added "FAQ" page (CD-67)
1 parent 899f8ce commit f339950

File tree

3 files changed

+206
-0
lines changed

3 files changed

+206
-0
lines changed

config/theme.navbar.config.js

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,13 @@ module.exports = {
6161
label: "Casper 2.0",
6262
position: "right",
6363
},
64+
{
65+
type: "docSidebar",
66+
sidebarId: "faqSidebar",
67+
docsPluginId: 'faq',
68+
label: "FAQ",
69+
position: "right",
70+
},
6471
// {
6572
// to: 'blog',
6673
// label: 'Blog Articles',

faq/condor.sidebar.js

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
/**
2+
* Creating a sidebar enables you to:
3+
- create an ordered group of docs
4+
- render a sidebar for each doc of that group
5+
- provide next/previous navigation
6+
7+
The sidebars can be generated from the filesystem, or explicitly defined here.
8+
9+
Create as many sidebars as you want.
10+
*/
11+
12+
// @ts-check
13+
14+
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
15+
const sidebars = {
16+
// By default, Docusaurus generates a sidebar from the docs folder structure
17+
//condorSidebar: [{type: 'autogenerated', dirName: '.'}],
18+
// But you can create a sidebar manually
19+
faqSidebar: [
20+
'faq',
21+
],
22+
//
23+
// {
24+
// type: 'category',
25+
// label: 'Tutorial',
26+
// items: ['tutorial-basics/create-a-document'],
27+
// },
28+
// ],
29+
30+
};
31+
32+
export default sidebars;

faq/faq.md

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
---
2+
title: "Casper Network - Frequently Asked Questions"
3+
description: "Comprehensive FAQ covering Casper Network for smart contract developers, validators, operators, and users."
4+
tags: ["Casper", "FAQ", "Validators", "Smart Contracts", "dApps", "Casper Wallet", "Node Operators"]
5+
---
6+
7+
# ❓ Casper Network FAQ
8+
9+
This FAQ addresses common questions from smart contract developers, dApp builders, node operators, validators, and retail users within the Casper Network ecosystem. The answers aim to provide both clarity and guidance for newcomers and experienced participants in the network.
10+
11+
---
12+
13+
## 🧑‍💻 Developer & dApp FAQs
14+
15+
### 1. How do I install `casper-sidecar` on Ubuntu/Debian?
16+
17+
`casper-sidecar` is a service that allows developers to interact with the Casper network more efficiently. To install it on a Debian-based system, follow these steps:
18+
19+
```bash
20+
sudo mkdir -m 0755 -p /etc/apt/keyrings/
21+
22+
sudo curl https://repo.casper.network/casper-repo-pubkey.gpg --output /etc/apt/keyrings/casper-repo-pubkey.gpg
23+
24+
echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/casper-repo-pubkey.gpg] https://repo.casper.network/releases focal main" | sudo tee -a /etc/apt/sources.list.d/casper.list
25+
26+
sudo apt update
27+
28+
sudo apt install casper-sidecar
29+
```
30+
31+
This sets up the public key, adds the Casper repository to your system, updates the package list, and installs the software.
32+
33+
---
34+
35+
### 2. Where can I learn about serialization of transaction payloads?
36+
37+
Serialization is the process of converting complex data into a format that can be transmitted or stored and reconstructed later. Casper uses specific serialization methods for deploys and payloads.
38+
39+
You can explore serialization concepts in the official documentation:
40+
🔗 [Serialization – Casper Docs](https://docs.casper.network/concepts/serialization)
41+
42+
You can also refer to the JavaScript SDK for practical examples:
43+
🔗 [casper-js-sdk](https://www.npmjs.com/package/casper-js-sdk)
44+
45+
---
46+
47+
### 3. What causes an "invalid deploy" when using Casper Wallet?
48+
49+
An "invalid deploy" error typically occurs when your system time is not synchronized with the standard internet time.
50+
51+
Casper's deploys include timestamps, and if the timestamp on your deploy is too far from the network's time, it will be rejected.
52+
53+
✅ Make sure your system clock is set to automatically sync with an NTP (Network Time Protocol) server.
54+
55+
---
56+
57+
### 4. How do I check if a transaction was successful?
58+
59+
Once a deploy is submitted, you can check its status via the node RPC or via explorer tools.
60+
61+
Look for the following field in the JSON response:
62+
63+
```json
64+
result.execution_info.execution_result.Version2.error_message
65+
```
66+
67+
If `error_message` is `null` or empty, it means the transaction executed successfully. If it's populated, it will provide the reason for failure.
68+
69+
---
70+
71+
### 5. Where can I find Casper 2.0 RPC schema?
72+
73+
The Casper 2.0 RPC schema outlines the expected structure of requests and responses when interacting with the node through JSON-RPC.
74+
75+
You can find it here on GitHub:
76+
🔗 [Casper RPC Schema](https://github.com/casper-network/casper-sidecar/blob/dev/resources/test/rpc_schema.json)
77+
78+
This is particularly useful for tool builders and integration developers.
79+
80+
---
81+
82+
### 6. How do I migrate from Signer to Casper Wallet?
83+
84+
The Casper Signer is deprecated and replaced by the Casper Wallet. To migrate:
85+
86+
1. Export your keys from Signer.
87+
2. Import them into the Casper Wallet.
88+
3. Follow the guide below to complete the process:
89+
🔗 [Migration Guide – Casper Wallet](https://www.casperwallet.io/user-guide/signer-user-start-here)
90+
91+
---
92+
93+
### 7. What are the integration endpoints for `cspr.cloud`?
94+
95+
These endpoints are used for developers building integrations or apps that require RPC access to the network.
96+
97+
🔗 [https://node.integration.cspr.cloud/](https://node.integration.cspr.cloud/)
98+
99+
It is recommended to use these for staging and test environments rather than production deployments.
100+
101+
---
102+
103+
## 📊 Node Operator & Validator FAQs
104+
105+
### 9. When is a node considered fully synced?
106+
107+
A node transitions through states such as `CatchUp` and `KeepUp`. When a node's `reactor_state` becomes `KeepUp`, it means it has caught up with the latest state of the blockchain and is now participating in consensus.
108+
109+
You can check this in the node logs or via diagnostic endpoints.
110+
111+
---
112+
113+
### 10. Where can I check staking rewards?
114+
115+
Use [cspr.live](https://cspr.live) to check staking rewards:
116+
117+
1. Navigate to your account page.
118+
2. Click the "Staking Rewards" tab.
119+
3. You can view detailed reward history per Era.
120+
121+
Example:
122+
🔗 [Staking Rewards Example](https://cspr.live/account/02038baa714f1f45aaacb4443df31bf27a8990369c2f9d585f904ec5c5b85aeb231f)
123+
124+
---
125+
126+
## 👤 General User FAQs
127+
128+
### 11. What is delegation?
129+
130+
Delegation lets you participate in network security by staking your tokens with a validator. You don’t need to run a node. Validators share a portion of the staking rewards with their delegators, keeping a small fee (commission).
131+
132+
This contributes to network decentralization and rewards you with passive income.
133+
134+
---
135+
136+
### 12. How frequently are staking rewards paid?
137+
138+
Staking rewards are distributed every **Era** (approximately every 2 hours). It may take up to 4 hours (2 Eras) for the first rewards to show after delegation.
139+
140+
---
141+
142+
### 13. I’ve delegated my tokens but don’t see rewards?
143+
144+
Staking rewards are added to your current stake and may not appear immediately as spendable balance. To view them:
145+
146+
- Go to [cspr.live](https://cspr.live)
147+
- Look under your validator in the “Rewards” tab
148+
149+
---
150+
151+
### 14. Is there a lock period after delegation?
152+
153+
There is no lock period when delegating. However, **undelegation** incurs a 7 Era (~14 hour) unbonding period. After this, the tokens are available in your account for transfer or re-delegation.
154+
155+
---
156+
157+
### 15. Is there slashing? Can I lose tokens?
158+
159+
Currently, Casper does **not** have slashing enabled. If a validator is evicted from the active set, you won’t receive rewards while they’re inactive. In future, when slashing is enabled, delegators may lose a portion of their stake if their validator misbehaves.
160+
161+
---
162+
163+
### 16. What is the cost of delegation and undelegation?
164+
165+
Each delegation transaction costs approximately **3 CSPR**.
166+
💡 Always keep extra tokens in your account to cover fees for transactions like delegation, undelegation, and transfers.
167+

0 commit comments

Comments
 (0)