README.md

Snapshot.js

Install

Snapshot.js was designed to work both in the browser and in Node.js.

In Node Applications

To install Snapshot.js on Node.js, open your terminal and run:

npm i @snapshot-labs/snapshot.js

Browser

You can create an index.html file and include Snapshot.js with:

<script src="https://cdn.jsdelivr.net/npm/@snapshot-labs/snapshot.js"></script>

Development

Install dependencies

yarn

Build package

yarn build

Test cases

yarn test
# or
yarn test:once

Other useful scripts

# Format ABI
yarn ts-node scripts/abi.ts
# Generate hash for types
yarn ts-node scripts/generateHashWithTypes.ts

License

MIT.