4nk/sdk_common
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Syntax (doc)

Browse Source
This commit is contained in:
NicolasCantu 2024-02-16 18:21:40 +01:00
parent ea801d3b6e
commit ac509abf3f
2 changed files with 205 additions and 204 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/PRD-PCD-Specs.md
View File

@ -27,7 +27,7 @@
* 11. [RequestPrdResponse - Répondre à une Demande](#RequestPrdResponse-RpondreuneDemande) * 11. [RequestPrdResponse - Répondre à une Demande](#RequestPrdResponse-RpondreuneDemande)
* 11.1. [Création et envoi](#Crationetenvoi-1) * 11.1. [Création et envoi](#Crationetenvoi-1)
* 11.2. [Réception](#Rception-1) * 11.2. [Réception](#Rception-1)
* 12. [RequestPrdKeyHelloBakcup](#RequestPrdKeyHelloBakcup) * 12. [RequestPrdKeyBakcup](#RequestPrdKeyBakcup)
* 12.1. [Création et envoi](#Crationetenvoi-1) * 12.1. [Création et envoi](#Crationetenvoi-1)
* 12.2. [Réception](#Rception-1) * 12.2. [Réception](#Rception-1)
* 13. [RequestPrdKeyHello - Échange de Clés et d'Identités](#RequestPrdKeyHello-changedeClsetdIdentits) * 13. [RequestPrdKeyHello - Échange de Clés et d'Identités](#RequestPrdKeyHello-changedeClsetdIdentits)
@ -239,7 +239,6 @@ Les `RequestPrdUpdate` signalent au réseau via l'attribut `RequestPcd_new_versi
### 9.2. <a name='Rception-1'></a>Réception ### 9.2. <a name='Rception-1'></a>Réception
La réception d'un `RequestPrdUpdate` suit plusieurs étapes : La réception d'un `RequestPrdUpdate` suit plusieurs étapes :
1. Traitements des `RequestPrd` 1. Traitements des `RequestPrd`
@ -282,7 +281,7 @@ Aussi le moyen de demander des moyens de paiement ou de dépot ou de preuve, pui
1. Traitements des `RequestPrd` 1. Traitements des `RequestPrd`
2. Notification de l'utilisateur. 2. Notification de l'utilisateur.
## 12. <a name='RequestPrdKeyHelloBakcup'></a>RequestPrdKeyBakcup ## 12. <a name='RequestPrdKeyBakcup'></a>RequestPrdKeyBakcup
Le RequestPrdKeyHelloBakcup permet de demander la stockage de nouveaux shards associés à une `pre-id` . Le RequestPrdKeyHelloBakcup permet de demander la stockage de nouveaux shards associés à une `pre-id` .

46
doc/Specs-Datamodel.md
View File

@ -79,17 +79,17 @@
* 11.2.10. [RoleDeposit](#RoleDeposit) * 11.2.10. [RoleDeposit](#RoleDeposit)
* 11.2.11. [RoleCommitment](#RoleCommitment) * 11.2.11. [RoleCommitment](#RoleCommitment)
* 11.2.12. [RoleMember](#RoleMember) * 11.2.12. [RoleMember](#RoleMember)
* 11.2.13. [RolePayment](#RolePayment) * 11.3. [RolePeer](#RolePeer)
* 11.2.14. [RoleProcess](#RoleProcess) * 11.3.1. [RolePayment](#RolePayment)
* 11.3. [TransactionMode](#TransactionMode) * 11.3.2. [RoleProcess](#RoleProcess)
* 11.4. [RolePeer](#RolePeer) * 11.4. [TransactionMode](#TransactionMode)
* 12. [12. Rust considerations](#Rustconsiderations) * 12. [12. Rust considerations](#Rustconsiderations)
* 12.1. [ General Implications for Project Objects](#GeneralImplicationsforProjectObjects) * 12.1. [General Implications for Project Objects](#GeneralImplicationsforProjectObjects)
* 12.2. [ Debug](#Debug) * 12.2. [Debug](#Debug)
* 12.3. [ Default](#Default) * 12.3. [Default](#Default)
* 12.4. [ PartialEq, Eq](#PartialEqEq) * 12.4. [PartialEq, Eq](#PartialEqEq)
* 12.5. [ Hash](#Hash) * 12.5. [Hash](#Hash)
* 12.6. [ PartialOrd, Ord](#PartialOrdOrd) * 12.6. [PartialOrd, Ord](#PartialOrdOrd)
* 13. [Todo](#Todo) * 13. [Todo](#Todo)
<!-- vscode-markdown-toc-config <!-- vscode-markdown-toc-config
@ -101,6 +101,7 @@
## 1. <a name='Documentsderfrence'></a>Documents de référence ## 1. <a name='Documentsderfrence'></a>Documents de référence
Voir [Doc_references.md](Doc_references.md). Voir [Doc_references.md](Doc_references.md).
## 2. <a name='Methods'></a>Methods ## 2. <a name='Methods'></a>Methods
### 2.1. <a name='DepositMethod'></a>DepositMethod ### 2.1. <a name='DepositMethod'></a>DepositMethod
@ -948,7 +949,16 @@ The `RoleCommitment` struct details the role associated with commitments, deline
| `item_name` | ```String``` | | The name of the item associated with the member. | | `item_name` | ```String``` | | The name of the item associated with the member. |
| `role` | ```Role``` | | The role associated with this member. | | `role` | ```Role``` | | The role associated with this member. |
#### 11.2.13. <a name='RolePayment'></a>RolePayment ### 11.3. <a name='RolePeer'></a>RolePeer
The `RolePeer` struct identifies peers associated with specific roles, detailing their identifiers, associated peers, and metadata, essential for defining peer responsibilities and permissions within the networked environment.
| Attribute Name | Type | Option | Description |
|----------------|--------------|--------|------------------------------------------------|
| `item_name` | ```String``` | | The name of the item associated with the peer. |
| `role` | ```Role``` | | The role associated with this peer. |
#### 11.3.1. <a name='RolePayment'></a>RolePayment
The `RolePayment` struct is dedicated to defining the role related to payments, outlining the specific tasks, permissions, and responsibilities assigned to entities handling or involved in payment transactions, ensuring secure and orderly payment processes. The `RolePayment` struct is dedicated to defining the role related to payments, outlining the specific tasks, permissions, and responsibilities assigned to entities handling or involved in payment transactions, ensuring secure and orderly payment processes.
@ -957,7 +967,7 @@ The `RolePayment` struct is dedicated to defining the role related to payments,
| `item_name` | ```String``` | | The name of the item associated with the payment. | | `item_name` | ```String``` | | The name of the item associated with the payment. |
| `role` | ```Role``` | | The role associated with this payment. | | `role` | ```Role``` | | The role associated with this payment. |
#### 11.2.14. <a name='RoleProcess'></a>RoleProcess #### 11.3.2. <a name='RoleProcess'></a>RoleProcess
`RoleProcess` describes the role associated with processes within the system. It specifies the expectations, duties, and permissions of entities that initiate, manage, or participate in various system processes, facilitating smooth and regulated process flow. `RoleProcess` describes the role associated with processes within the system. It specifies the expectations, duties, and permissions of entities that initiate, manage, or participate in various system processes, facilitating smooth and regulated process flow.
@ -965,7 +975,8 @@ The `RolePayment` struct is dedicated to defining the role related to payments,
|----------------|--------------|--------|---------------------------------------------------| |----------------|--------------|--------|---------------------------------------------------|
| `item_name` | ```String``` | | The name of the item associated with the process. | | `item_name` | ```String``` | | The name of the item associated with the process. |
| `role` | ```Role``` | | The role associated with this process. | | `role` | ```Role``` | | The role associated with this process. |
### 11.3. <a name='TransactionMode'></a>TransactionMode
### 11.4. <a name='TransactionMode'></a>TransactionMode
`TransactionMode` and its specific types (Distribution, Direct) describe how transactions are handled within the system, whether through direct communication or distributed across multiple entities, influencing the flow and security of transactions. `TransactionMode` and its specific types (Distribution, Direct) describe how transactions are handled within the system, whether through direct communication or distributed across multiple entities, influencing the flow and security of transactions.
@ -978,15 +989,6 @@ The `RolePayment` struct is dedicated to defining the role related to payments,
| `to_type` | ```String``` | | Soit "addresses" soit "roles" | | `to_type` | ```String``` | | Soit "addresses" soit "roles" |
| `to_method` | ```String``` | | Méthode de distribution de la somme des versements : "Amount divided" ou "Same Amount" | | `to_method` | ```String``` | | Méthode de distribution de la somme des versements : "Amount divided" ou "Same Amount" |
### 11.4. <a name='RolePeer'></a>RolePeer
The `RolePeer` struct identifies peers associated with specific roles, detailing their identifiers, associated peers, and metadata, essential for defining peer responsibilities and permissions within the networked environment.
| Attribute Name | Type | Option | Description |
|----------------|--------------|--------|------------------------------------------------|
| `item_name` | ```String``` | | The name of the item associated with the peer. |
| `role` | ```Role``` | | The role associated with this peer. |
## 12. <a name='Rustconsiderations'></a>12. Rust considerations ## 12. <a name='Rustconsiderations'></a>12. Rust considerations
### 12.1. <a name='GeneralImplicationsforProjectObjects'></a> General Implications for Project Objects ### 12.1. <a name='GeneralImplicationsforProjectObjects'></a> General Implications for Project Objects