Skip to content
Snippets Groups Projects
Commit 4482c9c7 authored by inso's avatar inso
Browse files

Update docs

parent 3a9c7831
No related branches found
No related tags found
No related merge requests found
Showing with 40 additions and 289 deletions
doc/uml/access.png

7.08 KiB

@startuml
class IdentitiesAccess << (A,lightgreen) >> {
}
class CertificationAccess << (A,lightgreen) >> {
}
class TransactionAccess << (A,lightgreen) >> {
}
class CommunityAccess << (A,lightgreen) >> {
}
class BlockchainAccess << (A,lightgreen) >> {
}
@enduml
\ No newline at end of file
doc/uml/api.png

13.1 KiB

@startuml
package api {
package api.bma {
class BMADataAccess {
{static} _cache
{static} _request(req : Request, network)
{static} _post(req : Request, network)
{static} _broadcast(req : Request, network)
}
BMADataAccess ..> api.bma.API
}
package api.es {
class ESDataAccess {
}
ESDataAccess ..> api.es.API
}
}
@enduml
\ No newline at end of file
doc/uml/backend.png

168 KiB | W: | H:

doc/uml/backend.png

187 KiB | W: | H:

doc/uml/backend.png
doc/uml/backend.png
doc/uml/backend.png
doc/uml/backend.png
  • 2-up
  • Swipe
  • Onion skin
@startuml @startuml
!include data.pu !include data.pu
!include access.pu !include processors.pu
!include services.pu !include services.pu
ProfileService "1" --> "1" UserParameters ProfileService "1" --> "1" UserParameters
...@@ -12,39 +12,39 @@ AccountService "*" --> "1" KeyRepo ...@@ -12,39 +12,39 @@ AccountService "*" --> "1" KeyRepo
TransactionsService "1" --> "*" Transaction TransactionsService "1" --> "*" Transaction
TransactionsService "*" --> "1" TransactionAccess TransactionsService "*" --> "1" TransactionProcessor
TransactionAccess "1" --> "1" TransactionRepo TransactionProcessor "1" --> "1" TransactionRepo
RegistryService "1" --> "*" Identity RegistryService "1" --> "*" Identity
RegistryService "1" --> "*" Certification RegistryService "1" --> "*" Certification
RegistryService "*" --> "1" IdentitiesAccess RegistryService "*" --> "1" IdentitiesProcessor
IdentitiesAccess "1" --> "1" IdentitiesRepo IdentitiesProcessor "1" --> "1" IdentitiesRepo
RegistryService "*" --> "1" CertificationAccess RegistryService "*" --> "1" CertificationProcessor
CertificationAccess "1" --> "1" CertificationRepo CertificationProcessor "1" --> "1" CertificationRepo
NetworkService "1" --> "*" Node NetworkService "1" --> "*" Node
NetworkService "*" --> "1" NodeRepo NetworkService "*" --> "1" NodeRepo
BlockchainService "1" --> "1" Blockchain BlockchainService "1" --> "1" Blockchain
BlockchainService "1" --> "1" Community BlockchainService "1" --> "1" Community
BlockchainService "*" --> "1" BlockchainAccess BlockchainService "*" --> "1" BlockchainProcessor
BlockchainAccess "1" --> "1" BlockchainRepo BlockchainProcessor "1" --> "1" BlockchainRepo
BlockchainService "*" --> "1" CommunityAccess BlockchainService "*" --> "1" CommunityProcessor
CommunityAccess "1" --> "1" CommunityRepo CommunityProcessor "1" --> "1" CommunityRepo
package API { package Connectors {
class BMAAccess << (S,cyan) >> { class BMAConnector << (S,cyan) >> {
get() get()
post() post()
broadcast() broadcast()
} }
} }
AccountService --> BMAAccess AccountService --> BMAProcessor
BlockchainAccess --> BMAAccess BlockchainProcessor --> BMAProcessor
CommunityAccess --> BMAAccess CommunityProcessor --> BMAProcessor
TransactionAccess --> BMAAccess TransactionProcessor --> BMAProcessor
IdentitiesAccess --> BMAAccess IdentitiesProcessor --> BMAProcessor
CertificationAccess --> BMAAccess CertificationProcessor --> BMAProcessor
@enduml @enduml
\ No newline at end of file
doc/uml/core-classes.png

23.6 KiB

@startuml
hide fields
hide methods
package core {
class App {
-- Signals --
current_account_changed(str : account_name)
data_changed()
-- Slots --
-- Properties --
current_account
accounts
-- Methods --
}
App --* Account : accounts
class Account {
-- Signals --
wallets_changed(int : nb_wallets)
community_added(int : index)
community_removed(int : index)
data_changed()
-- Slots --
-- Properties --
communities
wallets
-- Methods --
}
Account "1" --* "*" Wallet
Account "1" --* "*" Community
class Wallet {
-- Signals --
money_received(Transfer)
money_sent(Transfer)
name_changed(str : new_name
data_changed()
-- Slots --
-- Properties --
transfers
-- Methods --
}
Wallet "1" --* "*" Transfer
class Transfer {
-- Signals --
state_changed(int : new_state)
-- Slots --
-- Properties --
-- Methods --
}
class Community {
-- Signals --
members_changed()
data_changed()
-- Slots --
-- Properties --
network
-- Methods --
}
App --> Identity
class Identity {
{static} _identities
{static} load(data : dict)
{static} lookup(search : str)
}
}
package net {
class Network {
-- Signals --
node_found(int : index)
node_removed(int : index)
block_found(int : block_number)
-- Slots --
-- Properties --
nodes
root_nodes
-- Methods --
}
Community "1" --* "1" Network
Network "1" --* "*" Node
class Node {
-- Signals --
changed()
-- Slots --
-- Properties --
endpoints
pubkey
uid
block
state
-- Methods --
}
Network "1" --* "1" BmaAccess
class BmaAccess {
}
}
@enduml
doc/uml/cutecoin.png

131 KiB

@startuml
!include core-classes.pu
!include gui-classes.pu
!include models-classes.pu
!include api.pu
MainWindow "1" --> "1" App
CertificationDialog --> Community
TransferDialog --> Community
CurrencyTab "1" --> "1" Community
CommunityTab -right-> IdentitiesFilterProxyModel
NetworkTab -right-> NetworkFilterProxyModel
WalletTab -right-> WalletsFilterProxyModel
WalletsFilterProxyModel -up-> Wallet
NetworkFilterProxyModel -up-> Network
TxHistoryFilterProxyModel -up-> Transfer
ConfigureAccountDialog --> CommunitiesListModel
ConfigureCommunityDialog --> RootNodesTableModel
ConfigureAccountDialog --> Account
ConfigureCommunityDialog --> Community
Account ..> BMADataAccess
Community ..> BMADataAccess
Wallet ..> BMADataAccess
Transfer ..> BMADataAccess
Identity ..> BMADataAccess
BMADataAccess .left.> Network
@enduml
\ No newline at end of file
doc/uml/data.png

54 KiB | W: | H:

doc/uml/data.png

56.4 KiB | W: | H:

doc/uml/data.png
doc/uml/data.png
doc/uml/data.png
doc/uml/data.png
  • 2-up
  • Swipe
  • Onion skin
@startuml @startuml
class Identity << (D,orchid) >> { class Identity << (D,orchid) >> {
currency: str (FK) currency: str (FK)
uid: str uid: str
...@@ -9,6 +8,8 @@ class Identity << (D,orchid) >> { ...@@ -9,6 +8,8 @@ class Identity << (D,orchid) >> {
blockstamp: BlockUID blockstamp: BlockUID
timestamp: int timestamp: int
signature: str signature: str
written: bool
revoked: bool
member: bool member: bool
membership_buid: BlockUID membership_buid: BlockUID
membership_timestamp: int membership_timestamp: int
......
doc/uml/gui-classes.png

31.2 KiB

@startuml
package gui {
class MainWindow {
}
MainWindow "1" --* "1" CommunityView
class CommunityView {
}
CommunityView "1" --* "1" WalletTab
CommunityView "1" -down-* "1" InformationsTab
CommunityView "1" --* "1" TransactionsTab
CommunityView "1" --* "1" IdentitiesTab
CommunityView "1" --* "1" WotTab
CommunityView "1" -down-* "1" NetworkTab
class WalletTab {
}
class InformationsTab {
}
class TransactionsTab {
}
class NetworkTab {
}
class IdentitiesTab {
}
class WotTab {
}
package dialogs {
class CertificationDialog
class TransferDialog
class ContactDialog
class ConfigureAccountDialog
class ConfigureCommunityDialog
}
MainWindow --> CertificationDialog
MainWindow --> TransferDialog
MainWindow --> ContactDialog
MainWindow --> ConfigureAccountDialog
ConfigureAccountDialog --> ConfigureCommunityDialog
}
@enduml
doc/uml/models-classes.png

15.3 KiB

@startuml
package models {
class WalletsFilterProxyModel {
}
WalletsFilterProxyModel --> WalletsTableModel : source
class WalletsTableModel {
}
class IdentitiesFilterProxyModel {
}
IdentitiesFilterProxyModel --> IdentitiesTableModel : source
class IdentitiesTableModel {
}
class NetworkFilterProxyModel {
}
NetworkFilterProxyModel --> NetworkTableModel : source
class NetworkTableModel {
}
class TxHistoryFilterProxyModel {
}
TxHistoryFilterProxyModel --> TxHistoryTableModel : source
class TxHistoryTableModel {
}
class CommunitiesListModel {
}
class RootNodesTableModel {
}
}
@enduml
\ No newline at end of file
doc/uml/network.png

21.7 KiB | W: | H:

doc/uml/network.png

21.7 KiB | W: | H:

doc/uml/network.png
doc/uml/network.png
doc/uml/network.png
doc/uml/network.png
  • 2-up
  • Swipe
  • Onion skin
doc/uml/processors.png

9.94 KiB

@startuml
class IdentitiesProcessor << (P,lightgreen) >> {
find_identities()
find_certifiers_of()
find_certified_by()
}
class CertificationProcessor << (P,lightgreen) >> {
}
class TransactionProcessor << (P,lightgreen) >> {
}
class CommunityProcessor << (P,lightgreen) >> {
}
class BlockchainProcessor << (P,lightgreen) >> {
}
@enduml
\ No newline at end of file
doc/uml/requests.png

26 KiB | W: | H:

doc/uml/requests.png

26 KiB | W: | H:

doc/uml/requests.png
doc/uml/requests.png
doc/uml/requests.png
doc/uml/requests.png
  • 2-up
  • Swipe
  • Onion skin
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment