Signatures

Sign message

POST https://api.planbok.io/v1/sign/message

Allows users to sign messages with their wallets

Headers

Name
Type
Description

PLANBOK-X-API-KEY*

String

Request Body

Name
Type
Description

message*

string

The message string to be signed, may be hex encoded.

encodeByHex*

boolean

Boolean to determine if the message is already hex encoded.

walletId*

string

An identifier generated by the system that is unique to the wallet.

walletSetSecretCipherText*

string

A base64 string expression of the wallet set secret cipher text generated by the system for the parent wallet set of the wallet.

Sign typed data

POST https://api.planbok.io/v1/sign/typed-data

Allows users to sign typed data

Headers

Name
Type
Description

PLANBOK-X-API-KEY*

String

Request Body

Name
Type
Description

domain*

TypedDataDomain

Defines the signing domain (see structure below).

types*

Record<string, Array<{ name: string; type: string }>>

Type definitions for the structured data.

value*

Record<string, any>

The actual data object to sign.

walletId*

string

An identifier generated by the system that is unique to the wallet.

walletSetSecretCipherText*

string

A base64 string expression of the wallet set secret cipher text generated by the system for the parent wallet set of the wallet.

interface TypedDataDomain {
  name?: string;
  version?: string;
  chainId?: BigNumberish;
  verifyingContract?: string;
  salt?: BytesLike;
}

PreviousTokens

Last updated