GitBook: [#73] No subject

SUMMARY.md

@@ -62,7 +62,7 @@
 
 ## Developer Reference
 
-* [Integration Guide](developer-reference/integration-guide.md)
+* [Integration Guide](developer-reference/integrations/README.md)
+  * [Node API Reference](developer-reference/integrations/node-api.md)
+  * [Wallet API Reference](developer-reference/integrations/wallet-api.md)
 * [Compile witnet-rust from Source Code](developer-reference/compile-witnet-rust-from-source-code.md)
-* [Node API Reference](developer-reference/node-api-reference.md)
-* [Wallet API Reference](developer-reference/wallet-api-reference.md)

developer-reference/integration-guide.md → developer-reference/integrations/README.md

@@ -13,17 +13,17 @@ The Witnet Foundation-supported reference implementation of the Witnet protocol
 
 Witnet-Rust can be easily run:
 
-* [as a Docker container](../node-operators/docker-quick-start-guide.md)
-* [as a docker-compose service](../node-operators/advanced-setups/run-witnet-as-a-docker-compose-service.md)
-* [as a systemd service](../node-operators/advanced-setups/run-witnet-as-a-systemd-service.md)
-* [compiling from source code](compile-witnet-rust-from-source-code.md)
+* [as a Docker container](../../node-operators/docker-quick-start-guide.md)
+* [as a docker-compose service](../../node-operators/advanced-setups/run-witnet-as-a-docker-compose-service.md)
+* [as a systemd service](../../node-operators/advanced-setups/run-witnet-as-a-systemd-service.md)
+* [compiling from source code](../compile-witnet-rust-from-source-code.md)
 
 ### Witnet-Rust Components
 
 Witnet-Rust contains two different components that provide different degrees of wallet functionality:
 
-* `node`, which implements a Witnet full node with an internal single-account, single-address wallet and a [JSON-RPC API over TCP](node-api-reference.md).
-* `wallet`, which implements a [BIP-32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) compliant, multi-account, multi-address [Hierarchical Deterministic](https://www.investopedia.com/terms/h/hd-wallet-hierarchical-deterministic-wallet.asp) wallet, and a [JSON-RPC API over WebSockets](wallet-api-reference.md).
+* `node`, which implements a Witnet full node with an internal single-account, single-address wallet and a [JSON-RPC API over TCP](node-api.md).
+* `wallet`, which implements a [BIP-32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) compliant, multi-account, multi-address [Hierarchical Deterministic](https://www.investopedia.com/terms/h/hd-wallet-hierarchical-deterministic-wallet.asp) wallet, and a [JSON-RPC API over WebSockets](wallet-api.md).
 
 ### Witnet-Rust `node` component
 
@@ -34,9 +34,9 @@ Integration architecture:
 [YOUR APP] → [WITNET-RUST NODE] → [WITNET NETWORK]
 ```
 
-Once a `node` instance is fully synced, its [JSON-RPC over TCP API](node-api-reference.md) offers a minimal single-account, single-address wallet.
+Once a `node` instance is fully synced, its [JSON-RPC over TCP API](node-api.md) offers a minimal single-account, single-address wallet.
 
-Running a Witnet-Rust node with the [JSON-RPC API](node-api-reference.md) exposed on local port `21338` can easily be achieved with this Docker one-liner:
+Running a Witnet-Rust node with the [JSON-RPC API](node-api.md) exposed on local port `21338` can easily be achieved with this Docker one-liner:
 
 ```
 docker run -d \
@@ -52,16 +52,16 @@ Here is a quick guide on how to interact with a node using the JSON-RPC interfac
 
 {% embed url="https://medium.com/witnet/interacting-with-witnet-node-without-cli-7028e8f6cff7" %}
 
-The full list of supported JSON-RPC methods is available in the [Node API Reference](node-api-reference.md):
+The full list of supported JSON-RPC methods is available in the [Node API Reference](node-api.md):
 
-{% content-ref url="node-api-reference.md" %}
-[node-api-reference.md](node-api-reference.md)
+{% content-ref url="node-api.md" %}
+[node-api.md](node-api.md)
 {% endcontent-ref %}
 
-There is also a [command line client (CLI)](../node-operators/cli-reference.md) that exposes all the node functionality and uses the JSON-RPC API under the hood:
+There is also a [command line client (CLI)](../../node-operators/cli-reference.md) that exposes all the node functionality and uses the JSON-RPC API under the hood:
 
-{% content-ref url="../node-operators/cli-reference.md" %}
-[cli-reference.md](../node-operators/cli-reference.md)
+{% content-ref url="../../node-operators/cli-reference.md" %}
+[cli-reference.md](../../node-operators/cli-reference.md)
 {% endcontent-ref %}
 
 ### Witnet-Rust `wallet` component
@@ -84,11 +84,10 @@ Sheikah Wallet app architecture:
 
 For users looking for the maximum degree of privacy, it is recommended that they run their own instance of the `node` component, because otherwise they may be disclosing their addresses and balances to 3rd parties, as the queries between the `wallet` and `node` components need to be sent over the Internet.
 
-The [JSON-RPC API](wallet-api-reference.md) of the `wallet` component is different than the one from the `node` not because it has much more advanced wallet functionality, and uses a WebSockets transport instead of plain TCP (this is to enable web wallets and similar apps).
+The [JSON-RPC API](wallet-api.md) of the `wallet` component is different than the one from the `node` not because it has much more advanced wallet functionality, and uses a WebSockets transport instead of plain TCP (this is to enable web wallets and similar apps).
 
-A full reference of the [Wallet API](wallet-api-reference.md) can be found here:
+A full reference of the [Wallet API](wallet-api.md) can be found here:
 
-{% content-ref url="wallet-api-reference.md" %}
-[wallet-api-reference.md](wallet-api-reference.md)
+{% content-ref url="wallet-api.md" %}
+[wallet-api.md](wallet-api.md)
 {% endcontent-ref %}
-

node-operators/advanced-setups/README.md

@@ -1,2 +1,2 @@
-# Advanced Setups
+# 🤓 Advanced Setups
 

node-operators/cli-reference.md

@@ -1,4 +1,4 @@
-# CLI Reference
+# 📄 CLI Reference
 
 The cli subcommand provides a human-friendly command-line interface to the node [JSON-RPC API](json-rpc/).
 

node-operators/docker-quick-start-guide.md

@@ -1,4 +1,4 @@
-# Docker Quick Start Guide
+# 🚀 Docker Quick Start Guide
 
 **The Witnet Mainnet is open for anyone to join and and run their own full node.**
 

node-operators/next-steps.md

@@ -1,4 +1,4 @@
-# Next steps
+# 🔎 Next steps
 
 ## The first minutes and hours in your node's life
 
@@ -68,8 +68,6 @@ The `balance` command will print your node's current balance.
 ```
 docker exec witnet_node witnet node balance
 ```
-
-
 {% endtab %}
 
 {% tab title="Binary" %}
@@ -110,7 +108,7 @@ cargo run --release -- node reputation
 {% endtabs %}
 
 {% hint style="info" %}
-The reputation score of a node gives a rough idea about its performance, but this metric is heavily influenced by randomness and luck. It is perfectly normal that the reputation score goes up and down over time, sometimes smoothly, sometimes more abruptly. Likewise, there is probably nothing wrong if your node shows 0 reputation points or is marked as _not active_. Do not get too obsessed about it!  
+The reputation score of a node gives a rough idea about its performance, but this metric is heavily influenced by randomness and luck. It is perfectly normal that the reputation score goes up and down over time, sometimes smoothly, sometimes more abruptly. Likewise, there is probably nothing wrong if your node shows 0 reputation points or is marked as _not active_. Do not get too obsessed about it!
 {% endhint %}
 
 ## Check ports and incoming connections
@@ -131,8 +129,6 @@ telnet your_public_ip 21337
 ```
 nc -vz your_public_ip:21337
 ```
-
-
 {% endtab %}
 {% endtabs %}
 
@@ -269,7 +265,7 @@ witnet node server --master-key-import ~/.witnet/config/master.key
 {% endtabs %}
 
 {% hint style="danger" %}
-Never use the same master key on multiple nodes at once.  You may find your nodes exposed to double-spend issues and severe slashing.
+Never use the same master key on multiple nodes at once. You may find your nodes exposed to double-spend issues and severe slashing.
 {% endhint %}
 
 ## Customize the configuration if needed
@@ -296,8 +292,6 @@ nano ~/.witnet/config/witnet.toml
 
 ## Long term maintenance of your node
 
-
-
 There are some operations that are recommended from time to time to make sure your node is in perfect order:
 
 * Give a look to the result of the `nodeStats`, `balance` and `reputation` commands.

node-operators/requirements.md

@@ -1,4 +1,4 @@
-# Requirements
+# 🖥 Requirements
 
 {% hint style="success" %}
 **The Witnet mainnet is a totally permissionless and open network.**

smart-contracts/apis-and-http-get-post-oracle/README.md

@@ -1,2 +1,2 @@
-# APIs and HTTP GET/POST Oracle
+# 📰 APIs and HTTP GET/POST Oracle
 

smart-contracts/witnet-data-feeds/README.md

@@ -1,2 +1,2 @@
-# Witnet Price Feeds
+# 📈 Witnet Price Feeds
 

smart-contracts/witnet-randomness-oracle/README.md

@@ -1,8 +1,8 @@
-# Witnet Randomness Oracle
+# 🔄 Witnet Randomness Oracle
 
 ### Why Randomness Oracles?
 
-There are a number of smart contracts use cases that require some degree of randomness,  unpredictability or uniqueness. 
+There are a number of smart contracts use cases that require some degree of randomness, unpredictability or uniqueness.
 
 For example, a smart contract that automatically generates items inside an NFT collection will need a source of randomness to assign different traits in such a way that each of the items in the collection are unique and cannot be predicted before minting.