Using global wallets

When you request a signature or transaction from a user’s embedded wallet from another app, Privy requires the user to explicitly confirm the signature or transaction. This is accomplished by opening a popup to the provider app’s domain, where the user confirms the action in an isolated environment.

To request signatures and transactions from a user’s embedded wallet from a provider app, use the signMessage, signTypedData, and sendTransaction methods returned by Privy’s useCrossAppAccounts hook

import {useCrossAppAccounts} from '@privy-io/react-auth';

const {signMessage, signTypedData, sendTransaction} = useCrossAppAccounts();

These methods are similar to the signMessage, signTypedData, and sendTransaction methods returned by usePrivy except they all require an additional CrossAppWalletOptions object of the following type:

address

string

required

The address for the cross-app embedded wallet that you’d like to request a signature/transaction from.

If the address you specify in this CrossAppWalletOptions object is not a valid embedded wallet that has been linked to the current user from a provider app, these wallet methods will error.

signMessage

To the signMessage method returned by useCrossAppAccounts, pass the following parameters:

message

string

required

The message the user must sign as a string.

options

CrossAppWalletOptions

required

Options for the cross-app embedded wallet, which must include the requested wallet’s address.

address

string

required

The address for the cross-app embedded wallet that you’d like to request a signature/transaction from.

signTypedData

To the signTypedData method returned by useCrossAppAccounts, pass the following parameters:

typedData

SignedTypedDataParams

required

A JSON object that conforms to the EIP-712 TypedData JSON schema.

options

CrossAppWalletOptions

required

Options for the cross-app embedded wallet, which must include the requested wallet’s address.

address

string

required

The address for the cross-app embedded wallet that you’d like to request a signature/transaction from.

sendTransaction

To the sendTransaction method returned by useCrossAppAccounts, pass the following parameters:

requestData

UnsignedTransactionRequest

required

The transaction request to be sent.

options

CrossAppWalletOptions

required

Options for the cross-app embedded wallet, which must include the requested wallet’s address.

address

string

required

The address for the cross-app embedded wallet that you’d like to request a signature/transaction from.

Example signature request

As an example, you might request a signature from a user’s cross-app wallet like so:

import {usePrivy, useCrossAppAccounts} from '@privy-io/react-auth';

function Button() {
  const {user} = usePrivy();
  const {signMessage} = useCrossAppAccounts();
  const crossAppAccount = user.linkedAccounts.find((account) => account.type === 'cross_app');
  const address = crossAppAccount.embeddedWallets[0].address;

  return (
    <button onClick={() => signMessage('Hello world', {address: address})} disabled={!address}>
      Sign a message with your cross-app wallet
    </button>
  );
}

import {useCrossAppAccounts} from '@privy-io/react-auth';

const {signMessage, signTypedData, sendTransaction} = useCrossAppAccounts();

address

string

required

The address for the cross-app embedded wallet that you’d like to request a signature/transaction from.

If the address you specify in this CrossAppWalletOptions object is not a valid embedded wallet that has been linked to the current user from a provider app, these wallet methods will error.

signMessage

To the signMessage method returned by useCrossAppAccounts, pass the following parameters:

message

string

required

The message the user must sign as a string.

options

CrossAppWalletOptions

required

Options for the cross-app embedded wallet, which must include the requested wallet’s address.

address

string

required

The address for the cross-app embedded wallet that you’d like to request a signature/transaction from.

signTypedData

To the signTypedData method returned by useCrossAppAccounts, pass the following parameters:

typedData

SignedTypedDataParams

required

A JSON object that conforms to the EIP-712 TypedData JSON schema.

options

CrossAppWalletOptions

required

Options for the cross-app embedded wallet, which must include the requested wallet’s address.

address

string

required

The address for the cross-app embedded wallet that you’d like to request a signature/transaction from.

sendTransaction

To the sendTransaction method returned by useCrossAppAccounts, pass the following parameters:

requestData

UnsignedTransactionRequest

required

The transaction request to be sent.

options

CrossAppWalletOptions

required

Options for the cross-app embedded wallet, which must include the requested wallet’s address.

address

string

required

The address for the cross-app embedded wallet that you’d like to request a signature/transaction from.

Example signature request

As an example, you might request a signature from a user’s cross-app wallet like so:

import {usePrivy, useCrossAppAccounts} from '@privy-io/react-auth';

function Button() {
  const {user} = usePrivy();
  const {signMessage} = useCrossAppAccounts();
  const crossAppAccount = user.linkedAccounts.find((account) => account.type === 'cross_app');
  const address = crossAppAccount.embeddedWallets[0].address;

  return (
    <button onClick={() => signMessage('Hello world', {address: address})} disabled={!address}>
      Sign a message with your cross-app wallet
    </button>
  );
}

const {signMessage} = useSignMessageWithCrossApp();
const {signTypedData} = useSignTypedDataWithCrossApp();
const {sendTransaction} = useSendTransactionWithCrossApp();

These methods all require an additional address property, and an optional redirectUri, of the following types:

address

string

required

The address for the cross-app embedded wallet that you’d like to request a signature/transaction from.

redirectUri

string

A URL path that the provider will automatically redirect to after successful authentication. This defaults to a link back to your app root, eg. '/', if not provided.

If the address you specify in this CrossAppWalletOptions object is not a valid embedded wallet that has been linked to the current user from a provider app, these wallet methods will error.

signMessage

To the signMessage method returned by `useSignMessageWithCrossApp“, pass the following parameters:

import {usePrivy, useSignMessageWithCrossApp} from '@privy-io/expo';

function Button() {
  const {user} = usePrivy();
  const {signMessage} = useSignMessageWithCrossApp();
  const crossAppAccount = user.linked_accounts.find((account) => account.type === 'cross_app');
  const address = crossAppAccount.embedded_wallets[0].address;

  return (
    <button onClick={() => signMessage({address, message: 'Hello world'})} disabled={!address}>
      Sign a message with your cross-app wallet
    </button>
  );
}

message

string

required

The message the user must sign as a string.

address

string

required

The address for the cross-app embedded wallet that you’d like to request a signature/transaction from.

redirectUri

string

A URL path that the provider will automatically redirect to after successful authentication. This defaults to a link back to your app root, eg. '/', if not provided.

signTypedData

To the signTypedData method returned by useSignTypedDataWithCrossApp, pass the following parameters:

import {usePrivy, useSignMessageWithCrossApp} from '@privy-io/expo';

function Button() {
  const {user} = usePrivy();
  const {signTypedData} = useSignTypedDataWithCrossApp();
  const crossAppAccount = user.linked_accounts.find((account) => account.type === 'cross_app');
  const address = crossAppAccount.embedded_wallets[0].address;

  return (
    <button
      onClick={() => signTypedData({address, typedData: insertTypedDataObject})}
      disabled={!address}
    >
      Sign a message with your cross-app wallet
    </button>
  );
}

typedData

TypedDataDefinition

required

A JSON object that conforms to the EIP-712 TypedData JSON schema.

address

string

required

The address for the cross-app embedded wallet that you’d like to request a signature/transaction from.

redirectUri

string

A URL path that the provider will automatically redirect to after successful authentication. This defaults to a link back to your app root, eg. '/', if not provided.

sendTransaction

To the sendTransaction method returned by useSendTransactionWithCrossApp, pass the following parameters:

import {usePrivy, useSendTransactionWithCrossApp} from '@privy-io/expo';

function Button() {
  const {user} = usePrivy();
  const {sendTransaction} = useSendTransactionWithCrossApp();
  const crossAppAccount = user.linked_accounts.find((account) => account.type === 'cross_app');
  const address = crossAppAccount.embedded_wallets[0].address;

  return (
    <button
      onClick={() =>
        sendTransaction(
          {
            to: '0xRecipientAddress',
            value: 1000000000000000000,
            gas: 21000,
            gasPrice: 20000000000,
            nonce: 0,
            data: '0x'
          },
          {address}
        )
      }
      disabled={!address}
    >
      Sign a message with your cross-app wallet
    </button>
  );
}

requestData

UnsignedTransactionRequest

required

The transaction request to be sent.

address

string

required

The address for the cross-app embedded wallet that you’d like to request a signature/transaction from.

redirectUri

string

A URL path that the provider will automatically redirect to after successful authentication. This defaults to a link back to your app root, eg. '/', if not provided.

Embedded wallets

Using wallets

Funding

Gas and asset management

Session signers

Global wallets

Advanced Topics

Using global wallets

signMessage

signTypedData

sendTransaction

Example signature request

signMessage

signTypedData

sendTransaction

Example signature request

signMessage

signTypedData

sendTransaction

Embedded wallets

Using wallets

Funding

Gas and asset management

Session signers

Global wallets

Advanced Topics

​signMessage

​signTypedData

​sendTransaction

​Example signature request

​signMessage

​signTypedData

​sendTransaction

​Example signature request

​signMessage

​signTypedData

​sendTransaction

signMessage

signTypedData

sendTransaction

Example signature request

signMessage

signTypedData

sendTransaction

Example signature request

signMessage

signTypedData

sendTransaction