@orangekit/react

OrangeKit React

Overview

Purpose

The React package wraps RainbowKit to provide an alternate or complementary set of wallet connection options that represent supported Bitcoin wallets. It also handles masquerading those wallets as EVM wallets and managing a backing provider for EVM operations while channeling signing operations to the Bitcoin wallet and transaction execution to the backing smart account.

Key Features

• Wallet Management: The React package provides a set of components that allow users to connect their Bitcoin wallets to your dApp. Outside of connection and disconnection, OrangeKit also supports displaying balance, switching chains, and more.
• Interoperability: The React package provides integrations with the popular viem and wagmi libraries.

Publishing npm package

We publish the npm package manually. In the future we want to release and publish npm package using GitHub Actions.

Make sure you have an npm account and you are in the orangekit organization to publish npm package.

To publish OrangeKit React package follow these steps:

1. Checkout to main branch.
2. Make sure the version in the package.json file is correct. The version on the main branch should point to the next version. For example, if the latest version is 1.0.0-beta.10, the version on main branch should be 1.0.0-beta.11.
3. Update version of the @orangekit/sdk dependency to the latest version.
4. Remove dist and node_modules directories.
5. Run pnpm install.
6. Run pnpm build.
7. If you need to log in to npm - run npm adduser
8. Run npm publish --access public and follow the steps in terminal.

After the successful release bump the version in package.json file, set the @orangekit/sdk dependency to workspace:* and open a PR.