Skip to main content
You need Node.js 24 or later. The first request is read-only and needs neither a wallet nor an API key.

Install

This quickstart uses @renaiss-protocol/client@0.1.0-beta.3. Check availability before installing:
If the version is not published yet, use the release candidate supplied by Renaiss. Once available, install the exact version and commit your lockfile:
To follow the beta channel instead, use @renaiss-protocol/client@beta after confirming the tag exists. The tag can move to a newer release. Install viem as well if you use the optional @renaiss-protocol/client/viem signer adapter. For existing integrations, follow the migration guide.

Read available packs

The SDK calls /v2/gacha under the configured API base URL. Do not append /v2 to baseUrl. Choose a matching network and API deployment; network constants do not select a hostname.

Add wallet actions

  1. Request a builder key for your environment. For Redeem, also register the exact origins of your frontend.
  2. Add a backend proxy that authenticates your app’s users and injects x-builder-api-key. Keep the key out of browser bundles.
  3. Pass your user’s existing EOA signer to the client and set baseUrl to your proxy, such as /api/renaiss.
  4. Check the selected wallet, chain, balance and contract approvals before asking the wallet to sign.
The SDK handles request validation and action signatures. Your wallet library handles connection, chain switching and on-chain approvals. A sponsored API action does not pay the gas for a token approval sent by the user’s wallet. Continue with Gacha, Marketplace or Redeem.