registry-sdk/README.md
Prathamesh Musale 911be08850 Remove unused code and update CI (#9)
Part of https://www.notion.so/Create-laconic-registry-SDK-d3a636d4aba44f7cbba3bd99b7146811

Co-authored-by: neeraj <neeraj.rtly@gmail.com>
Reviewed-on: cerc-io/registry-sdk#9
Co-authored-by: Prathamesh Musale <prathamesh.musale0@gmail.com>
Co-committed-by: Prathamesh Musale <prathamesh.musale0@gmail.com>
2024-03-14 09:15:48 +00:00

2.2 KiB

registry-sdk

Client library used by TS/JS applications to communicate with laconic2d.

Tests

Follow these steps to run the tests:

  • After cloning this repo run:

    yarn
    
  • Copy .env.example file and create a .env file.

    cp .env.example .env
    
  • Clone the laconic2d repo and change to repo directory.

  • Run the chain using ./scripts/init.sh.

  • Export the private key using:

    laconic2d keys export alice --keyring-backend test  --unarmored-hex --unsafe
    
  • Copy the private key and assign it to variable PRIVATE_KEY in the .env file.

  • Run the tests in registry-sdk repo:

    yarn test
    
  • Run the tests with auctions enabled

    • In laconic2d repo run:

      TEST_AUCTION_ENABLED=true ./scripts/init.sh clean
      
    • Export the private key and change it in .env file again using:

      laconic2d keys export alice --keyring-backend test  --unarmored-hex --unsafe
      
    • Run tests:

      yarn test:auctions
      
  • Run the tests for record and authority expiry

    • In laconic2d repo run:

      TEST_REGISTRY_EXPIRY=true ./scripts/init.sh clean
      
    • Export the private key and change it in .env file again using:

      laconic2d keys export alice --keyring-backend test  --unarmored-hex --unsafe
      
    • Run tests:

      yarn test:nameservice-expiry
      

Development

README

Known Issues

  • Passing a float type value in watcher attributes throws error when sending setRecord message.

    failed to execute message; message index: 0: Invalid signature.: unauthorized
    
  • When sending setRecord message, an integer value passed in watcher attributes is parsed as float type in laconic2d while unmarshalling json.

  • setRecord message throws error when fileds in Record message are not assigned.

    failed to pack and hash typedData primary type: provided data '<nil>' doesn't match type 'string' [tharsis/ethermint/ethereum/eip712/eip712.go:33]
    

    Passing dummy values to work around issue.