@readyio/ready-lib NPM

Ready Lib

Installing Ready Lib for a project

Add ready lib dependencies via gitlab: Modify package.json as

"dependencies": {
    "ready-lib": "git+https://git.cystack.org/ready/ready-lib.git"
}

Install with npm
```
npm install
```
or with yarn
```
yarn
```
Reintall library when there's new version
```
npm install ready-lib -f
```

Usage

Import readylib to invoke essential methods. E.g., to get transaction history of a Polygon wallet:

import {readylib} from '@readyio/ready-lib'
const txns = await readylib.queryAllTransactions("0x1b0f42570c8b32a1023cb33e1a1eaa4a1f0d8d4a", readylib.ChainId.POLYGON, {
    limit: 20,
    from: "19964669",
    to: "19981387"
})

On the other hand, exported methods and types can also be called directly without readylib import

Get started for developing Ready Lib

Prerequisite:

Node.js
Yarn/Npm
pre-commit

Steps

Download dependencies with yarn or npm
```
yarn
```
- Note that, as a library's perspective, package.json is the single source of truth and developers should not rely on package-lock.json or yarn.lock to re-create the same environment. A good practice is to delete those lock files & node_modules and then reinstall dependencies to test if package.json is good to go.
Installing pre-commit hooks (for god's sake, we should avoid commiting & pushing those stealthy secrets asap)
```
pre-commit install
```

Quick Nodes (todo: categorize these notes)

Use *.spec.ts for quickly testing our modules. We will add more cases in the future. The code base now is not in good coverage yet.
Put secrets concentrating in a place for easier ignoring pushing them.
For mock data that we're afraid of being catched by gitleaks, use .gitleaksignore