generated from veeso-dev/rust-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
399 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes
File renamed without changes
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Documentation | ||
|
|
||
| ## Canisters | ||
|
|
||
| - [Deferred](./canisters/deferred.md) | ||
| - [EKOKE-index](./canisters/ekoke-index.md) | ||
| - [Marketplace](./canisters/marketplace.md) | ||
|
|
||
| ## EKOKE DAO | ||
|
|
||
| - [DAO](./dao.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,236 @@ | ||
| # Deferred Canister | ||
|
|
||
| - [Deferred Canister](#deferred-canister) | ||
| - [Introduction](#introduction) | ||
| - [Data](#data) | ||
| - [Contract](#contract) | ||
| - [Roles](#roles) | ||
| - [API](#api) | ||
| - [register\_contract](#register_contract) | ||
| - [admin\_sign\_contract](#admin_sign_contract) | ||
| - [get\_contract](#get_contract) | ||
| - [get\_token](#get_token) | ||
| - [get\_signed\_contracts](#get_signed_contracts) | ||
| - [get\_agencies](#get_agencies) | ||
| - [remove\_agency](#remove_agency) | ||
| - [admin\_get\_unsigned\_contracts](#admin_get_unsigned_contracts) | ||
| - [seller\_increment\_contract\_value](#seller_increment_contract_value) | ||
| - [update\_contract\_buyers](#update_contract_buyers) | ||
| - [update\_contract\_property](#update_contract_property) | ||
| - [admin\_set\_ekoke\_ledger\_canister](#admin_set_ekoke_ledger_canister) | ||
| - [admin\_set\_marketplace\_canister](#admin_set_marketplace_canister) | ||
| - [admin\_set\_role](#admin_set_role) | ||
| - [admin\_remove\_role](#admin_remove_role) | ||
| - [admin\_register\_agency](#admin_register_agency) | ||
| - [HTTP API](#http-api) | ||
| - [Request protocol](#request-protocol) | ||
| - [Request Body](#request-body) | ||
| - [HTTP Methods](#http-methods) | ||
| - [getContracts](#getcontracts) | ||
| - [getContract](#getcontract) | ||
| - [getToken](#gettoken) | ||
| - [getAgencies](#getagencies) | ||
| - [Token Metadata](#token-metadata) | ||
|
|
||
|  | ||
|
|
||
| ## Introduction | ||
|
|
||
| Deferred is a canister which provides a **Non-fungible Token (NFT)** which implements the **DIP-721** Standard <https://github.com/Psychedelic/DIP721/blob/develop/spec.md>. | ||
|
|
||
| The Deferred canister takes care of registering the sell or financing of a real estate between two or more parts, **Buyers** and **Sellers**. This agreement between parts is called **Contract**. | ||
|
|
||
| The Buyer is represented by its Principal, while the Seller is represented by its Principal and its **Quota** in the contract ownership in a total sum of 100. | ||
|
|
||
| Each **Contract** is identified by an **ID** (NAT). | ||
|
|
||
| Each **Contract** will have Token associated, identified by an incremental **TokenIdentifier** (NAT) as specified by the DIP721 standard. | ||
|
|
||
| ## Data | ||
|
|
||
| ### Contract | ||
|
|
||
| A Contract is identified by the following properties | ||
|
|
||
| - **id**: the contract unique identifier | ||
| - **value**: the FIAT value of the contract | ||
| - **currency**: the currency used to represent the value | ||
| - **agency**: the agency which has created the contract | ||
| - **sellers**: the contract sellers | ||
| - **buyers**: the contract buyers | ||
| - **is_signed**: if signed the contract tokens can be sold. The token must be signed by custodians (or DAO) | ||
| - **type**: the contract type (Sell / Funding) | ||
| - **reward**: the reward of EKOKE token given to a NFT buyer | ||
| - **properties**: contract properties and metadata | ||
|
|
||
| ## Roles | ||
|
|
||
| On the deferred canister the following roles exists: | ||
|
|
||
| - **Custodian**: administrator of the canister, following the DIP721 standard. It can administrate the canister and sign contracts. | ||
| - **Agent**: role for agencies. Agent can create contracts, but he cannot sign them. | ||
|
|
||
| ## API | ||
|
|
||
| See [DID file](../../src/deferred/deferred.did) | ||
|
|
||
| ### register_contract | ||
|
|
||
| Register a contract with the provided data. | ||
|
|
||
| **The contract value** MUST be **multiple of installments**. | ||
|
|
||
| ### admin_sign_contract | ||
|
|
||
| Approve and sign an existing contract. Once signed, the contract's tokens can be sold on the marketplace. | ||
|
|
||
| ### get_contract | ||
|
|
||
| Get contract by ID | ||
|
|
||
| ### get_token | ||
|
|
||
| Get token and its related contract by ID | ||
|
|
||
| ### get_signed_contracts | ||
|
|
||
| Get the IDS for all the signed contract | ||
|
|
||
| ### get_agencies | ||
|
|
||
| Get all the agencies | ||
|
|
||
| ### remove_agency | ||
|
|
||
| Remove an agency. Only admin or the agent himself can call this method | ||
|
|
||
| ### admin_get_unsigned_contracts | ||
|
|
||
| Get unsigned contracts | ||
|
|
||
| ### seller_increment_contract_value | ||
|
|
||
| The seller increments the contract value and mint new NFTs for it | ||
|
|
||
| ### update_contract_buyers | ||
|
|
||
| Update the principal of the contract. | ||
|
|
||
| Only the sellers or the buyers can call this method. | ||
|
|
||
| ### update_contract_property | ||
|
|
||
| Change a contract property. | ||
|
|
||
| Can be called by Agent, Custodian or seller. | ||
|
|
||
| ### admin_set_ekoke_ledger_canister | ||
|
|
||
| Update ekoke ledger canister principal | ||
|
|
||
| ### admin_set_marketplace_canister | ||
|
|
||
| Update marketplace canister | ||
|
|
||
| ### admin_set_role | ||
|
|
||
| Set role for principal | ||
|
|
||
| ### admin_remove_role | ||
|
|
||
| Remove a role | ||
|
|
||
| ### admin_register_agency | ||
|
|
||
| Register a new agency in the canister and give to its principal the role of agent | ||
|
|
||
| ## HTTP API | ||
|
|
||
| The deferred canister also exposes an HTTP API | ||
|
|
||
| ### Request protocol | ||
|
|
||
| | Method | GET | | ||
| |--------------|------------------| | ||
| | Content-type | application/json | | ||
|
|
||
| ### Request Body | ||
|
|
||
| The request body must be JSON encoded, and must follow this syntax | ||
|
|
||
| | Name | Type | Description | | ||
| |--------|--------|----------------------------------------------| | ||
| | method | string | HTTP method name | | ||
| | params | json | key-value map of optional request parameters | | ||
|
|
||
| ### HTTP Methods | ||
|
|
||
| This list contains the http available methods with its parameters and response. | ||
|
|
||
| #### getContracts | ||
|
|
||
| Get all contracts ids | ||
|
|
||
| Body: | ||
|
|
||
| ```json | ||
| {} | ||
| ``` | ||
|
|
||
| Response | ||
|
|
||
| ```json | ||
| [ | ||
| 1, | ||
| 2, | ||
| ] | ||
| ``` | ||
|
|
||
| #### getContract | ||
|
|
||
| Get a contract by ID | ||
|
|
||
| Body: | ||
|
|
||
| ```json | ||
| { | ||
| "id": 1 | ||
| } | ||
| ``` | ||
|
|
||
| Response: | ||
|
|
||
| See Contract in did. Returns 404 if it doesn't exist. | ||
|
|
||
| #### getToken | ||
|
|
||
| Get a token by ID | ||
|
|
||
| Body: | ||
|
|
||
| ```json | ||
| { | ||
| "id": 1 | ||
| } | ||
| ``` | ||
|
|
||
| Response: | ||
|
|
||
| See TokenInfo in did. Returns 404 if it doesn't exist. | ||
|
|
||
| #### getAgencies | ||
|
|
||
| Returns all the agencies which have been registered. | ||
|
|
||
| ## Token Metadata | ||
|
|
||
| Each NFT has the following properties, following the DIP721 standard. | ||
|
|
||
| - `token:contract_id`: contract id | ||
| - `token:value`: fiat value of the contract | ||
| - `token:currency`: currency name to represent the value | ||
| - `token:picoEkoke_reward`: reward given when someone buys the contract on the marketplace | ||
| - `contract:sellers`: contract sellers principals | ||
| - `contract:buyers`: contract buyers principals | ||
|
|
||
| > To these properties the contract properties can be added using the syntax `contract:keyname` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # EKOKE Index canister | ||
|
|
||
| - [EKOKE Index canister](#ekoke-index-canister) | ||
| - [Introduction](#introduction) | ||
| - [API](#api) | ||
| - [ledger\_id](#ledger_id) | ||
| - [list\_subaccounts](#list_subaccounts) | ||
| - [get\_account\_transactions](#get_account_transactions) | ||
| - [commit](#commit) | ||
|
|
||
| ## Introduction | ||
|
|
||
| The ekoke-index canister takes care of providing the transaction history for each account. | ||
|
|
||
| ## API | ||
|
|
||
| See the full documentation on the [DID](../../src/ekoke_index/ekoke-index.did) | ||
|
|
||
| This API implements the index canister standard according to the SNS DAO. | ||
|
|
||
| ### ledger_id | ||
|
|
||
| Returns the ledger ID | ||
|
|
||
| ### list_subaccounts | ||
|
|
||
| Get all the subaccounts for a given principal | ||
|
|
||
| ### get_account_transactions | ||
|
|
||
| Get the transactions for a given account | ||
|
|
||
| ### commit | ||
|
|
||
| This endpoint is called by the ekoke-ledger to commit a transaction into the index. |
Oops, something went wrong.