/ego

Primary LanguageRustMIT LicenseMIT

EGO

This Project is Under Development, Scripts and Documentations are under-construction!

EGO is a smart-contract platform built on IC's canisters. EGO's goal is to allow users to own and control his/her canisters, in an easy way, like App store. Upgrade canisters into latest or specific version, backup and restore smartcontracts data, interlink with other installed canisters, even interact with user-owned distributed/decentralized marketplace.

There are at least 3 different roles in EGO.

  • Developers: Upload and maintain canister wasm, and frontend applications. Pay to install or free to use.
  • Admin/Auditors/Committee: set roles, audit wasm code, progress network updates and governance.
  • Users: Install and use his/her owned DApps through his/her wallet.

ENV setup

  • rust 1.65.0+

  • dfx 0.12.1+

  • didc download binary, export PATH to didc

  • !! Important !! Manually Setup Credentials

    • Under credentials folder, you need to add 2 files.
      1. seedPhrase.txt: 12 words mnemonic phrases, to create secp256k1 account for local test
      2. production.pem: pem file with secp256k1 curve encoded, use for mainnet deployment
      3. You can change file names on ego-config.json
    • Modify ego-config.json, change production_cycles_wallet to your cycles wallet.

  • setup project, see ego-projects.json,

  • Lazy Setup Credentials

    pnpm run ego:credentials

    Will generate seedPhrase.txt and production.pem for you. But!! You have to Setup manually on production!!

Quick Start

  1. pnpm install
  2. pnpm run ego:run to create and deploy
  3. pnpm run test ego_example to run test file in clients/tests

Scripts

  1. build projects, infra/apps or single project
 pnpm run ego:build # build all projects
 pnpm run ego:build --infra # build infra projects
 pnpm run ego:build --apps # build apps projects
 pnpm run ego:build --project=ego_dev # build ego_dev
  1. install projects, infra/apps or single project
 pnpm run ego:install # install all projects
 pnpm run ego:install --infra # install infra projects
 pnpm run ego:install --apps # install apps projects
 pnpm run ego:install --project=ego_dev # install ego_dev
  1. reinstall projects, infra/apps or single project
 pnpm run ego:reinstall # reinstall all projects
 pnpm run ego:reinstall --infra # install infra projects
 pnpm run ego:reinstall --apps # install apps projects
 pnpm run ego:reinstall --project=ego_dev # install ego_dev
  1. upgrade projects, infra/apps or single project
 pnpm run ego:upgrade # upgrade all projects
 pnpm run ego:upgrade --infra # upgrade infra projects
 pnpm run ego:upgrade --apps # upgrade apps projects
 pnpm run ego:upgrade --project=ego_wallet # upgrade ego_wallet
  1. post install
pnpm run ego:deploys
pnpm run ego:deploys:infra # run infra deploys
pnpm run ego:deploys:apps # run apps deploys
pnpm run ego:deploys:project post_wallet # run wallet deploys, please use `post_` prefix to project