JavaScript library to operate with Sats with respect to Ordinals Handbook. Created on pure TypeScript without ANY dependency — feel safe!
package.json:
{
"dependencies": {},
}
- Compiles TypeScript code using both the
tsconfig.json
andtsconfig.module.json
files. - Formats TypeScript code using Prettier.
- Lints TypeScript code using ESLint.
- Runs unit tests using AVA.
- Generates code coverage reports using NYC.
- Generates HTML documentation using TypeDoc.
- Uses Husky Git hooks and Lint-staged pre-commit hooks.
- Install as dependency to your NodeJS or Browser project:
npm install --save @tookey-io/sats
oryarn add @tookey-io/sats
- Use :D
import { Sat } from "@tookey-io/sats";
const sat = Sat.fromName("alerdenisov");
// 1892488848343776
console.log("alerdenisov sat #" + sat.n);
// 717982
console.log("alerdenisov sat mine height: " + sat.decimal.height.n);
// 98343776
console.log("alerdenisov sat mine offset: " + sat.decimal.offset);
For more examples navigate to tests or documentation (not yet publish, but available with npm run doc
)
Clone the repository:
git clone https://github.com/tookey-io/sats.git
Install the dependencies:
npm install
There are several scripts available to help you get started:
Compile the TypeScript code using both the tsconfig.json
and tsconfig.module.json
files.
npm run build
Formats the TypeScript code using Prettier and lints the code using ESLint, fixing any issues found.
npm run fix
Lints the TypeScript code using ESLint, checks the code formatting using Prettier, and runs the unit tests using AVA.
npm run test
Watches for changes in the TypeScript code and recompiles the code using tsconfig.json
.
npm run watch:build
Watches for changes in the TypeScript code and re-runs the unit tests using AVA.
npm run watch:test
Generates an HTML report of the code coverage using NYC and opens the report in the browser.
npm run cov
Generates HTML documentation of the TypeScript code and opens the documentation in the browser.
npm run doc
The template uses Husky and Lint-staged to run pre-commit hooks that ensure your code is formatted, linted, tested, and documented before committing.
For more information on available scripts, see the Scripts
section of the package.json
file.
[*] Representation convertion [ ] Rarity assesment [ ] Exotic sats [ ] Match the ranges
This project is licensed under the MIT License.
This project uses Prettier, ESLint, AVA, NYC, Husky, Lint-staged, TypeDoc. And highly inspired by ord implementation on Rust