Skip to content

Commit 0ac7739

Browse files
steveluschersteveluscher
committed
Utilities for creating, signing, and verifying offchain messages
1 parent 3b94857 commit 0ac7739

File tree

3 files changed

+103
-0
lines changed

3 files changed

+103
-0
lines changed

‎packages/errors/src/codes.ts‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,21 @@ export const SOLANA_ERROR__SIGNER__TRANSACTION_CANNOT_HAVE_MULTIPLE_SENDING_SIGN
190190
export const SOLANA_ERROR__SIGNER__TRANSACTION_SENDING_SIGNER_MISSING = 5508010;
191191
export const SOLANA_ERROR__SIGNER__WALLET_MULTISIGN_UNIMPLEMENTED = 5508011;
192192

193+
// Offchain-message-related errors.
194+
// Reserve error codes in the range [5607000-5607999].
195+
export const SOLANA_ERROR__OFFCHAIN_MESSAGE__MAXIMUM_LENGTH_EXCEEDED = 5607000;
196+
export const SOLANA_ERROR__OFFCHAIN_MESSAGE__RESTRICTED_ASCII_BODY_CHARACTER_OUT_OF_RANGE = 5607001;
197+
export const SOLANA_ERROR__OFFCHAIN_MESSAGE__APPLICATION_DOMAIN_STRING_LENGTH_OUT_OF_RANGE = 5607002;
198+
export const SOLANA_ERROR__OFFCHAIN_MESSAGE__INVALID_APPLICATION_DOMAIN_BYTE_LENGTH = 5607003;
199+
export const SOLANA_ERROR__OFFCHAIN_MESSAGE__NUM_SIGNATURES_MISMATCH = 5607004;
200+
export const SOLANA_ERROR__OFFCHAIN_MESSAGE__NUM_REQUIRED_SIGNERS_CANNOT_BE_ZERO = 5607005;
201+
export const SOLANA_ERROR__OFFCHAIN_MESSAGE__VERSION_NUMBER_NOT_SUPPORTED = 5607006;
202+
export const SOLANA_ERROR__OFFCHAIN_MESSAGE__MESSAGE_FORMAT_MISMATCH = 5607007;
203+
export const SOLANA_ERROR__OFFCHAIN_MESSAGE__MESSAGE_LENGTH_MISMATCH = 5607008;
204+
export const SOLANA_ERROR__OFFCHAIN_MESSAGE__MESSAGE_MUST_BE_NON_EMPTY = 5607009;
205+
export const SOLANA_ERROR__OFFCHAIN_MESSAGE__NUM_ENVELOPE_SIGNATURES_CANNOT_BE_ZERO = 5607010;
206+
export const SOLANA_ERROR__OFFCHAIN_MESSAGE__SIGNATURES_MISSING = 5607011;
207+
193208
// Transaction-related errors.
194209
// Reserve error codes in the range [5663000-5663999].
195210
export const SOLANA_ERROR__TRANSACTION__INVOKED_PROGRAMS_CANNOT_PAY_FEES = 5663000;
@@ -481,6 +496,18 @@ export type SolanaErrorCode =
481496
| typeof SOLANA_ERROR__MALFORMED_JSON_RPC_ERROR
482497
| typeof SOLANA_ERROR__MALFORMED_NUMBER_STRING
483498
| typeof SOLANA_ERROR__NONCE_ACCOUNT_NOT_FOUND
499+
| typeof SOLANA_ERROR__OFFCHAIN_MESSAGE__APPLICATION_DOMAIN_STRING_LENGTH_OUT_OF_RANGE
500+
| typeof SOLANA_ERROR__OFFCHAIN_MESSAGE__INVALID_APPLICATION_DOMAIN_BYTE_LENGTH
501+
| typeof SOLANA_ERROR__OFFCHAIN_MESSAGE__MAXIMUM_LENGTH_EXCEEDED
502+
| typeof SOLANA_ERROR__OFFCHAIN_MESSAGE__MESSAGE_FORMAT_MISMATCH
503+
| typeof SOLANA_ERROR__OFFCHAIN_MESSAGE__MESSAGE_LENGTH_MISMATCH
504+
| typeof SOLANA_ERROR__OFFCHAIN_MESSAGE__MESSAGE_MUST_BE_NON_EMPTY
505+
| typeof SOLANA_ERROR__OFFCHAIN_MESSAGE__NUM_ENVELOPE_SIGNATURES_CANNOT_BE_ZERO
506+
| typeof SOLANA_ERROR__OFFCHAIN_MESSAGE__NUM_REQUIRED_SIGNERS_CANNOT_BE_ZERO
507+
| typeof SOLANA_ERROR__OFFCHAIN_MESSAGE__NUM_SIGNATURES_MISMATCH
508+
| typeof SOLANA_ERROR__OFFCHAIN_MESSAGE__RESTRICTED_ASCII_BODY_CHARACTER_OUT_OF_RANGE
509+
| typeof SOLANA_ERROR__OFFCHAIN_MESSAGE__SIGNATURES_MISSING
510+
| typeof SOLANA_ERROR__OFFCHAIN_MESSAGE__VERSION_NUMBER_NOT_SUPPORTED
484511
| typeof SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD
485512
| typeof SOLANA_ERROR__RPC__INTEGER_OVERFLOW
486513
| typeof SOLANA_ERROR__RPC__TRANSPORT_HTTP_ERROR

‎packages/errors/src/context.ts‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,14 @@ import {
134134
SOLANA_ERROR__MALFORMED_JSON_RPC_ERROR,
135135
SOLANA_ERROR__MALFORMED_NUMBER_STRING,
136136
SOLANA_ERROR__NONCE_ACCOUNT_NOT_FOUND,
137+
SOLANA_ERROR__OFFCHAIN_MESSAGE__APPLICATION_DOMAIN_STRING_LENGTH_OUT_OF_RANGE,
138+
SOLANA_ERROR__OFFCHAIN_MESSAGE__INVALID_APPLICATION_DOMAIN_BYTE_LENGTH,
139+
SOLANA_ERROR__OFFCHAIN_MESSAGE__MAXIMUM_LENGTH_EXCEEDED,
140+
SOLANA_ERROR__OFFCHAIN_MESSAGE__MESSAGE_FORMAT_MISMATCH,
141+
SOLANA_ERROR__OFFCHAIN_MESSAGE__MESSAGE_LENGTH_MISMATCH,
142+
SOLANA_ERROR__OFFCHAIN_MESSAGE__NUM_SIGNATURES_MISMATCH,
143+
SOLANA_ERROR__OFFCHAIN_MESSAGE__SIGNATURES_MISSING,
144+
SOLANA_ERROR__OFFCHAIN_MESSAGE__VERSION_NUMBER_NOT_SUPPORTED,
137145
SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD,
138146
SOLANA_ERROR__RPC__INTEGER_OVERFLOW,
139147
SOLANA_ERROR__RPC__TRANSPORT_HTTP_ERROR,
@@ -527,6 +535,35 @@ export type SolanaErrorContext = DefaultUnspecifiedErrorContextToUndefined<
527535
[SOLANA_ERROR__NONCE_ACCOUNT_NOT_FOUND]: {
528536
nonceAccountAddress: string;
529537
};
538+
[SOLANA_ERROR__OFFCHAIN_MESSAGE__APPLICATION_DOMAIN_STRING_LENGTH_OUT_OF_RANGE]: {
539+
actualLength: number;
540+
};
541+
[SOLANA_ERROR__OFFCHAIN_MESSAGE__INVALID_APPLICATION_DOMAIN_BYTE_LENGTH]: {
542+
actualLength: number;
543+
};
544+
[SOLANA_ERROR__OFFCHAIN_MESSAGE__MAXIMUM_LENGTH_EXCEEDED]: {
545+
actualBytes: number;
546+
maxBytes: number;
547+
};
548+
[SOLANA_ERROR__OFFCHAIN_MESSAGE__MESSAGE_FORMAT_MISMATCH]: {
549+
actualMessageFormat: number;
550+
expectedMessageFormat: number;
551+
};
552+
[SOLANA_ERROR__OFFCHAIN_MESSAGE__MESSAGE_LENGTH_MISMATCH]: {
553+
actualLength: number;
554+
specifiedLength: number;
555+
};
556+
[SOLANA_ERROR__OFFCHAIN_MESSAGE__NUM_SIGNATURES_MISMATCH]: {
557+
numRequiredSignatures: number;
558+
signaturesLength: number;
559+
signerAddresses: string[];
560+
};
561+
[SOLANA_ERROR__OFFCHAIN_MESSAGE__SIGNATURES_MISSING]: {
562+
addresses: string[];
563+
};
564+
[SOLANA_ERROR__OFFCHAIN_MESSAGE__VERSION_NUMBER_NOT_SUPPORTED]: {
565+
unsupportedVersion: number;
566+
};
530567
[SOLANA_ERROR__RPC_SUBSCRIPTIONS__CANNOT_CREATE_SUBSCRIPTION_PLAN]: {
531568
notificationName: string;
532569
};

‎packages/errors/src/messages.ts‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,18 @@ import {
155155
SOLANA_ERROR__MALFORMED_JSON_RPC_ERROR,
156156
SOLANA_ERROR__MALFORMED_NUMBER_STRING,
157157
SOLANA_ERROR__NONCE_ACCOUNT_NOT_FOUND,
158+
SOLANA_ERROR__OFFCHAIN_MESSAGE__APPLICATION_DOMAIN_STRING_LENGTH_OUT_OF_RANGE,
159+
SOLANA_ERROR__OFFCHAIN_MESSAGE__INVALID_APPLICATION_DOMAIN_BYTE_LENGTH,
160+
SOLANA_ERROR__OFFCHAIN_MESSAGE__MAXIMUM_LENGTH_EXCEEDED,
161+
SOLANA_ERROR__OFFCHAIN_MESSAGE__MESSAGE_FORMAT_MISMATCH,
162+
SOLANA_ERROR__OFFCHAIN_MESSAGE__MESSAGE_LENGTH_MISMATCH,
163+
SOLANA_ERROR__OFFCHAIN_MESSAGE__MESSAGE_MUST_BE_NON_EMPTY,
164+
SOLANA_ERROR__OFFCHAIN_MESSAGE__NUM_ENVELOPE_SIGNATURES_CANNOT_BE_ZERO,
165+
SOLANA_ERROR__OFFCHAIN_MESSAGE__NUM_REQUIRED_SIGNERS_CANNOT_BE_ZERO,
166+
SOLANA_ERROR__OFFCHAIN_MESSAGE__NUM_SIGNATURES_MISMATCH,
167+
SOLANA_ERROR__OFFCHAIN_MESSAGE__RESTRICTED_ASCII_BODY_CHARACTER_OUT_OF_RANGE,
168+
SOLANA_ERROR__OFFCHAIN_MESSAGE__SIGNATURES_MISSING,
169+
SOLANA_ERROR__OFFCHAIN_MESSAGE__VERSION_NUMBER_NOT_SUPPORTED,
158170
SOLANA_ERROR__RPC__API_PLAN_MISSING_FOR_RPC_METHOD,
159171
SOLANA_ERROR__RPC__INTEGER_OVERFLOW,
160172
SOLANA_ERROR__RPC__TRANSPORT_HTTP_ERROR,
@@ -482,6 +494,33 @@ export const SolanaErrorMessages: Readonly<{
482494
[SOLANA_ERROR__MALFORMED_JSON_RPC_ERROR]: '$message',
483495
[SOLANA_ERROR__MALFORMED_NUMBER_STRING]: '`$value` cannot be parsed as a `Number`',
484496
[SOLANA_ERROR__NONCE_ACCOUNT_NOT_FOUND]: 'No nonce account could be found at address `$nonceAccountAddress`',
497+
[SOLANA_ERROR__OFFCHAIN_MESSAGE__INVALID_APPLICATION_DOMAIN_BYTE_LENGTH]:
498+
'Expected base58 encoded application domain to decode to a byte array of length 32. Actual length: $actualLength.',
499+
[SOLANA_ERROR__OFFCHAIN_MESSAGE__APPLICATION_DOMAIN_STRING_LENGTH_OUT_OF_RANGE]:
500+
'Expected base58-encoded application domain string of length in the range [32, 44]. Actual length: $actualLength.',
501+
[SOLANA_ERROR__OFFCHAIN_MESSAGE__MAXIMUM_LENGTH_EXCEEDED]:
502+
'The message body provided has a byte-length of $actualBytes. The maximum allowable ' +
503+
'byte-length is $maxBytes',
504+
[SOLANA_ERROR__OFFCHAIN_MESSAGE__MESSAGE_FORMAT_MISMATCH]:
505+
'Expected message format $expectedMessageFormat, got $actualMessageFormat',
506+
[SOLANA_ERROR__OFFCHAIN_MESSAGE__MESSAGE_LENGTH_MISMATCH]:
507+
'The message length specified in the message preamble is $specifiedLength bytes. The actual length of the message is $actualLength bytes.',
508+
[SOLANA_ERROR__OFFCHAIN_MESSAGE__MESSAGE_MUST_BE_NON_EMPTY]: 'Offchain message content must be non-empty',
509+
[SOLANA_ERROR__OFFCHAIN_MESSAGE__NUM_REQUIRED_SIGNERS_CANNOT_BE_ZERO]:
510+
'Offchain message must specify the address of at least one required signer',
511+
[SOLANA_ERROR__OFFCHAIN_MESSAGE__NUM_ENVELOPE_SIGNATURES_CANNOT_BE_ZERO]:
512+
'Offchain message envelope must reserve space for at least one signature',
513+
[SOLANA_ERROR__OFFCHAIN_MESSAGE__NUM_SIGNATURES_MISMATCH]:
514+
'The offchain message preamble specifies $numRequiredSignatures required signature(s), got $signaturesLength.',
515+
[SOLANA_ERROR__OFFCHAIN_MESSAGE__SIGNATURES_MISSING]:
516+
'Offchain message is missing signatures for addresses: $addresses.',
517+
[SOLANA_ERROR__OFFCHAIN_MESSAGE__RESTRICTED_ASCII_BODY_CHARACTER_OUT_OF_RANGE]:
518+
'The message body provided contains characters whose codes fall outside the allowed ' +
519+
'range. In order to ensure clear-signing compatiblity with hardware wallets, the message ' +
520+
'may only contain line feeds and characters in the range [\\x20-\\x7e].',
521+
[SOLANA_ERROR__OFFCHAIN_MESSAGE__VERSION_NUMBER_NOT_SUPPORTED]:
522+
'This version of Kit does not support decoding offchain messages with version ' +
523+
'$unsupportedVersion. The current max supported version is 0.',
485524
[SOLANA_ERROR__RPC_SUBSCRIPTIONS__CANNOT_CREATE_SUBSCRIPTION_PLAN]:
486525
"The notification name must end in 'Notifications' and the API must supply a " +
487526
"subscription plan creator function for the notification '$notificationName'.",

0 commit comments

Comments
 (0)