gogo/apxtri
1
0
Fork 0
Code Pull Requests Activity

clarify doc

Browse Source
This commit is contained in:
gogo
2025-01-07 19:59:21 +01:00
parent 62a75d353e
commit bf8d5dfac6
1 changed files with 49 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
README.md
View File

@@ -1,22 +1,36 @@
## Apxtri
Tool to create online infrastructure (like websites chats, etc...) that are:
- censorship resilient
- community friendly due to a common rule set to avoid abuses
- hostless: neither self-hosted, nor cloud hosted. Only hosted by the users.
- immutable: a website/chat/etc... service could not be modified... No possibility to be bought by microsoft ;)
## apxtri  Decentralized Autonomous Organisation (DAO) ## apxtri  Decentralized Autonomous Organisation (DAO)
Welcome to the technical side of apxtri, where you'll learn how it works and how you can contribute. Visit [apxtri web site](https://apxtri.crabdance.com) to discover how to create a new social world with apxtri. Welcome to the technical side of apxtri, where you'll learn how it works and how you can contribute. Visit [apxtri web site](https://apxtri.crabdance.com) to discover how to create a new social world with apxtri.
## apxtri Architecture: a quick view & keywords definition ## apxtri Architecture: a quick view
Each user has an unique identification create by anyone based on PGP (public/Private key) and an alias (humanly understandable) that allow a member to proof that he owns data. Can be anonymous but all his actions are store into a blockchain of reputation.
He could join a community to communicate with these people. (We sometimes unformally call this community a `tribe` for fun).
One of the user of each community could become a `moderator` to apply the rules of the `tribe`
User could "mine" `the XTRIB coin` to host.
We are currently debating if the user could also mine the network to ensure security or if he should not as we could be using a p2p consensus `proof of trust` to minimize the data.
We are also debating if the netwrok must be accessible online by minner of if we should not use a `small world network` consensus to minimize mining cost.
* **a nation** is a topology network of nodes town that share the same fundamental rules (engrave into a common blockchain).
* **a town** is a physical installation node of linux server plug into a LAN network (a telecom box NAT conf) accessible from a WAN network (domain name redirect to a town public IP).
* **a tribe** has a unique name and is a space to host data to apply specific algo rule register at the creation of a tribe by a druid that respect the town rules
* **a pagan** 'village farmer' is a unique identification create by anyone based on PGP (public/Private key) and a unique alias (for human) that allow a member to proof that he owns this identity. Can be anonymous but all his actions are store into a blockchain of reputation link to this unique ID.
* **a druid** 'rules master' is a pagan that owned and defined rules of a tribe, he owns a domain name (DNS) to make it tribe's data accessible over the net. As pagan he can be anonymous, he is responsible of the tribe activities and can ban a pagan of his tribe. Any pagan become a druid when he decides to create a tribe by requesting a town mayor
* **a mayor** is a owner of a physical machine, he is in charge to make a town node working (IP availibily) and accept to be part of a nation (rules of the blockchain nation).
* **a contract** is an algorythme that is written into the blockchain and will be run if an action trig. Immutable contract are the one link to the blockchain. Any pagan/druid/major can defined a contract that apply to other pagans.
* **the XBE coin** is the token that drive the blockchain, it materialises an exchange value and is a conterpoint
* **a git apxtri** is a package ready to install a town by a mayor into a physical server that will be able to join a nation (mean accept thoses nation rules). You can also create a nation and stay alone or not. Then mayor will be able to host druid request to create tribe. Then druid will invite pagan to join his tribe...
All actors will have the same target to respect contracts and are free to leave or to stay into a nation, a town or a tribe. Unfair contracts lead to empty towns, tribes, or nations, resulting in no value creation. Only fair rules will survive, rewarding actors with XTRIB coins. All actors will have the same target to respect contracts and are free to leave or to stay into a nation, a town or a tribe. Unfair contracts lead to empty towns, tribes, or nations, resulting in no value creation. Only fair rules will survive, rewarding actors with XTRIB coins.
The projects is modular and is code clarity focused. APxtri uses an MVC to ensure maintanability of the project.
```plaintext ```plaintext
/town-nation/ tribe sapce /town-nation/ tribe sapce
/conf.json town conf express.js /conf.json town conf express.js
@@ -230,3 +244,27 @@ Community managers and user
Trainer / Teacher Trainer / Teacher
* Teach blockchain and alternative currency system (Monero, bitcoin, xbe…) and * Teach blockchain and alternative currency system (Monero, bitcoin, xbe…) and
## deprecated: apXtrib Architecture a quick view & keywords definition
There used to be some keyword that used to have a specific definition in apxtri. In 2025, it has been decided to have a more explicit terminology based on words not apxtri related. The next typology is deprecated. It could still (but we do not hope) be present in the developper discussion.
1. users:
- user roles:
* **a pagan** 'village farmer', user keypair: is a unique identification create by anyone based on PGP (public/Private key) and a unique alias (for human) that allow a member to proof that he owns this identity. Can be anonymous but all his actions are store into a blockchain of reputation link to this unique ID.
* **a druid** 'rules master', community moderator: is a pagan that owned and defined rules of a tribe, he owns a domain name (DNS) to make it tribe's data accessible over the net. As pagan he can be anonymous, he is responsible of the tribe activities and can ban a pagan of his tribe. Any pagan become a druid when he decides to create a tribe by requesting a town mayor.
* **a nation**, now know as community: is a topology network of nodes town that share the same fundamental rules (engrave into a common blockchain).
- miner roles:
* **a mayor**, gateway miner: is a owner of a physical machine, he is in charge to make a town node working (IP availibily) and accept to be part of a nation (rules of the blockchain nation).
2. infrastructure:
* **a town**, gateway miner infras: is a physical installation node of linux server plug into a LAN network (a telecom box NAT conf) accessible from a WAN network (domain name redirect to a town public IP).
* **a tribe**, data storage miner infrastructure id: has a unique name and is a space to host data to apply specific algo rule register at the creation of a tribe by a druid that respect the town rules.
* **a contract**, is an algorythme that is written into the blockchain and will be run if an action trig. Immutable contract are the one link to the blockchain. Any pagan/druid/major can defined a contract that apply to other pagans.
3. coin/token:
* **the XBE coin**, miner token: It is the token that drive the blockchain, it materialises an exchange value and is a conterpoint
4. packaging:
* **a git apxtri**, package was a package ready to install a town by a mayor into a physical server that will be able to join a nation (mean accept thoses nation rules). You can also create a nation and stay alone or not. Then mayor will be able to host druid request to create tribe. Then druid will invite pagan to join his tribe...