Other chains

For chains supported at the Tier 2 level, you can invoke Privy’s raw sign functionality to sign over a hash, e.g. the hash of a transaction. You can then use the returned signature to submit and send your transaction. Alternatively, you can provide the bytes to hash with a specific encoding and a hash_function, and gets a similar response. For examples of how to use raw sign for a specific chain, see this recipe.

REST API
NodeJS
Java
React
React Native

Sign a raw hash or bytes (with encoding and hash_function) along the blockchain’s cryptographic curve using the wallet’s private key. Make a POST request to

https://api.privy.io/v1/wallets/{wallet_id}/raw_sign

Usage

curl --request POST \
--url https://api.privy.io/v1/wallets/{wallet_id}/raw_sign \
--header 'Authorization: Basic Y20xNWh4eDUyMDVlNWx2NHVkdmE3enBqejoybWhVOWhhVTFQYjhYNXV1cVdxQVRIdW5xTWIyUlBKRm5GSHRzWDVzbXNkdUJRUDZtTW05YldmalBwS3hocjJQZHNHY0Q5NkFUeDc5em03WWhicUZLWkM4' \
--header 'Content-Type: application/json' \
--header 'privy-app-id: <privy-app-id>' \
--data '{
"params": {
    "hash": "0x0775aeed9c9ce6e0fbc4db25c5e4e6368029651c905c286f813126a09025a21e"
    }
}'

A successful response will look like:

{
    "data": {
        "signature": "0x0775aeed9c9ce6e0fbc4db25c5e4e6368029651c905c286f813126a09025a21e",
        "encoding": "hex"
    }
}

Alternatively, you can provide bytes to hash with a specific encoding and hash function, and gets a similar response.

curl --request POST \
--url https://api.privy.io/v1/wallets/{wallet_id}/raw_sign \
--header 'Authorization: Basic Y20xNWh4eDUyMDVlNWx2NHVkdmE3enBqejoybWhVOWhhVTFQYjhYNXV1cVdxQVRIdW5xTWIyUlBKRm5GSHRzWDVzbXNkdUJRUDZtTW05YldmalBwS3hocjJQZHNHY0Q5NkFUeDc5em03WWhicUZLWkM4' \
--header 'Content-Type: application/json' \
--header 'privy-app-id: <privy-app-id>' \
--data '{
"params": {
    "bytes": "0a0234ea220809701d7a17a77e04408093e981a6335a66080112620a2d747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e5472616e73666572436f6e747261637412310a15417009bf59e27d2031a23a61e1590289fc3d21b3cd121541132b98ed6fb80a2d45f177cdef091ae2d9dc115418e80770a0bee581a633",
    "encoding": "hex",
    "hash_function": "sha256"
    }
}'

Authorization

string

required

App secret authentication.

Headers

privy-app-id

string

required

ID of your Privy app.

privy-authorization-signature

string

Request authorization signature. If multiple signatures are required, they should be comma separated.

Path

wallet_id

string

required

ID of the wallet.

Body

params

object

required

Hide child attributes

Option 1: Sign a pre-computed hash

hash

string

The hex-encoded hash to sign, prefixed with 0x. Use this option when you have already computed the hash.

Option 2: Hash bytes before signing

bytes

string

The bytes to hash and sign. Use this option to provide raw data that will be decoded using the specified encoding then hashed using the specified hash_function.

encoding

string

The encoding scheme for the bytes. Required when using bytes. Available options: utf-8, hex

hash_function

string

The hash function to hash the bytes. Required when using bytes. Available options: keccak256, sha256

You must provide either hash OR the combination of bytes, encoding, and hash_function. These parameter sets are mutually exclusive.

Response

data

object

required

Hide child attributes

signature

string

The signature, prefixed with 0x.

encoding

string

The encoding of the signature.

error

object

Hide child attributes

code

string

The error code.

message

string

The error message.

Use the rawSign method on the wallets() interface to sign a hash or bytes (with encoding and hash_function) with a wallet.

Usage

const {signature, encoding} = await privy.wallets().rawSign('insert-wallet-id', {
  params: { hash: '0x0775aeed9c9ce6e0fbc4db25c5e4e6368029651c905c286f813126a09025a21e' },
});

Alternatively, you can provide bytes to hash with a specific encoding and hash function, and gets a similar response.

const {signature, encoding} = await privy.wallets().rawSign('insert-wallet-id', {
  params: {
    bytes: "0a0234ea220809701d7a17a77e04408093e981a6335a66080112620a2d747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e5472616e73666572436f6e747261637412310a15417009bf59e27d2031a23a61e1590289fc3d21b3cd121541132b98ed6fb80a2d45f177cdef091ae2d9dc115418e80770a0bee581a633",
    encoding: "hex",
    hash_function: "sha256"
  },
});

Parameters and Returns

Check out the API reference for more details.

To sign a raw hash or bytes (with encoding and hash_function) from your wallet, use the rawSign method. It will sign your hash, and return the signature to you.

Usage

try {
    RawSignRequest request = RawSignRequest.builder()
        .params(
            RawSignRequestParams.builder()
                .hash("0x0775aeed9c9ce6e0fbc4db25c5e4e6368029651c905c286f813126a09025a21e")
                .build()
        )
        .build();

    // Alternatively, you can provide bytes to hash with a specific encoding and hash function, and gets a similar response.
    /*
      RawSignRequest request = RawSignRequest.builder()
          .params(
              RawSignRequestParams.builder()
                  .bytes("0a0234ea220809701d7a17a77e04408093e981a6335a66080112620a2d747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e5472616e73666572436f6e747261637412310a15417009bf59e27d2031a23a61e1590289fc3d21b3cd121541132b98ed6fb80a2d45f177cdef091ae2d9dc115418e80770a0bee581a633")
                  .encoding("hex")
                  .hashFunction("sha256")
                  .build()
          )
          .build();
    */

    // Example: If wallet's owner is an authorization private key
    AuthorizationContext authorizationContext = AuthorizationContext.builder()
        .addAuthorizationPrivateKey("authorization-key")
        .build();

    WalletRawSignResponse response = privyClient
        .wallets()
        .rawSign(
            walletId,
            request,
            authorizationContext
        );

    if (response.rawSignResponse().isPresent()) {
        RawSignResponse rawSignResponse = response.rawSignResponse().get();
        if (rawSignResponse.data().isPresent()) {
            RawSignResponseData data = rawSignResponse.data().get();
            String signature = data.signature();
        }
    }
} catch (APIException e) {
    String errorBody = e.bodyAsString();
    System.err.println(errorBody);
} catch (Exception e) {
    System.err.println(e.getMessage());
}

Parameters

request

RawSignRequest

required

Hide child attributes

params

RawSignRequestParams

required

Hide child attributes

Option 1: Sign a pre-computed hash

hash

String

The hex-encoded hash to sign, prefixed with 0x. Use this option when you have already computed the hash.

Option 2: Hash bytes before signing

bytes

String

The bytes to hash and sign. Use this option to provide raw data that will be decoded using the specified encoding then hashed using the specified hash_function.

encoding

String

The encoding scheme for the bytes. Required when using bytes. Available options: utf-8, hex

hashFunction

String

The hash function to hash the bytes. Required when using bytes. Available options: keccak256, sha256

You must provide either hash OR the combination of bytes, encoding, and hash_function. These parameter sets are mutually exclusive.

Returns

The WalletRawSignResponse object contains a rawSignResponse() field

rawSignResponse()

Optional<RawSignResponse>

Hide child attributes

data()

Optional<RawSignResponseData>

Hide child attributes

signature()

String

The signature produced by the wallet, prefixed with 0x.

Sign a raw hash or bytes (with encoding and hash_function) along the blockchain’s cryptographic curve using the wallet’s private key.

signRawHash: ({address: string, chainType: CurveSigningChainType, hash: HexString}) =>
  Promise<{signature: HexString}>;

Usage

import {useSignRawHash} from '@privy-io/react-auth/extended-chains';

const {signRawHash} = useSignRawHash();

const {signature} = await signRawHash({
  address: 'insert-wallet-address',
  chainType: 'cosmos', // or 'stellar', 'sui', etc.
  hash: '0x1acab030f479bda7829de07e9db4138cec5d38574df17d65af1617b7268541c0'
});

// Alternatively, you can provide bytes to hash with a specific encoding and hash function, and gets a similar response.
/*
  const {signature} = await signRawHash({
    address: 'insert-wallet-address',
    chainType: 'cosmos', // or 'stellar', 'sui', etc.
    bytes: '0a0234ea220809701d7a17a77e04408093e981a6335a66080112620a2d747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e5472616e73666572436f6e747261637412310a15417009bf59e27d2031a23a61e1590289fc3d21b3cd121541132b98ed6fb80a2d45f177cdef091ae2d9dc115418e80770a0bee581a633',
    encoding: 'hex',
    hash_function: 'sha256'
});
*/

console.log(signature);
// 0x4d349c0c04abec47f2af0929b6dd5abcef2f29cb90b596772af928b3ef6e34316108eab1c47fac6d1d5ec51da59bd9124a80c4d353e130a8e675a3ad952e4c46

Parameters

opts.address

string

required

The address of the wallet to use for signing the raw hash.

opts.chainType

CurveSigningChainType

required

The chain type of the wallet to use for signing the raw hash.

Option 1: Sign a pre-computed hash

opts.hash

HexString

The raw hash to sign over, hex-encoded and prefixed with 0x. Use this option when you have already computed the hash.

Option 2: Hash bytes before signing

opts.bytes

string

The bytes to hash and sign. Use this option to provide raw data that will be decoded using the specified encoding then hashed using the specified hash_function.

opts.encoding

'utf-8' | 'hex'

The encoding scheme for the bytes. Required when using bytes.

opts.hashFunction

'keccak256' | 'sha256'

The hash function to hash the bytes. Required when using bytes.

You must provide either hash OR the combination of bytes, encoding, and hash_function. These parameter sets are mutually exclusive.

Returns

Hide child properties

signature

HexString

The signature produced by the wallet. Hex-encoded and prefixed with 0x.

Sign a raw hash or bytes (with encoding and hash_function) along the blockchain’s cryptographic curve using the wallet’s private key.

signRawHash: ({address: string, chainType: CurveSigningChainType, hash: HexString}) =>
  Promise<{signature: HexString}>;

Usage

import {useSignRawHash} from '@privy-io/expo/extended-chains';

const {signRawHash} = useSignRawHash();

const {signature} = await signRawHash({
  address: 'insert-wallet-address',
  chainType: 'cosmos', // or 'stellar', 'sui', etc.
  hash: '0x1acab030f479bda7829de07e9db4138cec5d38574df17d65af1617b7268541c0'
});

// Alternatively, you can provide bytes to hash with a specific encoding and hash function, and gets a similar response.
/*
  const {signature} = await signRawHash({
    address: 'insert-wallet-address',
    chainType: 'cosmos', // or 'stellar', 'sui', etc.
    bytes: '0a0234ea220809701d7a17a77e04408093e981a6335a66080112620a2d747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e5472616e73666572436f6e747261637412310a15417009bf59e27d2031a23a61e1590289fc3d21b3cd121541132b98ed6fb80a2d45f177cdef091ae2d9dc115418e80770a0bee581a633',
    encoding: 'hex',
    hash_function: 'sha256'
});
*/

console.log(signature);
// 0x4d349c0c04abec47f2af0929b6dd5abcef2f29cb90b596772af928b3ef6e34316108eab1c47fac6d1d5ec51da59bd9124a80c4d353e130a8e675a3ad952e4c46

Parameters

opts.address

string

required

The address of the wallet to use for signing the raw hash.

opts.chainType

CurveSigningChainType

required

The chain type of the wallet to use for signing the raw hash.

Option 1: Sign a pre-computed hash

opts.hash

HexString

The raw hash to sign over, hex-encoded and prefixed with 0x. Use this option when you have already computed the hash.

Option 2: Hash bytes before signing

opts.bytes

string

The bytes to hash and sign. Use this option to provide raw data that will be decoded using the specified encoding then hashed using the specified hash_function.

opts.encoding

'utf-8' | 'hex'

The encoding scheme for the bytes. Required when using bytes.

opts.hashFunction

'keccak256' | 'sha256'

The hash function to hash the bytes. Required when using bytes.

You must provide either hash OR the combination of bytes, encoding, and hash_function. These parameter sets are mutually exclusive.

Returns

Hide child properties

signature

HexString

The signature produced by the wallet. Hex-encoded and prefixed with 0x.

Embedded wallets

Using wallets

Funding

Webhooks

Gas management

Global wallets

Usage

Authorization

Headers

Path

Body

Response

Usage

Parameters and Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Embedded wallets

Using wallets

Funding

Webhooks

Gas management

Global wallets

​Usage

​Authorization

​Headers

​Path

​Body

​Response

​Usage

​Parameters and Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

​Usage

​Parameters

​Returns

Usage

Authorization

Headers

Path

Body

Response

Usage

Parameters and Returns

Usage

Parameters

Returns

Usage

Parameters

Returns

Usage

Parameters

Returns