peeramid-labs
diff --git a/‎.changeset/silly-seahorses-tickle.md
+30 b/‎.changeset/silly-seahorses-tickle.md
+30
diff --git a/‎.github/workflows/main.yml
+5-1 b/‎.github/workflows/main.yml
+5-1
diff --git a/‎README.md
+96-26 b/‎README.md
+96-26
diff --git a/‎deploy/01_deployRankToken.ts
-29 b/‎deploy/01_deployRankToken.ts
-29
diff --git a/‎deploy/02_deployRankify.ts
+1-1 b/‎deploy/02_deployRankify.ts
+1-1
diff --git a/‎deploy/03_deployGame.ts
-115 b/‎deploy/03_deployGame.ts
-115
diff --git a/‎deploy/04_upgradeGame.ts
-31 b/‎deploy/04_upgradeGame.ts
-31
diff --git a/‎deploy/06_deoployMultipass.ts
+1-1 b/‎deploy/06_deoployMultipass.ts
+1-1
@@ -0,0 +1,30 @@
+---
+'rankify-contracts': minor
+---
+
+## Addition of Ethereum Distribution System (EDS)
+
+- **Feature**: Integrated the Ethereum Distribution System (EDS) for distributing Rankify contracts.
+- **Description**: Rankify contracts are now distributed via the Ethereum Distribution System, enhancing the efficiency and security of the distribution process.
+
+## Redesign of Contracts
+
+- **Feature**: Redesigned contracts to work seamlessly as part of the Ethereum Distribution System.
+- **Description**: The contracts have been restructured and optimized to ensure compatibility and smooth operation within the EDS framework. This redesign includes:
+  - Improved contract architecture for better integration with EDS.
+  - Enhanced security measures to protect against potential vulnerabilities.
+  - Optimized performance to handle the distribution process more efficiently.
+
+## Impact
+
+- **Users**:
+  -  Can create new subjects that are called Meritocratic Autonomous Organizations (MAOs).
+  -  Will benefit from a more secure and efficient distribution process.
+- **Developers**: Developers will need to familiarize themselves with the new contract architecture and EDS integration.
+- **Operations**: The distribution process will be streamlined, reducing the potential for errors and improving overall system reliability.
+
+## Next Steps
+
+- **Documentation**: Update the documentation to include details on the new EDS integration and contract redesign.
+- **Testing**: Conduct thorough testing to ensure the new system operates as expected.
+- **Deployment**: Plan and execute the deployment of the updated contracts and distribution system.
@@ -1,8 +1,11 @@
 name: CI
-on: 
+on:
   pull_request:
     branches: [main,staging]
     types: [opened, reopened, labeled, synchronize]
+env:
+    FORK_RPC_URL: ${{ secrets.FORK_RPC_URL }}
+    NODE_ENV: 'TEST'
 jobs:
   lint:
     runs-on: ubuntu-latest
@@ -22,3 +25,4 @@ jobs:
 
       - name: Running tests
         run: pnpm test:parallel
+
@@ -1,40 +1,111 @@
-# Rankify smart contracts
-![rankToken_resize](https://github.com/rankify-it/contracts/assets/61459744/82d4496e-7e46-47ee-8f2f-2fca6d3c30b8)
+### Installation
 
-Welcome to the Rankify Smart Contracts repository. This project contains the smart contracts used for the Rankify platform.
+1. Clone the repository:
 
-## Overview
+   ```sh
+   git clone https://github.com/rankify-it/contracts.git
+   cd contracts
+   ```
 
-Rankify is a decentralized platform that leverages blockchain technology to provide generic, transparent and sybil resistent rating systems for various applications. The platform allows users to create and participate in rankings, and earn rewards based on their contributions.
+2. Install dependencies:
 
+   ```sh
+   pnpm install
+   ```
 
-## Getting Started
+3. Setup environment variables
 
-To get started with Rankify smart contracts, follow the instructions below.
+   ```sh
+   mkdir .secrets
+   cp dev.env.sample .secrets/dev.env
+   vi .secrets/dev.env
+   ```
 
+4. Compile the smart contracts:
 
-### Installation
+   ```sh
+   pnpm hardhat compile
+   ```
 
-1. Clone the repository:
-    ```sh
-    git clone https://github.com/rankify-it/contracts.git
-    cd contracts
-    ```
+5. Deploy the smart contracts:
+   ```sh
+   pnpm hardhat deploy --network <network> --tags <tags>
+   ```
 
-2. Install dependencies:
-    ```sh
-    pnpm install
-    ```
+## Available Distributions
+
+We are using [Ethereum Distribution System](https://github.com/peeramid-labs/eds) to enable users to deploy their own infrastructure in transparent and decentralized way.
+
+In order to be out of box compatible with the interfaces & notifications of the Rankify platform, any deployment should should be done from the Peeramid Labs Distributor contract ([PeeramidLabsDistributor.sol](./src/distributors/PeeramidLabsDistributor.sol)).
+
+Specific address for distributor deployment can be found in the [deployments](./deployments) folder.
+
+### Meritocratic Autonomous Organization (MAO)
+
+[MAODistribution.sol](./src/distributions/MAODistribution.sol) is used to create a new Meritocratic Autonomous Organization (MAO).
 
-3. Compile the smart contracts:
-    ```sh
-    pnpm hardhat compile
-    ```
+This deployment will create following infrastructure:
 
-4. Deploy the smart contracts:
-    ```sh
-    pnpm hardhat deploy --network <network> --tags <tags>
-    ```
+- [RankToken](./src/tokens/RankToken.sol) - ERC1155 token used to represent the ranks in the MAO.
+- [Governance token](./src/tokens/DistributableGovernanceERC20.sol) - ERC20 token used to represent the governance in the MAO.
+- [ACID Distribution](./src/distributions/ArguableVotingTournament.sol) - Arguable Voting Tournament contract used to distribute governance tokens.
+- [Aragon OSx DAO](https://aragon.org/) - Aragon DAO used as wrapped smart account that represents the MAO.
+- [Aragon Token Voting Plugin](https://github.com/aragon/token-voting-plugin) - Aragon plugin used to vote on proposals within the DAO.
+
+#### How to instantiate
+
+In order to instantiate the MAO distribution, you don't need to deploy a thing. You just need to call the `instantiate` function of the the [PeeramidLabsDistributor.sol](./src/distributors/PeeramidLabsDistributor.sol) contract and specify proper distribution Id and arguments.
+
+```ts
+import { MAODistribution } from 'rankify-contracts/types';
+const distributorArguments: MAODistribution.DistributorArgumentsStruct = {
+  DAOSEttings: {
+    daoURI: 'https://example.com/dao',
+    subdomain: 'example',
+    metadata: ethers.utils.hexlify(ethers.utils.toUtf8Bytes('metadata')),
+    tokenName: 'tokenName',
+    tokenSymbol: 'tokenSymbol',
+  },
+  ACIDSettings: {
+    RankTokenContractURI: 'https://example.com/rank',
+    gamePrice: 1,
+    joinGamePrice: 1,
+    maxPlayersSize: 16,
+    maxTurns: 1,
+    metadata: ethers.utils.hexlify(ethers.utils.toUtf8Bytes('metadata')),
+    minPlayersSize: 4,
+    paymentToken: rankify.address,
+    rankTokenURI: 'https://example.com/rank',
+    timePerTurn: 1,
+    timeToJoin: 1,
+    voteCredits: 14,
+  },
+};
+const data = ethers.utils.defaultAbiCoder.encode(
+  [
+    'tuple(tuple(string daoURI, string subdomain, bytes metadata, string tokenName, string tokenSymbol) DAOSEttings, tuple(uint256 timePerTurn, uint256 maxPlayersSize, uint256 minPlayersSize, uint256 timeToJoin, uint256 maxTurns, uint256 voteCredits, uint256 gamePrice, address paymentToken, uint256 joinGamePrice, string metadata, string rankTokenURI, string RankTokenContractURI) ACIDSettings)',
+  ],
+  [distributorArguments],
+);
+const distributorsDistId = process.env.DISTRIBUTOR_DIST_ID;
+const tx = await distributorContract.instantiate(distributorsDistId, data);
+```
+
+In order to get `distributorsDistId` you can call `getDistributions` at `PeeramidLabsDistributor` contract and look for. We will host a public API to get the list of distributions soon.
+
+### ACID distribution
+
+[ArguableVotingTournament.sol](./src/distributions/ArguableVotingTournament.sol) is used to distribute governance tokens to the participants of the MAO by conducting autonomous competence identification tournaments.
+
+This distribution deploys the Diamond Proxy that contains the following facets:
+
+- [EIP712InspectorFacet](./src/facets/EIP712InspectorFacet.sol) - Facet that contains the main logic of the distribution.
+- [RankifyInstanceMainFacet](./src/facets//RankifyInstanceMainFacet.sol) - Facet that contains the main logic of the distribution.
+- [RankifyGameMastersFacetFacet](./src/facets/RankifyInstanceGameMastersFacet.sol) - Facet that contains the main logic of the distribution.
+- [RankifyInstanceGameOwnersFacet](./src/facets/RankifyInstanceGameOwnersFacet.sol) - Facet that contains the ownable logic of the distribution. (NB this will be deprecated)
+- [RankifyInstanceRequirementsFacet](./src/facets/RankifyInstanceRequirementsFacet.sol) - Facet that contains the requirements logic of the distribution.
+
+To understand how it works further please refer to [docs.rankify.it](https://docs.rankify.it/governance) or ask us a question in [Discord](https://discord.gg/EddGgGUuWC)
 
 ## Contributing
 
@@ -43,4 +114,3 @@ We welcome contributions to improve the Rankify smart contracts. Please fork the
 ## License
 
 This project is licensed under the MIT License.
-
 
@@ -15,4 +15,4 @@ const func: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
 };
 
 export default func;
-func.tags = ['rankify_token', 'rankify'];
+func.tags = ['rankify'];
@@ -6,7 +6,7 @@ import { ethers } from 'hardhat';
 import { MultipassDiamond } from '../types';
 const func: DeployFunction = async (hre: HardhatRuntimeEnvironment) => {
   const { deployments, getNamedAccounts } = hre;
-  const { deploy, diamond } = deployments;
+  const {  diamond } = deployments;
   const { deployer, owner } = await getNamedAccounts();
 
   const deployment = await diamond.deploy('Multipass', {