@exodus/web3-solana-utils

Version: 0.0.0

Classes

VersionedTransactionUnsupportedError

Interfaces

SolanaSignInInput

SolanaSimulateMessageParams

SolSimulateTransactionParams

SolanaSignInInput

SolanaSimulateMessageParams

SolSimulateTransactionParams

Functions

applySignatures

buildRawTransaction

condensePublicKey

createSignInMessageText

decodeMessage

decompileTransactionMessage

deserializeEncodedMessage

deserializeMessageSignature

deserializePublicKey

deserializeTransaction

deserializeTransactionBytes

deserializeTransactionSignature

isTransactionVersionSupported

isVersionedTransaction

prepareSolTransactions

serializeEncodedMessage

serializeMessageSignature

serializePublicKey

serializeTransaction

serializeTransactionAsBytes

serializeTransactionSignature

createSignInMessageText

createSimulateMessage

createSimulateTransactions

decodeMessage

decodeRecipientAddresses

decompileTransactionMessage

deserializeEncodedMessage

deserializeMessageSignature

deserializePublicKey

deserializeTransaction

deserializeTransactionBytes

deserializeTransactionSignature

isTransactionVersionSupported

isVersionedTransaction

prepareSolTransactions

serializeEncodedMessage

serializeMessageSignature

serializePublicKey

serializeTransaction

serializeTransactionAsBytes

serializeTransactionSignature

sign

Type Aliases

AdvancedDetails

DecodedTransactionInstruction

LegacyOrVersionedTransaction

PreparedMessages

SolAggregatedTransactionSimulationResult

SolanaSignInInputWithRequiredFields

SolDisplayEncoding

AdvancedDetails

DecodedTransactionInstruction

LegacyOrVersionedTransaction

PreparedMessages

SolAggregatedTransactionSimulationResult

SolanaSignInInputWithRequiredFields

SolDisplayEncoding

Variables

createSimulateMessage

createSimulateTransactions

decodeRecipientAddresses

MAX_SIGNATURES

SIGNATURE_LENGTH

SUPPORTED_TRANSACTION_VERSIONS

VERSIONED_TRANSACTION_SUPPORTED

MAX_SIGNATURES

SIGNATURE_LENGTH

SUPPORTED_TRANSACTION_VERSIONS

VERSIONED_TRANSACTION_SUPPORTED

VersionedTransactionUnsupportedError

class

Constructor

constructor

VersionedTransactionUnsupportedError(): VersionedTransactionUnsupportedError

Returns:

VersionedTransactionUnsupportedError

createSimulateMessage

variable

Type

const createSimulateMessage: () => { ... }

Signature

__type(): any

Returns:

any

createSimulateTransactions

variable

Type

const createSimulateTransactions: ({ apiEndpoint, headers: headersFromDeps, assetClientInterface, }: any) => { ... }

Signature

__type({ apiEndpoint, headers: headersFromDeps, assetClientInterface, }: any): any

Parameters:

{ apiEndpoint, headers: headersFromDeps, assetClientInterface, }: any

Returns:

any

decodeRecipientAddresses

variable

Type

const decodeRecipientAddresses: (transaction: LegacyOrVersionedTransaction) => string[]

Signature

__type(transaction: LegacyOrVersionedTransaction): string[]

Parameters:

transaction: LegacyOrVersionedTransaction

Returns:

string[]

MAX_SIGNATURES

variable

Type

255

SIGNATURE_LENGTH

variable

Type

SUPPORTED_TRANSACTION_VERSIONS

variable

Type

ReadonlySet

VERSIONED_TRANSACTION_SUPPORTED

variable

Type

true

applySignatures

function

Signature

applySignatures(transaction: LegacyOrVersionedTransaction, signedTransaction: LegacyOrVersionedTransaction): void

Parameters:

transaction: LegacyOrVersionedTransaction

signedTransaction: LegacyOrVersionedTransaction

Returns:

void

buildRawTransaction

function

Signature

buildRawTransaction(signData: Buffer, signatures: null | Uint8Array[]): Buffer

Parameters:

signData: Buffer

signatures: null | Uint8Array[]

Returns:

Buffer

condensePublicKey

function

Signature

condensePublicKey(publicKey: PublicKey): string

Parameters:

publicKey: PublicKey

Returns:

string

createSignInMessageText

function

Signature

createSignInMessageText(input: SolanaSignInInputWithRequiredFields): string

Parameters:

input: SolanaSignInInputWithRequiredFields

Returns:

string

decodeMessage

function

Signature

decodeMessage(encodedMessage: Bytes, display: SolDisplayEncoding): string

Parameters:

encodedMessage: Bytes

display: SolDisplayEncoding

Returns:

string

decompileTransactionMessage

function

Signature

decompileTransactionMessage(transactionMessage: VersionedTransaction): Promise

Parameters:

transactionMessage: VersionedTransaction

Returns:

Promise

deserializeEncodedMessage

function

Signature

deserializeEncodedMessage(wireEncodedMessage: string): Bytes

Parameters:

wireEncodedMessage: string

Returns:

Bytes

deserializeMessageSignature

function

Signature

deserializeMessageSignature(wireSignature: string): Bytes

Parameters:

wireSignature: string

Returns:

Bytes

deserializePublicKey

function

Signature

deserializePublicKey(wirePublicKey: string): PublicKey

Parameters:

wirePublicKey: string

Returns:

PublicKey

deserializeTransaction

function

Signature

deserializeTransaction(wireTransaction: string): LegacyOrVersionedTransaction

Parameters:

wireTransaction: string

Returns:

LegacyOrVersionedTransaction

deserializeTransactionBytes

function

Signature

deserializeTransactionBytes(wireTransactionBuffer: Bytes): LegacyOrVersionedTransaction

Parameters:

wireTransactionBuffer: Bytes

Returns:

LegacyOrVersionedTransaction

deserializeTransactionSignature

function

Signature

deserializeTransactionSignature(encodedSignature: string): Bytes

Parameters:

encodedSignature: string

Returns:

Bytes

encodeMessage

function

Signature

encodeMessage(message: string): Bytes

Parameters:

message: string

Returns:

Bytes

getFirstSignature

function

Signature

getFirstSignature(transaction: LegacyOrVersionedTransaction): null | Buffer

Parameters:

transaction: LegacyOrVersionedTransaction

Returns:

null | Buffer

getTransactionId

function

Signature

getTransactionId(transaction: LegacyOrVersionedTransaction): string

Parameters:

transaction: LegacyOrVersionedTransaction

Returns:

string

isLegacyTransaction

function

Signature

isLegacyTransaction(transaction: LegacyOrVersionedTransaction): any

Parameters:

transaction: LegacyOrVersionedTransaction

Returns:

any

isMessageDisplaySafe

function

Signature

isMessageDisplaySafe(encodedMessage: Bytes, display: SolDisplayEncoding, message?: string): boolean

Parameters:

encodedMessage: Bytes

display: SolDisplayEncoding

message (optional): string

Returns:

boolean

isTransactionMessage

function

Signature

isTransactionMessage(data: Bytes): boolean

Parameters:

data: Bytes

Returns:

boolean

isTransactionVersionSupported

function

Signature

isTransactionVersionSupported(transaction: VersionedTransaction): boolean

Parameters:

transaction: VersionedTransaction

Returns:

boolean

isVersionedTransaction

function

Signature

isVersionedTransaction(transaction: LegacyOrVersionedTransaction): any

Parameters:

transaction: LegacyOrVersionedTransaction

Returns:

any

prepareSolTransactions

function

Signature

prepareSolTransactions(transactions: LegacyOrVersionedTransaction[]): Promise

Parameters:

transactions: LegacyOrVersionedTransaction[]

Returns:

Promise

serializeEncodedMessage

function

Signature

serializeEncodedMessage(encodedMessage: Bytes): string

Parameters:

encodedMessage: Bytes

Returns:

string

serializeMessageSignature

function

Signature

serializeMessageSignature(signature: Bytes): string

Parameters:

signature: Bytes

Returns:

string

serializePublicKey

function

Signature

serializePublicKey(publicKey: PublicKey): string

Parameters:

publicKey: PublicKey

Returns:

string

serializeTransaction

function

Signature

serializeTransaction(transaction: LegacyOrVersionedTransaction, config?: any): string

Parameters:

transaction: LegacyOrVersionedTransaction

config (optional): any

Returns:

string

serializeTransactionAsBytes

function

Signature

serializeTransactionAsBytes(transaction: LegacyOrVersionedTransaction, __namedParameters?: any): Buffer

Parameters:

transaction: LegacyOrVersionedTransaction

__namedParameters (optional): any

Returns:

Buffer

serializeTransactionSignature

function

Signature

serializeTransactionSignature(signature: Bytes): string

Parameters:

signature: Bytes

Returns:

string

sign

function

Signature

sign(message: Bytes, secretKey: Bytes): Bytes

Parameters:

message: Bytes

secretKey: Bytes

Returns:

Bytes

SolanaSignInInput

interface

Properties

address?

Optional EIP-4361 Address. If not provided, the wallet must determine the Address to include in the message.

string

chainId?

Optional EIP-4361 Chain ID. If not provided, the wallet must not include Chain ID in the message.

string

domain?

Optional EIP-4361 Domain. If not provided, the wallet must determine the Domain to include in the message.

string

expirationTime?

Optional EIP-4361 Expiration Time. If not provided, the wallet must not include Expiration Time in the message.

string

issuedAt?

Optional EIP-4361 Issued At. If not provided, the wallet must not include Issued At in the message.

string

nonce?

Optional EIP-4361 Nonce. If not provided, the wallet must not include Nonce in the message.

string

notBefore?

Optional EIP-4361 Not Before. If not provided, the wallet must not include Not Before in the message.

string

requestId?

Optional EIP-4361 Request ID. If not provided, the wallet must not include Request ID in the message.

string

resources?

Optional EIP-4361 Resources. If not provided, the wallet must not include Resources in the message.

any

statement?

Optional EIP-4361 Statement. If not provided, the wallet must not include Statement in the message.

string

uri?

Optional EIP-4361 URI. If not provided, the wallet must not include URI in the message.

string

version?

Optional EIP-4361 Version. If not provided, the wallet must not include Version in the message.

string

SolanaSimulateMessageParams

interface

Properties

address

string

asset

Asset

message

string

url

URL

SolSimulateTransactionParams

interface

Properties

asset

Asset

blockNumber?

string

executionMode?

ExecutionMode

headers?

Record

origin

string

overrideApiEndpoint?

string

recipientAddress?

string

senderAddress

string

senderAddresses?

string[]

transactions

LegacyOrVersionedTransaction[]

AdvancedDetails

type

DecodedTransactionInstruction

type

Properties

data

Record

title

string

LegacyOrVersionedTransaction

type

PreparedMessages

type

Properties

compiled

Message | VersionedMessage

decompiled?

TransactionMessage | null

SolAggregatedTransactionSimulationResult

type

SolanaSignInInputWithRequiredFields

type

SolDisplayEncoding

type

VersionedTransactionUnsupportedError

class

Constructor

constructor

VersionedTransactionUnsupportedError(): VersionedTransactionUnsupportedError

Returns:

VersionedTransactionUnsupportedError

MAX_SIGNATURES

variable

Type

255

SIGNATURE_LENGTH

variable

Type

SUPPORTED_TRANSACTION_VERSIONS

variable

Type

ReadonlySet

VERSIONED_TRANSACTION_SUPPORTED

variable

Type

true

applySignatures

function

Signature

applySignatures(transaction: LegacyOrVersionedTransaction, signedTransaction: LegacyOrVersionedTransaction): void

Parameters:

transaction: LegacyOrVersionedTransaction

signedTransaction: LegacyOrVersionedTransaction

Returns:

void

buildRawTransaction

function

Signature

buildRawTransaction(signData: Buffer, signatures: null | Uint8Array[]): Buffer

Parameters:

signData: Buffer

signatures: null | Uint8Array[]

Returns:

Buffer

condensePublicKey

function

Signature

condensePublicKey(publicKey: PublicKey): string

Parameters:

publicKey: PublicKey

Returns:

string

createSignInMessageText

function

Signature

createSignInMessageText(input: SolanaSignInInputWithRequiredFields): string

Parameters:

input: SolanaSignInInputWithRequiredFields

Returns:

string

createSimulateMessage

function

Signature

createSimulateMessage(): any

Returns:

any

createSimulateTransactions

function

Signature

createSimulateTransactions(__namedParameters: any): any

Parameters:

__namedParameters: any

Returns:

any

decodeMessage

function

Signature

decodeMessage(encodedMessage: Bytes, display: SolDisplayEncoding): string

Parameters:

encodedMessage: Bytes

display: SolDisplayEncoding

Returns:

string

decodeRecipientAddresses

function

Signature

decodeRecipientAddresses(transaction: LegacyOrVersionedTransaction): string[]

Parameters:

transaction: LegacyOrVersionedTransaction

Returns:

string[]

decompileTransactionMessage

function

Signature

decompileTransactionMessage(transactionMessage: VersionedTransaction): Promise

Parameters:

transactionMessage: VersionedTransaction

Returns:

Promise

deserializeEncodedMessage

function

Signature

deserializeEncodedMessage(wireEncodedMessage: string): Bytes

Parameters:

wireEncodedMessage: string

Returns:

Bytes

deserializeMessageSignature

function

Signature

deserializeMessageSignature(wireSignature: string): Bytes

Parameters:

wireSignature: string

Returns:

Bytes

deserializePublicKey

function

Signature

deserializePublicKey(wirePublicKey: string): PublicKey

Parameters:

wirePublicKey: string

Returns:

PublicKey

deserializeTransaction

function

Signature

deserializeTransaction(wireTransaction: string): LegacyOrVersionedTransaction

Parameters:

wireTransaction: string

Returns:

LegacyOrVersionedTransaction

deserializeTransactionBytes

function

Signature

deserializeTransactionBytes(wireTransactionBuffer: Bytes): LegacyOrVersionedTransaction

Parameters:

wireTransactionBuffer: Bytes

Returns:

LegacyOrVersionedTransaction

deserializeTransactionSignature

function

Signature

deserializeTransactionSignature(encodedSignature: string): Bytes

Parameters:

encodedSignature: string

Returns:

Bytes

encodeMessage

function

Signature

encodeMessage(message: string): Bytes

Parameters:

message: string

Returns:

Bytes

getFirstSignature

function

Signature

getFirstSignature(transaction: LegacyOrVersionedTransaction): null | Buffer

Parameters:

transaction: LegacyOrVersionedTransaction

Returns:

null | Buffer

getTransactionId

function

Signature

getTransactionId(transaction: LegacyOrVersionedTransaction): string

Parameters:

transaction: LegacyOrVersionedTransaction

Returns:

string

isLegacyTransaction

function

Signature

isLegacyTransaction(transaction: LegacyOrVersionedTransaction): any

Parameters:

transaction: LegacyOrVersionedTransaction

Returns:

any

isMessageDisplaySafe

function

Signature

isMessageDisplaySafe(encodedMessage: Bytes, display: SolDisplayEncoding, message: string): boolean

Parameters:

encodedMessage: Bytes

display: SolDisplayEncoding

message: string

Returns:

boolean

isTransactionMessage

function

Signature

isTransactionMessage(data: Bytes): boolean

Parameters:

data: Bytes

Returns:

boolean

isTransactionVersionSupported

function

Signature

isTransactionVersionSupported(transaction: VersionedTransaction): boolean

Parameters:

transaction: VersionedTransaction

Returns:

boolean

isVersionedTransaction

function

Signature

isVersionedTransaction(transaction: LegacyOrVersionedTransaction): any

Parameters:

transaction: LegacyOrVersionedTransaction

Returns:

any

prepareSolTransactions

function

Signature

prepareSolTransactions(transactions: LegacyOrVersionedTransaction[]): Promise

Parameters:

transactions: LegacyOrVersionedTransaction[]

Returns:

Promise

serializeEncodedMessage

function

Signature

serializeEncodedMessage(encodedMessage: Bytes): string

Parameters:

encodedMessage: Bytes

Returns:

string

serializeMessageSignature

function

Signature

serializeMessageSignature(signature: Bytes): string

Parameters:

signature: Bytes

Returns:

string

serializePublicKey

function

Signature

serializePublicKey(publicKey: PublicKey): string

Parameters:

publicKey: PublicKey

Returns:

string

serializeTransaction

function

Signature

serializeTransaction(transaction: LegacyOrVersionedTransaction, config?: any): string

Parameters:

transaction: LegacyOrVersionedTransaction

config (optional): any

Returns:

string

serializeTransactionAsBytes

function

Signature

serializeTransactionAsBytes(transaction: LegacyOrVersionedTransaction, __namedParameters: any): Buffer

Parameters:

transaction: LegacyOrVersionedTransaction

__namedParameters: any

Returns:

Buffer

serializeTransactionSignature

function

Signature

serializeTransactionSignature(signature: Bytes): string

Parameters:

signature: Bytes

Returns:

string

sign

function

Signature

sign(message: Bytes, secretKey: Bytes): Bytes

Parameters:

message: Bytes

secretKey: Bytes

Returns:

Bytes

SolanaSignInInput

interface

Properties

address?

Optional EIP-4361 Address. If not provided, the wallet must determine the Address to include in the message.

string

chainId?

Optional EIP-4361 Chain ID. If not provided, the wallet must not include Chain ID in the message.

string

domain?

Optional EIP-4361 Domain. If not provided, the wallet must determine the Domain to include in the message.

string

expirationTime?

Optional EIP-4361 Expiration Time. If not provided, the wallet must not include Expiration Time in the message.

string

issuedAt?

Optional EIP-4361 Issued At. If not provided, the wallet must not include Issued At in the message.

string

nonce?

Optional EIP-4361 Nonce. If not provided, the wallet must not include Nonce in the message.

string

notBefore?

Optional EIP-4361 Not Before. If not provided, the wallet must not include Not Before in the message.

string

requestId?

Optional EIP-4361 Request ID. If not provided, the wallet must not include Request ID in the message.

string

resources?

Optional EIP-4361 Resources. If not provided, the wallet must not include Resources in the message.

any

statement?

Optional EIP-4361 Statement. If not provided, the wallet must not include Statement in the message.

string

uri?

Optional EIP-4361 URI. If not provided, the wallet must not include URI in the message.

string

version?

Optional EIP-4361 Version. If not provided, the wallet must not include Version in the message.

string

SolanaSimulateMessageParams

interface

Properties

address

string

asset

Asset

message

string

url

URL

SolSimulateTransactionParams

interface

Properties

asset

Asset

blockNumber?

string

executionMode?

ExecutionMode

headers?

Record

origin

string

overrideApiEndpoint?

string

recipientAddress?

string

senderAddress

string

senderAddresses?

string[]

transactions

LegacyOrVersionedTransaction[]

AdvancedDetails

type

DecodedTransactionInstruction

type

Properties

data

Record

title

string

LegacyOrVersionedTransaction

type

PreparedMessages

type

Properties

compiled

Message | VersionedMessage

decompiled?

TransactionMessage | null

SolAggregatedTransactionSimulationResult

type

SolanaSignInInputWithRequiredFields

type

SolDisplayEncoding

type

@exodus/web3-management @exodus/web3-simulation