Quickstart

​

Create an embedded wallet

To create an EVM embedded wallet for your user, call the createEthereumWallet method on your PrivyUser instance.

abstract class PrivyUser {
  // Other privy user methods

  /// Creates an Ethereum embedded wallet for the user.
  Future<Result<EmbeddedEthereumWallet>> createEthereumWallet({bool allowAdditional = false});
}

If a wallet is successfully created for the user, an EmbeddedEthereumWallet object is returned as an encapsulated value of Success().

This method will fail if:

• The user is not authenticated
• If a user already has 9 or more wallets
• If the network call to create the wallet fails
• If a user already has an embedded wallet and allowAdditional is not set to true.

​

Using the embedded wallet

To enable your app to request signatures and transactions from the embedded wallet, Privy Ethereum embedded wallets expose a provider inspired by the EIP-1193 provider standard. This allows you request signatures and transactions from the wallet via a familiar JSON-RPC API (e.g. personal_sign).

Once you have an instance of an EmbeddedEthereumWallet, you can make RPC requests by using the provider: EmbeddedEthereumWalletProvider hook and using its request method. For example, wallet.provider.request(request: rpcRequest). This request method will suspend and await if the embedded wallet needs to wait for any internal ready state.

/// Defines the Ethereum Wallet Provider interface for sending RPC requests.
abstract class EmbeddedEthereumWalletProvider {
   /**
    * Sends a request to the Ethereum provider
    *
    * @param The RPC request
    * @return The response received
    */
  Future<Result<EthereumRpcResponse>> request(EthereumRpcRequest request);
}

As a parameter to this method, to this method, pass an EthereumRpcRequest object that contains:

• method: the name of the JSON-RPC method for the wallet to execute (e.g. 'personal_sign')
• params: an array of parameters required by your specified method

By default, embedded wallets are connected to the Ethereum mainnet. To send a transaction on a different network, simply set the wallet’s chainId in the transaction request.

Example usage:

// Get the Privy user
final user = privy.user;

// Check if the user is authenticated
if (user != null) {
  // Retrieve the list of user's embedded Ethereum wallets
  final ethereumWallets = user.embeddedEthereumWallets;

  if (ethereumWallets.isNotEmpty) {
    // Grab the desired wallet. Here, we retrieve the first wallet
    final ethereumWallet = ethereumWallets.first;

    // Make an RPC request
    ethereumWallet.provider.request(
      request: EthereumRpcRequest(
        method: "personal_sign",
        params: ["A message to sign", ethereumWallet.address],
      ),
    );
  }
}

​

Creating the embedded wallet

To create a Solana embedded wallet for your user, call the createSolanaWallet method on your PrivyUser instance.

abstract class PrivyUser {
  /// Creates a Solana embedded wallet for the user.
  Future<Result<EmbeddedSolanaWallet>> createSolanaWallet();
}

If a wallet is successfully created for the user, an EmbeddedSolanaWallet object is returned as an encapsulated value of Success().

This method will Failure() with a PrivyException if:

• The user is not authenticated
• A user already has a Solana wallet
• If the network call to create the wallet fails

​

Using the embedded wallet

Privy supports requesting signatures on messages and transactions from a user’s Solana embedded wallet using the signMessage RPC. To request a signature, get the Solana embedded wallet provider and call the signMessage method on it with a base-64 encoded message to sign. If the signature is computed successfully, signMessage will return it as a base64-encoded string.

abstract class EmbeddedSolanaWalletProvider {
  /**
   * Request a signature on a Base64 encoded message or transaction
   *
   * @param message Base64 encoded message or transaction
   * @return The Base64 encoded computed signature
   */
  Future<Result<String>> signMessage(String message);
}

Example usage:

// Get the current user
final user = privy.user;

// Check if the user is authenticated
if (user != null) {
  // Check if the user has at least one Solana wallet
  if (user.embeddedSolanaWallets.isNotEmpty) {
    // Retrieve the user's Solana wallet
    final solanaWallet = user.embeddedSolanaWallets.first;

    // Sign a message
    final result = await solanaWallet.provider.signMessage(
      // Base 64 encoded: "Hello! I am the base64 encoded message to be signed."
      "SGVsbG8hIEkgYW0gdGhlIGJhc2U2NCBlbmNvZGVkIG1lY3NhZ2UgdG8gYmUgc2lnbmVkLg=="
    );
  }
}