@miden-sdk/miden-para
v0.13.1
Published
Miden x Para Integration
Readme
@miden-sdk/miden-para
This is the Miden x Para SDK integration. Below, you'll find instructions for local building and linking the library. If you're looking for React integration, see Miden x Para x React (package @miden-sdk/use-miden-para-react). If you want to scaffold a fresh Vite react-ts app with our Vite config baked in, check create-miden-para-react (package @miden-sdk/create-miden-para-react).
Requirements
- Yarn 1.22.22 (enforced via
packageManagerfield) - Node.js (compatible with your project)
- A Para API key. Production deployments require a Para production API key; use a non-prod key for local/dev.
This project uses Yarn 1.22.22. The version is locked in package.json and will be automatically enforced by modern package managers that support the packageManager field.
Peer Dependencies
@miden-sdk/miden-para expects these packages to be provided by the consuming app. Install matching versions alongside this package to avoid duplicate copies:
@miden-sdk/miden-sdk@^0.13.0@getpara/[email protected]
Example install:
yarn add @miden-sdk/miden-para @miden-sdk/miden-sdk@^0.13.0 @getpara/[email protected]When creating a client with storageMode set to private, supply an accountSeed; the initializer will throw if it is missing so that private accounts remain recoverable.
Installation
yarn installBuilding
yarn buildPublishing to npm
- Update the version in
package.json(the published package is@miden-sdk/miden-para). - Authenticate with npm if needed:
npm login. - Publish:
npm run publish. Theprepackhook rebuildsdist/and thepostpackhook moves the generated tarball intobuild/. - (Optional) Inspect the packed artifact without publishing via
npm packand checkbuild/for the resultingmiden-sdk-miden-para-<version>.tgz.
