Skip to content

Commit

Permalink
chore: update versions (#36)
Browse files Browse the repository at this point in the history
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
github-actions[bot] and github-actions[bot] authored Nov 27, 2023
1 parent d3aaaf9 commit 88ce8bb
Show file tree
Hide file tree
Showing 6 changed files with 114 additions and 33 deletions.
5 changes: 0 additions & 5 deletions .changeset/moody-eels-compete.md

This file was deleted.

21 changes: 0 additions & 21 deletions .changeset/twenty-terms-nail.md

This file was deleted.

6 changes: 0 additions & 6 deletions .changeset/unlucky-meals-eat.md

This file was deleted.

27 changes: 27 additions & 0 deletions packages/walletkit/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# @totejs/walletkit

## 1.0.5

### Patch Changes

- d3aaaf9: Add chains type declaration for dev example
- 12ebee8: Add Binance Web3 Wallet & Coinbase Wallet & OKX Wallet & MathWallet support.

Add showQRCode & getQRCodeUri configuration items to support display a QR code when a wallet is
not installed.

UI adapted to mobile end and multiple wallets.

Fixed the hover effect did not disappear after clicking button on the mobile end.

Fixed walletConnect popup and QR code display being very slow issue.

Disabled page scrolling when opening walletkit modal.

For a smoother development experience, remove `examples/test` and create a dev demo in
`packages/walletkit`.

Update walletConnect `relayUrl` to `wss://relay.walletconnect.org`.

- 4a88b07: Remove default `initialChainId` to support the case only connecting a wallet and not
switching a network.
86 changes: 86 additions & 0 deletions packages/walletkit/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
# WalletKit

WalletKit is a React component library for easily connecting a wallet to your dApp.

## Features

- 💡 Typescript — Get types straight out of the box.
- 🌱 Ecosystem Standards — Built on top of [wagmi](https://wagmi.sh) and [viem](https://viem.sh)
- 🎨 Customization — Easily customizing wallets and themes

## Documentation

For full documentation, visit [here](https://node-real.github.io/walletkit/website/dist/#/index).

## Examples

The following examples are provided in the [examples](./examples/) folder of this repo.

- [nextjs](https://github.com/node-real/walletkit/tree/main/examples/nextjs)
- [vite](https://github.com/node-real/walletkit/tree/main/examples/vite)

## Installation

```bash
npm i @totejs/walletkit wagmi viem

```

## Usage

```tsx
import '@totejs/walletkit/styles.css';
import { WagmiConfig, createConfig } from 'wagmi';
import { chains } from './chains';
import {
WalletKitButton,
WalletKitProvider,
getDefaultConfig,
WalletKitOptions,
SwitchNetworkModal,
} from '@totejs/walletkit';
import { metaMask, trustWallet, walletConnect } from '@totejs/walletkit/wallets';

const config = createConfig(
getDefaultConfig({
autoConnect: true,
appName: 'WalletKit',

// WalletConnect 2.0 requires a projectId which you can create quickly
// and easily for free over at WalletConnect Cloud https://cloud.walletconnect.com/sign-in
walletConnectProjectId: 'xxx',

chains,
connectors: [trustWallet(), metaMask(), walletConnect()],
}),
);

const options: WalletKitOptions = {
initialChainId: 56,
};

export default function App() {
return (
<WagmiConfig config={config}>
<WalletKitProvider options={options} mode="light">
<WalletKitButton />

{/*
👇 Here's the SwitchNetworkModal
If the user switches to a network that is not supported by our dapp,
this modal will be displayed to remind the user to switch to our supported networks.
*/}
<SwitchNetworkModal />
</WalletKitProvider>
</WagmiConfig>
);
}
```

## Contributing

Please follow our [WalletKit Contribution Guide](./CONTRIBUTING.md).

## License

See [LICENSE](./LICENSE) for more information.
2 changes: 1 addition & 1 deletion packages/walletkit/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@totejs/walletkit",
"version": "1.0.4",
"version": "1.0.5",
"author": "node-real",
"private": false,
"description": "WalletKit is a React component library for easily connecting a wallet to your dApp.",
Expand Down

0 comments on commit 88ce8bb

Please sign in to comment.