registry-sdk/README.md
Prathamesh Musale 911be08850
All checks were successful
Tests / sdk_tests (push) Successful in 19m43s
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: #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

97 lines
2.2 KiB
Markdown

# 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:
```bash
yarn
```
- Copy [.env.example](./.env.example) file and create a `.env` file.
```bash
cp .env.example .env
```
- Clone the [laconic2d repo](https://git.vdb.to/cerc-io/laconic2d) and change to repo directory.
- Run the chain using `./scripts/init.sh`.
- Export the private key using:
```bash
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:
```bash
yarn test
```
- Run the tests with auctions enabled
- In laconic2d repo run:
```bash
TEST_AUCTION_ENABLED=true ./scripts/init.sh clean
```
- Export the private key and change it in `.env` file again using:
```bash
laconic2d keys export alice --keyring-backend test --unarmored-hex --unsafe
```
- Run tests:
```bash
yarn test:auctions
```
- Run the tests for record and authority expiry
- In laconic2d repo run:
```bash
TEST_REGISTRY_EXPIRY=true ./scripts/init.sh clean
```
- Export the private key and change it in `.env` file again using:
```bash
laconic2d keys export alice --keyring-backend test --unarmored-hex --unsafe
```
- Run tests:
```bash
yarn test:nameservice-expiry
```
## Development
[README](./DEVELOPMENT.md)
## Known Issues
- Passing a float type value in [watcher attributes](./src/testing/data/watcher.yml) 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](https://pkg.go.dev/encoding/json#Unmarshal).
- `setRecord` message throws error when fileds in [Record](./src/types.ts) 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.