Files
semaphore/packages/utils/README.md
cedoor 9e5c464237 feat(utils): new semaphore utilities + zk-kit replacements
The utils package will no longer provide errors and types utilities as those functions have been
moved to zk-kit. The utils package now provides a list of supported networks and a function to
decode messages instead.

re #642, #641


Former-commit-id: d2ce1070f0
2024-03-15 23:07:44 +00:00

2.9 KiB

Semaphore utils

A library to provide utility functions to the other Semaphore packages.

NPM license NPM version Downloads Documentation typedoc Linter eslint Code style prettier

🛠 Install

npm or yarn

Install the @semaphore-protocol/utils package with npm:

npm i @semaphore-protocol/utils

or yarn:

yarn add @semaphore-protocol/utils

📜 Usage

For more information on the functions and modules provided by @semaphore-protocol/utils, please refer to the TypeDoc documentation.

// You can import functions/parameters from the main bundle.
import { supportedNetworks, decodeMessage } from "@semaphore-protocol/utils"

// Or by using conditional exports.
import supportedNetworks from "@semaphore-protocol/utils/supported-networks"
import decodeMessage from "@semaphore-protocol/utils/decode-message"