Sign a message

Use the signMessage method exported from the useSignMessage hook to sign a message with an Ethereum embedded wallet.

​

Usage

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

const {signMessage} = useSignMessage();

const uiOptions = {
  title: 'You are voting for foobar project'
};

const {signature} = await signMessage({message: 'I hereby vote for foobar'}, {uiOptions});

​

Parameters

​

Returns

​

Callbacks

Configure callbacks for Privy’s signMessage method on the useSignMessage hook:

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

const {signMessage} = useSignMessage({
  onSuccess: ({signature}) => {
    console.log(signature);
    // Any logic you'd like to execute after a user successfully signs a message
  },
  onError: (error) => {
    console.log(error);
    // Any logic you'd like to execute after a user exits the message signing flow or there is an error
  }
});

// Then call `signMessage` in your code, which will invoke these callbacks on completion

As parameters to useSignMessage, you may include an onSuccess callback and/or an onError callback.

While this component is mounted, any invocation of signMessage will trigger the onSuccess callback or onError callback on completion, depending on if the message was successfully signed or not.

​

onSuccess

If set, the onSuccess callback will execute after a user has successfully signed the message. Within this callback, you can access a signature parameter, which is the signature string value generated by the wallet to sign the message.

​

onError

If set, the onError callback will execute after a user attempts to sign a message and there is an error, or if the user exits the signature flow prematurely. Within this callback, you may access an error code with more information about the error.

Request a message signature on the wallets Ethereum provider.

​

Usage

import {useEmbeddedEthereumWallet} from '@privy-io/expo';

const {wallets} = useEmbeddedEthereumWallet();
const wallet = wallets[0];

// Get an EIP-1193 Provider
const provider = await wallet.getProvider();
// Get address
const accounts = await provider.request({
  method: 'eth_requestAccounts'
});

// Sign message
const message = 'I hereby vote for foobar';
const signature = await provider.request({
  method: 'personal_sign',
  params: [message, accounts[0]]
});

​

Parameters

​

Returns

Request a message signature on the wallet’s Ethereum provider.

​

Usage

guard let user = privy.user else {
    // If user is null, user is not authenticated
    return
}

// Retrieve list of user's embedded Ethereum wallets
let ethereumWallets = user.embeddedEthereumWallets

// Grab the desired wallet. Here, we retrieve the first wallet
guard let wallet = ethereumWallets.first else {
    // No ETH wallets
    return
}

let data = EthereumRpcRequest(method: "personal_sign", params: ["A message to sign", wallet.address])
let signature = try await wallet.provider.request(data)

print("Result signature: \(signature)")

​

Parameters

​

Returns

​

Usage

// Get Privy user
val user = privy.user

// check if user is authenticated
if (user != null) {
  // Retrieve list of user's embedded Ethereum wallets
  val ethereumWallets = user.embeddedEthereumWallets

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

    // Make an rpc request
    ethereumWallet.provider.request(
      request = EthereumRpcRequest(
        method = "personal_sign",
        params = listOf("A message to sign", ethereumWallet.address),
      ),
    )
  }
}

​

Parameters

​

Returns

​

Usage

try {
    IEmbeddedEthereumWallet embeddedWallet = PrivyManager.Instance.User.EmbeddedWallets[0];
    var rpcRequest = new RpcRequest
    {m
        Method = "personal_sign",
        Params = new string[] { "A message to sign", embeddedWallet.Address }  // Use the 'new' keyword here
    };
    RpcResponse personalSignResponse = await embeddedWallet.RpcProvider.Request(rpcRequest);
    Debug.Log(personalSignResponse.Data);
} catch (PrivyException.EmbeddedWalletException ex){
    Debug.LogError($"Could not sign message due to error: {ex.Error} {ex.Message}");
} catch (Exception ex) {
    Debug.LogError($"Could not sign message exception {ex.Message}");
}

​

Parameters

​

Returns

​

Usage

// Get an EIP-1193 Provider
final ethereumWallet = privy.user.embeddedEthereumWallets.first;
final provider = ethereumWallet.provider;

// Sign message
final message = 'A message to you Rudy';
final request = EthereumRpcRequest(
  method: 'personal_sign',
  params: [message, ethereumWallet.address],
);

final result = await provider.request(request);

result.fold(
  onSuccess: (response) {
    final signature = response.data;
    print('Signature: $signature');
  },
  onFailure: (error) {
    print('Error signing message: ${error.message}');
  },
);

​

Parameters

​

Returns

Use the signMessage method on the Ethereum client to sign a message with an Ethereum wallet.

signMessage: async ({walletId: string, message: string, idempotencyKey?: string}) => Promise<{signature: string, encoding: 'hex'}>

​

Usage

const {signature, encoding} = await privy.walletApi.ethereum.signMessage({
  walletId: 'insert-wallet-id',
  message: 'Hello world'
});

​

Parameters

​

Returns

To sign a message make a POST request to

https://api.privy.io/v1/wallets/<wallet_id>/rpc

​

Parameters

​

Returns

​

Usage

$ curl --request POST https://api.privy.io/v1/wallets/<wallet_id>/rpc \
-u "<your-privy-app-id>:<your-privy-app-secret>" \
-H "privy-app-id: <your-privy-app-id>" \
-H "privy-authorization-signature: <authorization-signature-for-request>" \
-H 'Content-Type: application/json' \
-d '{
  "chain_type": "ethereum",
  "method": "personal_sign",
  "params": {
    "message": "Hello, Ethereum.",
    "encoding": "utf-8"
  }
}'