Reown

https://docs.reown.com/
Admin
Reown empowers builders to create secure, user-friendly, and insight-rich Web3 wallet and app...
Tokens:294,943
Snippets:3,010
Trust Score:9.2
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Solana Adapter

Source: https://docs.reown.com/appkit/react-native/core/migration-multichain

Install the Solana adapter for Solana blockchain support.

```bash
# For Expo
npx expo install @reown/appkit-solana-react-native
# For RN CLI
# npm install @reown/appkit-solana-react-native
# yarn add @reown/appkit-solana-react-native
```

--------------------------------

### Install AppKit Solana Unity via OpenUPM CLI

Source: https://docs.reown.com/appkit/unity/core/usage

Use this command to install the AppKit adapter for Solana Unity SDK if you have Node.js and openupm-cli installed.

```bash
openupm add com.reown.appkit.solana.unity
```

--------------------------------

### Installation

Source: https://docs.reown.com/appkit/vue/core/reown-authentication

Install the Reown Authentication package using your preferred package manager.

```APIDOC
## Installation

Install the `@reown/appkit-siwx` package using your preferred package manager:

### npm
```bash
npm install @reown/appkit-siwx
```

### Yarn
```bash
yarn add @reown/appkit-siwx
```

### Bun
```bash
bun a @reown/appkit-siwx
```

### pnpm
```bash
pnpm add @reown/appkit-siwx
```
```

--------------------------------

### Install New Dependencies

Source: https://docs.reown.com/appkit/upgrade/from-web3modal-react-native

Install the required Reown AppKit packages and adapters.

```bash
# Core AppKit library and dependencies
yarn add @reown/appkit-react-native @react-native-async-storage/async-storage react-native-get-random-values react-native-svg @react-native-community/netinfo @walletconnect/react-native-compat

# Ethers adapter
yarn add @reown/appkit-ethers-react-native

# Optional: Additional adapters for other chains
yarn add @reown/appkit-solana-react-native @reown/appkit-bitcoin-react-native
```

--------------------------------

### Install Universal Connector Packages (Bun)

Source: https://docs.reown.com/appkit/recipes/universal-connector

Install the necessary Reown packages for your project using Bun.

```bash
bun add @reown/appkit @reown/appkit-universal-connector @reown/appkit-common
```

--------------------------------

### Install AppKit Core

Source: https://docs.reown.com/appkit/react/core/multichain?platform=basic

Install the base AppKit package.

```bash
npm install @reown/appkit
```

```bash
yarn add @reown/appkit
```

```bash
bun a @reown/appkit
```

```bash
pnpm add @reown/appkit
```

--------------------------------

### Install AppKit with TRON

Source: https://docs.reown.com/appkit/javascript/core/installation

Installation commands for integrating AppKit with the TRON adapter.

```bash
npm install @reown/appkit @reown/appkit-adapter-tron
```

```bash
yarn add @reown/appkit @reown/appkit-adapter-tron
```

```bash
bun add @reown/appkit @reown/appkit-adapter-tron
```

```bash
pnpm add @reown/appkit @reown/appkit-adapter-tron
```

--------------------------------

### Install Binance Wallet Adapter

Source: https://docs.reown.com/appkit/javascript/core/installation

Install the Binance wallet adapter package using npm, Yarn, Bun, or pnpm.

```bash
npm install @tronweb3/tronwallet-adapter-binance
```

```bash
yarn add @tronweb3/tronwallet-adapter-binance
```

```bash
bun add @tronweb3/tronwallet-adapter-binance
```

```bash
pnpm add @tronweb3/tronwallet-adapter-binance
```

--------------------------------

### Install Bitcoin Adapter

Source: https://docs.reown.com/appkit/react-native/core/migration-multichain

Install the Bitcoin adapter for Bitcoin blockchain support.

```bash
# For Expo
npx expo install @reown/appkit-bitcoin-react-native
# For RN CLI
# npm install @reown/appkit-bitcoin-react-native
# yarn add @reown/appkit-bitcoin-react-native
```

--------------------------------

### Install Wallet Button Package

Source: https://docs.reown.com/appkit/javascript/core/actions

Install the @reown/appkit-wallet-button package using your preferred package manager.

```bash
npm install @reown/appkit-wallet-button
```

```bash
yarn add @reown/appkit-wallet-button
```

```bash
bun a @reown/appkit-wallet-button
```

```bash
pnpm add @reown/appkit-wallet-button
```

--------------------------------

### Install Universal Connector Packages (npm)

Source: https://docs.reown.com/appkit/recipes/universal-connector

Install the necessary Reown packages for your project using npm.

```bash
npm install @reown/appkit @reown/appkit-universal-connector @reown/appkit-common
```

--------------------------------

### Install @reown/appkit-siwx with npm

Source: https://docs.reown.com/appkit/authentication/siwx/reown-authentication

Install the Reown Authentication package using npm. This is the first step to integrate SIWX functionality.

```bash
npm install @reown/appkit-siwx
```

--------------------------------

### Install @reown/appkit-siwx with Bun

Source: https://docs.reown.com/appkit/authentication/siwx/reown-authentication

Install the Reown Authentication package using Bun. This is a fast JavaScript runtime and package manager.

```bash
bun a @reown/appkit-siwx
```

--------------------------------

### Install OKX Wallet Adapter

Source: https://docs.reown.com/appkit/javascript/core/installation

Install the OKX Wallet adapter package using npm, Yarn, Bun, or pnpm.

```bash
npm install @tronweb3/tronwallet-adapter-okxwallet
```

```bash
yarn add @tronweb3/tronwallet-adapter-okxwallet
```

```bash
bun add @tronweb3/tronwallet-adapter-okxwallet
```

```bash
pnpm add @tronweb3/tronwallet-adapter-okxwallet
```

--------------------------------

### Install @reown/appkit-siwx with pnpm

Source: https://docs.reown.com/appkit/authentication/siwx/reown-authentication

Install the Reown Authentication package using pnpm. This is a performant package manager.

```bash
pnpm add @reown/appkit-siwx
```

--------------------------------

### Install AppKit with Ethers and Solana

Source: https://docs.reown.com/appkit/react/core/multichain?platform=basic

Install the necessary packages for using AppKit with Ethers and Solana adapters.

```bash
npm install @reown/appkit @reown/appkit-adapter-ethers @reown/appkit-adapter-solana
```

```bash
yarn add @reown/appkit @reown/appkit-adapter-ethers @reown/appkit-adapter-solana
```

```bash
bun a @reown/appkit @reown/appkit-adapter-ethers @reown/appkit-adapter-solana
```

```bash
pnpm add @reown/appkit @reown/appkit-adapter-ethers @reown/appkit-adapter-solana
```

--------------------------------

### Install Trust Wallet Adapter

Source: https://docs.reown.com/appkit/javascript/core/installation

Install the Trust Wallet adapter package using Yarn, Bun, or pnpm.

```bash
yarn add @tronweb3/tronwallet-adapter-trust
```

```bash
bun add @tronweb3/tronwallet-adapter-trust
```

```bash
pnpm add @tronweb3/tronwallet-adapter-trust
```

--------------------------------

### enableWalletGuide Configuration

Source: https://docs.reown.com/appkit/nuxt/core/options

Enable or disable the wallet guide text: `Haven't got a wallet? Get started`, is useful for people that don't have a wallet yet. Default is `true`.

```APIDOC
## enableWalletGuide

Enable or disable the wallet guide text: `Haven't got a wallet? Get started`, is useful for people that don't have a wallet yet. Default is `true`.

```ts
createAppKit({
  //...
  enableWalletGuide: false,
});
```
```

--------------------------------

### Start Development Server

Source: https://docs.reown.com/appkit/migration/from-anza-adapter-react

Commands to launch the development environment using various package managers.

```bash
npm run dev
```

```bash
yarn dev
```

```bash
npm run dev
```

```bash
pnpm run dev
```

--------------------------------

### enableWalletGuide Configuration

Source: https://docs.reown.com/appkit/next/core/options

Enable or disable the wallet guide text ('Haven't got a wallet? Get started'). Useful for users who don't have a wallet yet. Defaults to `true`.

```APIDOC
## enableWalletGuide

Enable or disable the wallet guide text: `Haven't got a wallet? Get started`, is useful for people that don't have a wallet yet. Default is `true`.

### Request Example
```ts
createAppKit({
  //...
  enableWalletGuide: false,
});
```
```

--------------------------------

### Run Development Server

Source: https://docs.reown.com/appkit/recipes/tenderly-virtual-testnets

Start the development server to test the application.

```bash
npm run dev
```

--------------------------------

### Basic SIWE Configuration Example

Source: https://docs.reown.com/appkit/flutter/core/siwe

A basic example demonstrating how to configure SIWE within ReownAppKitModal for initial testing without a backend. It provides implementations for essential SIWEConfig callbacks.

```dart
final _appKitModal = ReownAppKitModal(
  context: context,
  projectId: '{YOUR_PROJECT_ID}',
  metadata: const PairingMetadata(
    name: 'Example App',
    description: 'Example app description',
    url: 'https://example.com/',
    icons: ['https://example.com/logo.png'],
    redirect: Redirect(
      native: 'exampleapp://',
      universal: 'https://reown.com/exampleapp',
    ),
  ),
  siweConfig: SIWEConfig(
    getNonce: () async {
      return SIWEUtils.generateNonce();
    },
    getMessageParams: () async {
      return SIWEMessageArgs(
        domain: Uri.parse(_appKitModal.appKit!.metadata.url).authority,
        uri: _appKitModal.appKit!.metadata.url,
        statement: '{Your custom message here}',
        methods: MethodsConstants.allMethods,
      );
    },
    createMessage: (SIWECreateMessageArgs args) {
      return SIWEUtils.formatMessage(args);
    },
    verifyMessage: (SIWEVerifyMessageArgs args) async {
      final chainId = SIWEUtils.getChainIdFromMessage(args.message);
      final address = SIWEUtils.getAddressFromMessage(args.message);
      final cacaoSignature = args.cacao != null
          ? args.cacao!.s
          : CacaoSignature(
              t: CacaoSignature.EIP191,
              s: args.signature,
            );
      return await SIWEUtils.verifySignature(
        address,
        args.message,
        cacaoSignature,
        chainId,
        DartDefines.projectId,
      );
    },
    getSession: () async {
      final chainId = _appKitModal.selectedChain?.chainId ?? '1';
      final namespace = ReownAppKitModalNetworks.getNamespaceForChainId(
        chainId,
      );
      final address = _appKitModal.session!.getAddress(namespace)!;
      return SIWESession(address: address, chains: [chainId]);
    },
    signOut: () async {
      return true;
    },
  ),
);
```

--------------------------------

### Example HTTP RPC Request

Source: https://docs.reown.com/cloud/blockchain-api

Demonstrates how to make a POST request to the Blockchain API endpoint to get the chain ID. Replace `<your-project-id>` with your actual project ID.

```bash
curl -X POST "https://rpc.walletconnect.org/v1?chainId=eip155:1&projectId=<your-project-id>" --data '{"id":"1","jsonrpc":"2.0","method":"eth_chainId","params":[]}'
```

--------------------------------

### Install AppKit via OpenUPM CLI

Source: https://docs.reown.com/appkit/unity/core/installation

Use this command to install the AppKit package using the OpenUPM CLI. Ensure Node.js and openupm-cli are installed.

```bash
openupm add com.reown.appkit.unity
```

--------------------------------

### Initialize AppKit Instance

Source: https://docs.reown.com/appkit/react/core/multichain?platform=basic

Basic setup for creating an AppKit instance with multiple EVM and Solana networks.

```javascript
import { createAppKit } from "@reown/appkit";
import { solana, solanaTestnet, solanaDevnet } from "@reown/appkit/networks";
import { mainnet, arbitrum, sepolia } from "@reown/appkit/networks";

// 1. Get projectId from https://dashboard.reown.com
const projectId = "YOUR_PROJECT_ID";

// 2. Set up the metadata - Optional
const metadata = {
  name: "AppKit",
  description: "AppKit Example",
  url: "https://example.com", // origin must match your domain & subdomain
  icons: ["https://avatars.githubusercontent.com/u/179229932"],
};

// 3. Create the AppKit instance
const modal = createAppKit({
  networks: [mainnet, arbitrum, sepolia, solana, solanaTestnet, solanaDevnet],
  metadata: metadata,
  projectId,
  features: {
    analytics: true,
  },
});
```

--------------------------------

### Core AppKit Initialization

Source: https://docs.reown.com/appkit/javascript/core/multichain

Demonstrates the basic setup for creating an AppKit instance, including essential parameters like projectId, networks, and metadata.

```APIDOC
## Core AppKit Initialization

### Description
This snippet shows how to initialize the Reown AppKit with your project ID, supported networks, and optional metadata.

### Method
`createAppKit` function

### Endpoint
N/A (Client-side SDK)

### Parameters
#### Request Body
- **projectId** (string) - Required - Your unique project ID obtained from the Reown dashboard.
- **networks** (Array<Network>) - Required - An array of network configurations to support.
- **metadata** (object) - Optional - Configuration for application metadata like name, description, URL, and icons.
  - **name** (string) - Optional - The name of your application.
  - **description** (string) - Optional - A brief description of your application.
  - **url** (string) - Optional - The origin URL of your application (must match your domain & subdomain).
  - **icons** (Array<string>) - Optional - An array of URLs for application icons.
- **features** (object) - Optional - Configuration for enabling specific AppKit features.
  - **analytics** (boolean) - Optional - Enables or disables analytics tracking.

### Request Example
```json
{
  "projectId": "YOUR_PROJECT_ID",
  "networks": [
    "mainnet", "arbitrum", "sepolia", "solana", "solanaTestnet", "solanaDevnet"
  ],
  "metadata": {
    "name": "AppKit",
    "description": "AppKit Example",
    "url": "https://example.com",
    "icons": ["https://avatars.githubusercontent.com/u/179229932"]
  },
  "features": {
    "analytics": true
  }
}
```

### Response
#### Success Response (200)
- **modal** (object) - The initialized AppKit instance.
```

--------------------------------

### Install AppKit with Ethers5 + Solana Adapter (Bun)

Source: https://docs.reown.com/appkit/javascript/core/multichain

Use this command to install the AppKit core, Ethers5 adapter, and Solana adapter using Bun.

```bash
bun a @reown/appkit @reown/appkit-adapter-ethers5 @reown/appkit-adapter-solana
```

--------------------------------

### Install Core Library for React Native CLI

Source: https://docs.reown.com/appkit/react-native/core/installation

Install the core library and dependencies for a standard React Native CLI project, followed by pod installation for iOS.

```bash
npm install @reown/appkit-react-native @react-native-async-storage/async-storage react-native-get-random-values react-native-svg @react-native-community/netinfo @walletconnect/react-native-compat react-native-safe-area-context
```

```bash
npx pod-install
```

--------------------------------

### Install AppKit with Ethers + Solana Adapter (Bun)

Source: https://docs.reown.com/appkit/javascript/core/multichain

Use this command to install the AppKit core, Ethers adapter, and Solana adapter using Bun.

```bash
bun a @reown/appkit @reown/appkit-adapter-ethers @reown/appkit-adapter-solana
```

--------------------------------

### Install AppKit with Wagmi + Bitcoin Adapter (Bun)

Source: https://docs.reown.com/appkit/javascript/core/multichain

Use this command to install the AppKit core, Wagmi adapter, and Bitcoin adapter using Bun.

```bash
bun a @reown/appkit @reown/appkit-adapter-wagmi @reown/appkit-adapter-bitcoin
```

--------------------------------

### Install Bitcoin Adapter

Source: https://docs.reown.com/appkit/react-native/core/installation

Install the Bitcoin adapter for React Native.

```bash
npx expo install @reown/appkit-bitcoin-react-native
```

--------------------------------

### eth_signTypedData Example Parameters

Source: https://docs.reown.com/advanced/multichain/rpc-reference/ethereum-rpc

Example structure for the parameters required by eth_signTypedData.

```javascript
[
  "0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826",
  {
    types: {
      EIP712Domain: [
        {
          name: "name",
          type: "string",
        },
        {
          name: "version",
          type: "string",
        },
        {
          name: "chainId",
          type: "uint256",
        },
        {
          name: "verifyingContract",
          type: "address",
        },
      ],
      Person: [
        {
          name: "name",
          type: "string",
        },
        {
          name: "wallet",
          type: "address",
        },
      ],
      Mail: [
        {
          name: "from",
          type: "Person",
        },
        {
          name: "to",
          type: "Person",
        },
        {
          name: "contents",
          type: "string",
        },
      ],
    },
    primaryType: "Mail",
    domain: {
      name: "Ether Mail",
      version: "1",
      chainId: 1,
      verifyingContract: "0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC",
    },
    message: {
      from: {
        name: "Cow",
        wallet: "0xCD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826",
      },
      to: {
        name: "Bob",
        wallet: "0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB",
      },
      contents: "Hello, Bob!",
    },
  },
];
```

--------------------------------

### Initialize AppKit via CLI

Source: https://docs.reown.com/appkit/javascript/core/installation

Run this command to scaffold a minimal AppKit project with interactive configuration prompts.

```bash
npx @reown/appkit-cli
```

--------------------------------

### Install AppKit with Wagmi + Solana Adapter (Bun)

Source: https://docs.reown.com/appkit/javascript/core/multichain

Use this command to install the AppKit core, Wagmi adapter, and Solana adapter using Bun.

```bash
bun a @reown/appkit @reown/appkit-adapter-wagmi @reown/appkit-adapter-solana
```

--------------------------------

### Install AppKit with Ethers5 + Solana Adapter (npm)

Source: https://docs.reown.com/appkit/javascript/core/multichain

Use this command to install the AppKit core, Ethers5 adapter, and Solana adapter using npm.

```bash
npm install @reown/appkit @reown/appkit-adapter-ethers5 @reown/appkit-adapter-solana
```

--------------------------------

### Install AppKit with Ethers + Solana Adapter (npm)

Source: https://docs.reown.com/appkit/javascript/core/multichain

Use this command to install the AppKit core, Ethers adapter, and Solana adapter using npm.

```bash
npm install @reown/appkit @reown/appkit-adapter-ethers @reown/appkit-adapter-solana
```

--------------------------------

### Initialize AppKit with SIWE Config

Source: https://docs.reown.com/appkit/next/core/siwe

Demonstrates how to initialize AppKit with your SIWE configuration.

```APIDOC
## Initialize AppKit with your `siweConfig`.

```js
// Pass your siweConfig inside the createAppKit() function
const modal = createAppKit({
  adapters: [wagmiAdapter], //or your Ethers adapter
  projectId,
  networks: [mainnet, arbitrum],
  defaultNetwork: mainnet,
  features: {
    analytics: true, // Optional - defaults to your Cloud configuration
  },
  siweConfig: siweConfig, // pass your siweConfig
});
```
```

--------------------------------

### Install TON Dependencies

Source: https://docs.reown.com/appkit/nuxt/core/installation

Install the required packages for TON support in Nuxt.

```bash
npm install @reown/appkit @reown/appkit-adapter-ton
```

```bash
yarn add @reown/appkit @reown/appkit-adapter-ton
```

```bash
bun add @reown/appkit @reown/appkit-adapter-ton
```

```bash
pnpm add @reown/appkit @reown/appkit-adapter-ton
```

--------------------------------

### Initialize a New Reown AppKit Project with CLI

Source: https://docs.reown.com/appkit/overview

Use the Reown CLI to quickly set up a minimal version of Reown AppKit. This command initiates the project setup process, prompting for project details and framework preferences.

```bash
npx @reown/appkit-cli
```

--------------------------------

### Install Bitcoin Dependencies

Source: https://docs.reown.com/appkit/nuxt/core/installation

Install the required packages for Bitcoin support in Nuxt.

```bash
npm install @reown/appkit @reown/appkit-adapter-bitcoin
```

```bash
yarn add @reown/appkit @reown/appkit-adapter-bitcoin
```

```bash
bun add @reown/appkit @reown/appkit-adapter-bitcoin
```

```bash
pnpm add @reown/appkit @reown/appkit-adapter-bitcoin
```

--------------------------------

### Install Solana Dependencies

Source: https://docs.reown.com/appkit/nuxt/core/installation

Install the required packages for Solana support in Nuxt.

```bash
npm install @reown/appkit @reown/appkit-adapter-solana
```

```bash
yarn add @reown/appkit @reown/appkit-adapter-solana
```

```bash
bun add @reown/appkit @reown/appkit-adapter-solana
```

```bash
pnpm add @reown/appkit @reown/appkit-adapter-solana
```

--------------------------------

### Initializing AppKit (New Multichain Implementation)

Source: https://docs.reown.com/appkit/react-native/core/migration-multichain

New approach using adapter instances and a unified network list for multichain support.

```typescript
// New approach: src/AppKitConfig.ts (or your preferred file)
import "@walletconnect/react-native-compat"; // Ensure this is the first import

import { createAppKit, type AppKitNetwork } from "@reown/appkit-react-native";
import { EthersAdapter } from "@reown/appkit-ethers-react-native";
import { SolanaAdapter } from "@reown/appkit-solana-react-native";
import { BitcoinAdapter } from "@reown/appkit-bitcoin-react-native";
import { WagmiAdapter } from "@reown/appkit-wagmi-react-native";

// Import chain definitions (examples)
import { mainnet, polygon } from "viem/chains"; // For EVM
import { solana, bitcoin } from "@reown/appkit-react-native"; // Pre-defined AppKitNetwork objects

const projectId = "YOUR_PROJECT_ID"; // Obtain from https://dashboard.reown.com/

const metadata = { /* ... */ };

// 1. Define your AppKitNetworks (for AppKit's UI and network management)
// These can come from viem/chains (for EVM) or be custom AppKitNetwork objects.
const appNetworks: AppKitNetwork[] = [
  mainnet, // viem chains are automatically compatible as AppKitNetwork for 'eip155'
  polygon,
  solana,
  bitcoin,
  // You can also define custom AppKitNetwork objects here
];

// 2. Initialize Adapters for the chains you want to support
// For EVM chains, choose ONE of the following adapters (EthersAdapter or WagmiAdapter):

// Option A: EthersAdapter for general EVM support
const ethersAdapter = new EthersAdapter();

// Option B: WagmiAdapter if you are using Wagmi for EVM state management
const wagmiEvmNetworks = [viemMainnet, viemPolygon]; // Subset of appNetworks or specific Wagmi chains
const wagmiAdapter = new WagmiAdapter({
  projectId,
  networks: [mainnet, polygon], // These are Wagmi/viem chain objects
});

// Initialize adapters for other chains as needed
const solanaAdapter = new SolanaAdapter();
const bitcoinAdapter = new BitcoinAdapter();

// 3. Create the AppKit instance
// In this example, we'll use EthersAdapter for EVM chains.
// If you chose WagmiAdapter, replace ethersAdapter with wagmiAdapter below.
export const appKit = createAppKit({
  projectId,
  metadata,
  networks: appNetworks, // Master list of networks for AppKit UI and context
  adapters: [
    ethersAdapter,  // Handles EVM chains defined in 'networks'
    // wagmiAdapter, // Or use this if you chose Wagmi for EVM
    solanaAdapter,  // Handles Solana chains
    bitcoinAdapter, // Handles Bitcoin chains
  ],
  // ... other AppKit options (see Options page)
});
```

--------------------------------

### Install AppKit with Ethers + Solana Adapters

Source: https://docs.reown.com/appkit/next/core/multichain

Use npm, Yarn, Bun, or pnpm to install the AppKit core, Ethers adapter, and Solana adapter.

```bash
npm install @reown/appkit @reown/appkit-adapter-ethers @reown/appkit-adapter-solana
```

```bash
yarn add @reown/appkit @reown/appkit-adapter-ethers @reown/appkit-adapter-solana
```

```bash
bun a @reown/appkit @reown/appkit-adapter-ethers @reown/appkit-adapter-solana
```

```bash
pnpm add @reown/appkit @reown/appkit-adapter-ethers @reown/appkit-adapter-solana
```

--------------------------------

### Get Gas Price API

Source: https://docs.reown.com/appkit/unity/core/actions

Get the current gas price in wei.

```APIDOC
## Get Gas Price

### Description
Get the current gas price in wei.

### Method
`AppKit.Evm.GetGasPriceAsync`

### Response
#### Success Response (200)
- **gasPrice** (BigInteger) - The current gas price in wei.
```

--------------------------------

### Install Vue dependencies

Source: https://docs.reown.com/appkit/upgrade/to-reown-appkit-web

Commands to install AppKit and required dependencies for Vue projects.

```bash
npm install @reown/appkit @reown/appkit-adapter-wagmi @tanstack/vue-query @wagmi/vue
```

```bash
yarn add @reown/appkit @reown/appkit-adapter-wagmi @tanstack/vue-query @wagmi/vue
```

```bash
bun a @reown/appkit @reown/appkit-adapter-wagmi @tanstack/vue-query @wagmi/vue
```

```bash
pnpm add @reown/appkit @reown/appkit-adapter-wagmi @tanstack/vue-query @wagmi/vue
```

--------------------------------

### Install AppKit with Ethers + Solana Adapter (pnpm)

Source: https://docs.reown.com/appkit/javascript/core/multichain

Use this command to install the AppKit core, Ethers adapter, and Solana adapter using pnpm.

```bash
pnpm add @reown/appkit @reown/appkit-adapter-ethers @reown/appkit-adapter-solana
```

--------------------------------

### SIWXConfig Interface Implementation

Source: https://docs.reown.com/appkit/authentication/siwx/siwx-custom

This example demonstrates how to implement the SIWXConfig interface, providing concrete logic for message creation, session management, and other related functionalities.

```APIDOC
## SIWXConfig Interface

This interface defines the contract for implementing SIWX (Sign-In with X) functionality within the AppKit.

### Methods

- **createMessage**: Creates a unique message for user signature verification.
- **addSession**: Verifies and stores a new user session.
- **revokeSession**: Revokes all sessions for a specific chain and address.
- **setSessions**: Replaces all existing sessions with new ones after verification.
- **getSessions**: Retrieves all verified and valid sessions for a specific chain and address, excluding expired sessions.
- **getRequired**: Returns a boolean indicating if the wallet should remain connected when the user denies signature.
- **signOutOnDisconnect**: A boolean indicating whether to clear sessions upon user disconnection.

### Constraints

- **createMessage**: The generated message must be unique and contain all necessary information for identity verification.
- **addSession**: The session must be verified for validity before storage.
- **revokeSession**: All sessions for the specified chain and address must be successfully deleted.
- **setSessions**: All provided sessions must be verified before replacing the existing ones. The operation must succeed entirely or throw an error.
- **getSessions**: Only verified and valid sessions should be returned. Expired sessions must be excluded.

### Example Implementation

```typescript
import { createAppKit, type SIWXConfig } from '@reown/appkit'

const siwx: SIWXConfig = {
  createMessage: async (input) => {
    // Implement your logic to create a message
    return 'my message'
  },
  addSession: async (session) => {
    // Implement your logic to add a session
  },
  revokeSession: async (chainId, address) => {
    // Implement your logic to revoke a session
  },
  setSessions: async (sessions) => {
    // Implement your logic to set sessions
  },
  getSessions: async (chainId, address) => {
    // Implement your logic to get sessions
    return []
  },
  getRequired: () => {
    // Return whether the wallet should stay connected when user denies signature
    return false
  },
  signOutOnDisconnect: true // Whether to clear sessions when user disconnects
}

createAppKit({
  // ... your configuration
  siwx
})
```
```

--------------------------------

### Install JavaScript dependencies

Source: https://docs.reown.com/appkit/upgrade/to-reown-appkit-web

Commands to install AppKit and required dependencies for JavaScript projects.

```bash
npm install @reown/appkit @reown/appkit-adapter-wagmi
```

```bash
yarn add @reown/appkit @reown/appkit-adapter-wagmi
```

```bash
bun a @reown/appkit @reown/appkit-adapter-wagmi
```

```bash
pnpm add @reown/appkit @reown/appkit-adapter-wagmi
```

--------------------------------

### Install AppKit with Wagmi + Solana Adapter (npm)

Source: https://docs.reown.com/appkit/javascript/core/multichain

Use this command to install the AppKit core, Wagmi adapter, and Solana adapter using npm.

```bash
npm install @reown/appkit @reown/appkit-adapter-wagmi @reown/appkit-adapter-solana
```

--------------------------------

### Install React dependencies

Source: https://docs.reown.com/appkit/upgrade/to-reown-appkit-web

Commands to install AppKit and required dependencies for React projects.

```bash
npm install @reown/appkit @reown/appkit-adapter-wagmi @tanstack/react-query
```

```bash
yarn add @reown/appkit @reown/appkit-adapter-wagmi @tanstack/react-query
```

```bash
bun a @reown/appkit @reown/appkit-adapter-wagmi @tanstack/react-query
```

```bash
pnpm add @reown/appkit @reown/appkit-adapter-wagmi @tanstack/react-query
```

--------------------------------

### Install Trust Wallet Adapter

Source: https://docs.reown.com/appkit/javascript/core/installation

Command to install the Trust Wallet adapter for TRON.

```bash
npm install @tronweb3/tronwallet-adapter-trust
```

--------------------------------

### Install AppKit with Ethers5 + Solana Adapter (pnpm)

Source: https://docs.reown.com/appkit/javascript/core/multichain

Use this command to install the AppKit core, Ethers5 adapter, and Solana adapter using pnpm.

```bash
pnpm add @reown/appkit @reown/appkit-adapter-ethers5 @reown/appkit-adapter-solana
```

--------------------------------

### Install EVM Ethers Adapter

Source: https://docs.reown.com/appkit/react-native/core/migration-multichain

Install the Ethers adapter for EVM blockchain support.

```bash
# For Expo
npx expo install @reown/appkit-ethers-react-native
# For RN CLI
# npm install @reown/appkit-ethers-react-native
# yarn add @reown/appkit-ethers-react-native
```

--------------------------------

### Install AppKit with Wagmi + Bitcoin Adapter (npm)

Source: https://docs.reown.com/appkit/javascript/core/multichain

Use this command to install the AppKit core, Wagmi adapter, and Bitcoin adapter using npm.

```bash
npm install @reown/appkit @reown/appkit-adapter-wagmi @reown/appkit-adapter-bitcoin
```

--------------------------------

### Install Wagmi Core

Source: https://docs.reown.com/appkit/nuxt/core/installation

Install the @wagmi/core package using your preferred package manager.

```bash
npm install @wagmi/core
```

```bash
yarn add @wagmi/core
```

```bash
bun add @wagmi/core
```

```bash
pnpm add @wagmi/core
```

--------------------------------

### Install Ethers Dependencies

Source: https://docs.reown.com/appkit/nuxt/core/installation

Install the required packages for Ethers v6 support in Nuxt.

```bash
npm install @reown/appkit @reown/appkit-adapter-ethers ethers
```

```bash
yarn add @reown/appkit @reown/appkit-adapter-ethers ethers
```

```bash
bun add @reown/appkit @reown/appkit-adapter-ethers ethers
```

```bash
pnpm add @reown/appkit @reown/appkit-adapter-ethers ethers
```

--------------------------------

### Initialize Reown AppKit with Ethereum and Solana Adapters

Source: https://docs.reown.com/appkit/javascript/core/multichain

This snippet shows how to create an instance of the AppKit, including multiple network adapters and feature flags like analytics.

```typescript
// 2. Get projectId from https://dashboard.reown.com
    const projectId = 'YOUR_PROJECT_ID'

    // 3. Set up the metadata - Optional
    const metadata = {
      name: 'AppKit',
      description: 'AppKit Example',
      url: 'https://example.com', // origin must match your domain & subdomain
      icons: ['https://avatars.githubusercontent.com/u/179229932']
    }

    // 4. Create the AppKit instance
    const modal = createAppKit({
      adapters: [ethersAdapter, solanaWeb3JsAdapter],
      networks: [mainnet, arbitrum, sepolia, solana, solanaTestnet, solanaDevnet],
      metadata,
      projectId,
      features: {
        analytics: true,
      }
    })
```

```typescript
import { createAppKit } from "@reown/appkit";
import { solana, solanaTestnet, solanaDevnet } from "@reown/appkit/networks";
import { mainnet, arbitrum, sepolia } from "@reown/appkit/networks";

// 1. Get projectId from https://dashboard.reown.com
const projectId = "YOUR_PROJECT_ID";

// 2. Set up the metadata - Optional
const metadata = {
  name: "AppKit",
  description: "AppKit Example",
  url: "https://example.com", // origin must match your domain & subdomain
  icons: ["https://avatars.githubusercontent.com/u/179229932"],
};

// 3. Create the AppKit instance
const modal = createAppKit({
  networks: [mainnet, arbitrum, sepolia, solana, solanaTestnet, solanaDevnet],
  metadata: metadata,
  projectId,
  features: {
    analytics: true,
  },
});
```

--------------------------------

### Install Wagmi Dependencies

Source: https://docs.reown.com/appkit/nuxt/core/installation

Install the required packages for Wagmi 2.x support in Nuxt.

```bash
npm install @reown/appkit @reown/appkit-adapter-wagmi wagmi@2.x viem @wagmi/vue @tanstack/vue-query
```

```bash
yarn add @reown/appkit @reown/appkit-adapter-wagmi wagmi@2.x viem @wagmi/vue @tanstack/vue-query
```

```bash
bun add @reown/appkit @reown/appkit-adapter-wagmi wagmi@2.x viem @wagmi/vue @tanstack/vue-query
```

```bash
pnpm add @reown/appkit @reown/appkit-adapter-wagmi wagmi@2.x viem @wagmi/vue @tanstack/vue-query
```

--------------------------------

### Initialize Solana Adapter and AppKit

Source: https://docs.reown.com/appkit/upgrade/to-reown-appkit-solana-web

Replace the legacy configuration and modal creation with the new SolanaAdapter and createAppKit initialization.

```tsx
// Remove the following code lines
- const solanaConfig = defaultSolanaConfig({ ... });
- createWeb3Modal( ... );

// Add the following code lines
+ const solanaAdapter = new SolanaAdapter()

+ const modal = createAppKit({
+   projectId,
+   metadata,
+   networks: [solana, solanaTestnet, solanaDevnet],
+   adapters: [solanaAdapter],
+ })
```

--------------------------------

### eth_signTransaction Parameter Example

Source: https://docs.reown.com/advanced/multichain/rpc-reference/ethereum-rpc

Example of the transaction object structure used as a parameter for eth_signTransaction.

```javascript
[
  {
    from: "0xb60e8dd61c5d32be8058bb8eb970870f07233155",
    to: "0xd46e8dd67c5d32be8058bb8eb970870f07244567",
    data: "0xd46e8dd67c5d32be8d46e8dd67c5d32be8058bb8eb970870f072445675058bb8eb970870f072445675",
    gas: "0x76c0", // 30400
    gasPrice: "0x9184e72a000", // 10000000000000
    value: "0x9184e72a", // 2441406250
    nonce: "0x117", // 279
  },
];
```

--------------------------------

### Install AppKit with Ethers5 + Solana Adapter (Yarn)

Source: https://docs.reown.com/appkit/javascript/core/multichain

Use this command to install the AppKit core, Ethers5 adapter, and Solana adapter using Yarn.

```bash
yarn add @reown/appkit @reown/appkit-adapter-ethers5 @reown/appkit-adapter-solana
```

--------------------------------

### eth_sendTransaction Parameter Example

Source: https://docs.reown.com/advanced/multichain/rpc-reference/ethereum-rpc

Example of the transaction object structure used as a parameter for eth_sendTransaction.

```javascript
[
  {
    from: "0xb60e8dd61c5d32be8058bb8eb970870f07233155",
    to: "0xBDE1EAE59cE082505bB73fedBa56252b1b9C60Ce",
    data: "0x",
    gasPrice: "0x029104e28c",
    gas: "0x5208",
    value: "0x00",
  },
];
```

--------------------------------

### Initialize ReownAppKitModal with SIWE Configuration

Source: https://docs.reown.com/appkit/flutter/core/siwe

Demonstrates how to initialize the ReownAppKitModal by providing a `siweConfig` object, which enables Sign-In with Ethereum functionality.

```APIDOC
## Initialize ReownAppKitModal with your `siweConfig`

Add the siwe configuration in `ReownAppKitModal` initialization

```dart
final _appKitModal = ReownAppKitModal(
  context: context,
  projectId: '{YOUR_PROJECT_ID}',
  metadata: const PairingMetadata(
    name: 'Example App',
    description: 'Example app description',
    url: 'https://example.com/',
    icons: ['https://example.com/logo.png'],
    redirect: Redirect(
      native: 'exampleapp://',
      universal: 'https://reown.com/exampleapp',
    ),
  ),
  siweConfig: SIWEConfig(...),
);
```
```

--------------------------------

### Install iOS Pods

Source: https://docs.reown.com/appkit/react-native/core/migration-multichain

Run pod installation for React Native CLI projects on iOS.

```bash
npx pod-install
```

--------------------------------

### Install AppKit Solana Packages

Source: https://docs.reown.com/appkit/migration/from-anza-adapter-react

Install the required Reown AppKit packages for Solana integration.

```bash
npm install @reown/appkit @reown/appkit-adapter-solana
```

```bash
yarn add @reown/appkit @reown/appkit-adapter-solana
```

```bash
bun add @reown/appkit @reown/appkit-adapter-solana
```

```bash
pnpm add @reown/appkit @reown/appkit-adapter-solana
```

--------------------------------

### Install Reown Authentication package

Source: https://docs.reown.com/appkit/javascript/core/reown-authentication

Install the required dependency using your preferred package manager.

```bash
npm install @reown/appkit-siwx
```

```bash
yarn add @reown/appkit-siwx
```

```bash
bun a @reown/appkit-siwx
```

```bash
pnpm add @reown/appkit-siwx
```

--------------------------------

### Install AppKit with Ethers5 + Solana Adapters

Source: https://docs.reown.com/appkit/next/core/multichain

Use npm, Yarn, Bun, or pnpm to install the AppKit core, Ethers5 adapter, and Solana adapter.

```bash
npm install @reown/appkit @reown/appkit-adapter-ethers5 @reown/appkit-adapter-solana
```

```bash
yarn add @reown/appkit @reown/appkit-adapter-ethers5 @reown/appkit-adapter-solana
```

```bash
bun a @reown/appkit @reown/appkit-adapter-ethers5 @reown/appkit-adapter-solana
```

```bash
pnpm add @reown/appkit @reown/appkit-adapter-ethers5 @reown/appkit-adapter-solana
```
Tokens:
Raw