Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update readme #16

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: update readme #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 34 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
<h1 align="center">IBCT: Ledgis Main-net Contracts</h1>
<p align="center">
<img width=40% src="https://user-images.githubusercontent.com/25478540/200444314-e2180ca2-caa8-4a34-86ea-7b205045cd63.png">
</p>

<h1 align="center">IBCT: LEDGIS MainNet Contracts</h1>

<div align="center">

Expand All @@ -9,25 +13,37 @@

</div>

IBCT's Ledgis is an EOSIO-based block chain aimed at ensuring fair value for all users who provide or use quality services. To achieve this goal, IBCT has developed a consensus algorithm called DPoSS and has new policies such as buyservice. This repository contains examples of smart contracts which would be deployed to Ledgis mainnet. They are provided for reference purposes and can be changed anytime to enhance their features or fix errors.
## Overview

**IBCT**'s **[LEDGIS](https://github.com/ibct-dev/LEDGIS)** is an EOSIO-based blockchain aimed at _ensuring fair value for all users who provide or use quality services_. To achieve this goal, IBCT has developed a consensus algorithm called _DPoSS_ and has new policies such as _buyservice_. This repository contains examples of smart contracts which would be deployed to LEDGIS mainnet. They are provided for reference purposes and can be changed anytime to enhance their features or fix errors.

## Contracts

- [led.system](https://github.com/ibct-dev/led.public.contracts/tree/master/contracts/led.system)
- [led.token](https://github.com/ibct-dev/led.public.contracts/tree/master/contracts/led.token)
- [led.bios](https://github.com/ibct-dev/led.public.contracts/tree/master/contracts/led.bios)
- [led.msig](https://github.com/ibct-dev/led.public.contracts/tree/master/contracts/led.msig)
- [led.wrap](https://github.com/ibct-dev/led.public.contracts/tree/master/contracts/led.wrap)
- [led.forum](https://github.com/ibct-dev/led.public.contracts/tree/master/contracts/led.forum)

* [led.system](https://github.com/ibct-dev/led.public.contracts/tree/master/contracts/led.system)
* [led.token](https://github.com/ibct-dev/led.public.contracts/tree/master/contracts/led.token)
* [led.bios](https://github.com/ibct-dev/led.public.contracts/tree/master/contracts/led.bios)
* [led.msig](https://github.com/ibct-dev/led.public.contracts/tree/master/contracts/led.msig)
* [led.wrap](https://github.com/ibct-dev/led.public.contracts/tree/master/contracts/led.wrap)
* [led.forum](https://github.com/ibct-dev/led.public.contracts/tree/master/contracts/led.forum)
## Dependencies

Dependencies:
* [led v1.8.x](https://github.com/ibct-dev/LEDGIS/releases/tag/v1.8.4)
* [eosio.cdt v1.6.x](https://github.com/EOSIO/eosio.cdt/releases/tag/v1.6.3)
- [eosio.cdt v1.6.x](https://github.com/EOSIO/eosio.cdt/releases/tag/v1.6.3)
- [LEDGIS v1.8.x](https://github.com/ibct-dev/LEDGIS/releases/tag/v1.8.4)

To build the contracts and the unit tests:
* First, ensure that your __legis__ is compiled to the core symbol for the Ledgis blockchain that intend to deploy to.
* Second, make sure that you have ```sudo make install```ed __legis__.
* Then just run the ```build.sh``` in the top directory to build all the contracts and the unit tests for these contracts.
## Build

To build the contracts and unit-tests:

- First, ensure that your **LEDGIS** is compiled to the core symbol for the LEDGIS blockchain that intend to deploy to.
- Second, make sure that you have **LEDGIS** made by `sudo make install`.
- Then, just run the `build.sh` in the top directory to build all the contracts.
- The build requires the exact location of `nodeos` and `eosio.cdt`.
- If you want to build also unit-tests for the contracts, run the build script with `-t` option.
- Note that the tests require LEDGIS version dependency as `1.8.x`.

After build (Automated tests are not supported yet):
* The unit tests executable is placed in the _build/tests_ and is named __unit_test__.
* The contracts are built into a _bin/\<contract name\>_ folder in their respective directories.
* Finally, simply use __cleos__ to _set contract_ by pointing to the previously mentioned directory.

- The unit-tests 'executable' would be placed in the _`build/tests/`_ with name **"unit_test"**.
- The contracts are built into a _`bin/<contract-name>`_ folder in their respective directories.
- Finally, simply use **"cleos"** to _`set contract`_ by pointing to the previously mentioned directory.