github/darkfi
1
1
Fork 0
mirror of https://github.com/darkrenaissance/darkfi.git synced 2026-01-08 22:28:12 -05:00
Code Issues Packages Projects Releases Wiki Activity

doc: Fix mdbook build with latest mdbook version

Browse Source
This commit is contained in:
x
2025-12-29 15:00:37 +00:00
parent 1d28313dfd
commit ee68360232
4 changed files with 44 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/book.toml
View File

@@ -1,12 +1,12 @@
[book]
authors = ["DarkFi"]
language = "en"
multilingual = false
src = "src"
title = "The DarkFi Book"
description = "DarkFi mdbook"
text-direction = "ltr"
[output.html]
copy-fonts = true
default-theme = "ayu"
preferred-dark-theme = "ayu"
theme = "theme"

1
doc/latex-macros.txt
View File

@@ -7,4 +7,3 @@
\cY:{\mathcal{Y}}
\ran:{\textrm{ran}}
\max:{\textrm{max}}

4
doc/src/crypto/rln.md
View File

@@ -127,13 +127,13 @@ $$ a_0 = \sum_{j=0}^{k-1} y_j \prod_{\begin{smallmatrix} m\,=\,0 \\ m\,\ne\,j \e
### Interaction
```zkas
{{#include ../../../script/research/rln/rlnv1/signal.zk}}
{{#include ../../../script/research/rlnv2/signal.zk}}
```
### Slashing
```zkas
{{#include ../../../script/research/rln/rlnv1/slash.zk}}
{{#include ../../../script/research/rlnv2/slash.zk}}
```
[^1]: <https://en.wikipedia.org/wiki/Shamir's_Secret_Sharing>

81
doc/src/misc/darkirc/specification.md
View File

@@ -1,4 +1,3 @@
# darkirc Specification
## PrivMsgEvent
@@ -7,11 +6,11 @@ This is the main message type inside `darkirc`. The `PrivMsgEvent` is an
[event action](../event_graph/network_protocol.md#event).
| Description | Data Type | Comments |
|-------------- |-------------- | ------------------------------------------------------------------------- |
| nickname | String | The nickname for the sender (must be less than 32 chars) |
| target | String | The target for the message (recipient) |
| message | String | The actual content of the message |
| Description | Data Type | Comments |
|---------------|------------|------------------------------------------------------------|
| `nickname` | `String` | The nickname for the sender (must be less than 32 chars) |
| `target` | `String` | The target for the message (recipient) |
| `message` | `String` | The actual content of the message |
## ChannelInfo
@@ -25,12 +24,12 @@ secret = "GvH4kno3kUu6dqPrZ8zjMhqxTUDZ2ev16EdprZiZJgj1"
topic = "DarkFi Development Channel"
```
| Description | Data Type | Comments |
|-------------- |-------------- | ------------------------------------------------------------------------- |
| topic | String | Optional topic for the channel |
| secret | String | Optional NaCl box for the channel, used for {en,de}cryption. |
| joined | bool | Indicate whether the user has joined the channel |
| names | Vec<String> | All nicknames which are visible on the channel |
| Description | Data Type | Comments |
|--------------|---------------| --------------------------------------------------------------|
| `topic` | `String` | Optional topic for the channel |
| `secret` | `String` | Optional NaCl box for the channel, used for {en,de}cryption. |
| `joined` | `bool` | Indicate whether the user has joined the channel |
| `names` | `Vec<String>` | All nicknames which are visible on the channel |
## ContactInfo
@@ -44,28 +43,28 @@ In the TOML configuration file, the contact is set as such:
contact_pubkey = "7CkVuFgwTUpJn5Sv67Q3fyEDpa28yrSeL5Hg2GqQ4jfM"
```
| Description | Data Type | Comments |
|-------------- |-------------- | ----------------------------------------------------- |
| pubkey | String | A Public key for the contact to encrypt the message |
| Description | Data Type | Comments |
|---------------|---------------| -----------------------------------------------------|
| `pubkey` | `String` | A Public key for the contact to encrypt the message |
## IrcConfig
The base Irc configuration for each new `IrcClient`.
| Description | Data Type | Comments |
|-------------- |-------------------------------- | ------------------------------------------------------------------------------- |
| is_nick_init | bool | Confirmation of receiving /nick command |
| is_user_init | bool | Confirmation of receiving /user command |
| is_cap_end | bool | Indicate whether the irc client finished the Client Capability Negotiation |
| is_pass_init | bool | Confirmation of checking the password in the configuration file |
| is_registered | bool | Indicate the `IrcClient` is initialized and ready to sending/receiving messages |
| nickname | String | The irc client nickname |
| password | String | The password for the irc client. (it could be empty) |
| private_key | Option<String> | A private key to decrypt direct messages from contacts |
| capabilities | HashMap<String, bool> | A list of capabilities for the irc clients and the server to negotiate |
| auto_channels | Vec<String> | Auto join channels for the irc clients |
| channels | HashMap<String, `ChannelInfo`> | A list of preconfigured channels in the configuration file |
| contacts | HashMap<String, `ContactInfo`> | A list of preconfigured contacts in the configuration file for direct message |
| Description | Data Type | Comments |
|-----------------|-------------------------------- | --------------------------------------------------------------------------------|
| `is_nick_init` | `bool` | Confirmation of receiving /nick command |
| `is_user_init` | `bool` | Confirmation of receiving /user command |
| `is_cap_end` | `bool` | Indicate whether the irc client finished the Client Capability Negotiation |
| `is_pass_init` | `bool` | Confirmation of checking the password in the configuration file |
| `is_registered` | `bool` | Indicate the `IrcClient` is initialized and ready to sending/receiving messages |
| `nickname` | `String` | The irc client nickname |
| `password` | `String` | The password for the irc client. (it could be empty) |
| `private_key` | `Option<String>` | A private key to decrypt direct messages from contacts |
| `capabilities` | `HashMap<String, bool>` | A list of capabilities for the irc clients and the server to negotiate |
| `auto_channels` | `Vec<String>` | Auto join channels for the irc clients |
| `channels` | `HashMap<String, ChannelInfo>` | A list of preconfigured channels in the configuration file |
| `contacts` | `HashMap<String, ContactInfo>` | A list of preconfigured contacts in the configuration file for direct message |
## IrcServer
@@ -73,23 +72,23 @@ The server start listening to an address specifed in the configuration file.
For each irc client get connected, an `IrcClient` instance created.
| Description | Data Type | Comments |
|-------------------------- |------------------------------ | ----------------------------------------------------- |
| settings | `Settings` | The base settings parsed from the configuration file |
| clients_subscriptions | SubscriberPtr<`ClientSubMsg`> | Channels to notify the `IrcClient`s about new data |
| Description | Data Type | Comments |
|---------------------------|-------------------------------| ------------------------------------------------------|
| `settings` | `Settings` | The base settings parsed from the configuration file |
| `clients_subscriptions` | `SubscriberPtr<ClientSubMsg>` | Channels to notify the `IrcClient`s about new data |
## IrcClient
The `IrcClient` handle all irc opeartions and commands from the irc client.
| Description | Data Type | Comments |
|-------------------------- |------------------------------ | ----------------------------------------------------- |
| write_stream | WriteHalf<Stream> | A writer for sending data to the connection stream |
| read_stream | ReadHalf<Stream> | Read data from the connection stream |
| address | SocketAddr | The actual address for the irc client connection |
| irc_config | `IrcConfig` | Base configuration for irc |
| server_notifier | Channel<(`NotifierMsg`, u64)> | A Channel to notify the server about a new data from the irc client |
| subscription | Subscription<`ClientSubMsg`> | A channel to receive notification from the server |
| Description | Data Type | Comments |
|-------------------|-------------------------------|---------------------------------------------------------------------------|
| `write_stream` | `WriteHalf<Stream>` | A writer for sending data to the connection stream |
| `read_stream` | `ReadHalf<Stream>` | Read data from the connection stream |
| `address` | `SocketAddr` | The actual address for the irc client connection |
| `irc_config` | `IrcConfig` | Base configuration for irc |
| `server_notifier` | `Channel<(NotifierMsg, u64)>` | A Channel to notify the server about a new data from the irc client |
| `subscription` | `Subscription<ClientSubMsg>` | A channel to receive notification from the server |
## Communications between the server and the clients