laconic-console/README.md

Console

Laconic Kubenet GraphQL server and console application.

User interface for submitting and reading records registered on Laconic.

Development

• Clone the required repos:

  • laconicd

    git clone git@github.com:cerc-io/laconicd.git
    

  • debug

    git clone git@github.com:lirewine/debug.git
    

  • gem

    git clone git@github.com:lirewine/gem.git
    

• Run the laconicd chain:

  • In laconicd repo, checkout to a different branch (see issues below)

    git checkout console
    

  • Start the chain

    ./init.sh
    

• Run the laconic-console app

  • In laconic-console repo, install dependencies

    yarn
    

  • Register the dependencies to link

    • lirewine/debug

      • In debug repo, checkout to release version

        git checkout v1.0.0-beta.78
        

      • Install and build packages

        # Install dependencies and build packages
        yarn && yarn build
        

      • Run yarn link in repo root

        yarn link
        

    • lirewine/gem-core

      • In gem repo, checkout to release version

        git checkout v1.0.0-beta.26
        

      • Install and build packages

        # Install dependencies and build packages
        yarn && yarn build
        

      • Change directory to core package and run yarn link

        cd packages/core
        
        # Register package to link
        yarn link
        

  • Link the packages in laconic-console

    • In root of repo, run

      yarn link "@lirewine/debug"
      yarn link "@lirewine/gem-core"
      

  • Change directory to packages/console-app and start the react app

    # Change directory
    cd packages/console-app/
    
    # Start app
    CONFIG_FILE=config-local.yml yarn start
    

  • Open console-app at http://localhost:8080

  • To view records in the app, test suite in laconic-sdk can be run

    • Clone the laconic-sdk repo:

      git clone git@github.com:cerc-io/laconic-sdk.git
      

    • In laconic-sdk repo, copy .env.example file and create a .env file

      cp .env.example .env
      

    • Export the private key using:

      laconicd keys export mykey --unarmored-hex --unsafe
      

    • Copy the private key exported above and assign it to variable PRIVATE_KEY in the .env file.

    • Also change value of COSMOS_CHAIN_ID in .env file

      COSMOS_CHAIN_ID=ethermint_9000-1
      

    • Install dependencies

      yarn
      

    • Run the tests in laconic-sdk repo:

      yarn test
      

      NOTE: One test from util.test.ts fails as mentioned in the PR

    • Open console-app at http://localhost:8080 to view the records.

Issues

• Changes in laconicd (exists in console branch) for running with console app can be pushed once the following PRs (for fixing laconic-sdk test suite) are merged:

  • https://github.com/cerc-io/laconic-sdk/pull/15
  • https://github.com/cerc-io/laconicd/pull/70

• Once lirewine/debug and lirewine/gem packages are published to gitea (like lirewine/react-ux package), yarn linking can be removed from development setup.