Class PublicKey`Abstract`

A public key

Hierarchy (View Summary)

PublicKey

Index

Constructors

Methods

equals flag toBase64 toRawBytes toString toSuiAddress toSuiBytes toSuiPublicKey verify verifyAddress verifyPersonalMessage verifyTransaction verifyWithIntent

Constructors

constructor

new PublicKey(): PublicKey
Returns PublicKey

Methods

equals

equals(publicKey: PublicKey): boolean
Checks if two public keys are equal
Parameters
- publicKey: PublicKey
Returns boolean
- Defined in packages/typescript/src/cryptography/publickey.ts:41

`Abstract`flag

flag(): number
Return signature scheme flag of the public key

Returns number
- Defined in packages/typescript/src/cryptography/publickey.ts:135

toBase64

toBase64(): string
Return the base-64 representation of the public key

Returns string
- Defined in packages/typescript/src/cryptography/publickey.ts:48

`Abstract`toRawBytes

toRawBytes(): Uint8Array
Return the byte array representation of the public key

Returns Uint8Array
- Defined in packages/typescript/src/cryptography/publickey.ts:130

toString

toString(): never
Returns never
- Defined in packages/typescript/src/cryptography/publickey.ts:52

toSuiAddress

toSuiAddress(): string
Return the Sui address associated with this Ed25519 public key

Returns string
- Defined in packages/typescript/src/cryptography/publickey.ts:120

toSuiBytes

toSuiBytes(): Uint8Array
Returns the bytes representation of the public key prefixed with the signature scheme flag

Returns Uint8Array
- Defined in packages/typescript/src/cryptography/publickey.ts:108

toSuiPublicKey

toSuiPublicKey(): string
Return the Sui representation of the public key encoded in base-64. A Sui public key is formed by the concatenation of the scheme flag with the raw bytes of the public key

Returns string
- Defined in packages/typescript/src/cryptography/publickey.ts:63

`Abstract`verify

verify(
data: Uint8Array,
signature: string | Uint8Array<ArrayBufferLike>,
): Promise<boolean>
Verifies that the signature is valid for for the provided message
Parameters
- data: Uint8Array
- signature: string | Uint8Array<ArrayBufferLike>
Returns Promise<boolean>
- Defined in packages/typescript/src/cryptography/publickey.ts:140

verifyAddress

verifyAddress(address: string): boolean
Verifies that the public key is associated with the provided address
Parameters
- address: string
Returns boolean
- Defined in packages/typescript/src/cryptography/publickey.ts:100

verifyPersonalMessage

verifyPersonalMessage(
message: Uint8Array,
signature: string | Uint8Array<ArrayBufferLike>,
): Promise<boolean>
Verifies that the signature is valid for for the provided PersonalMessage
Parameters
- message: Uint8Array
- signature: string | Uint8Array<ArrayBufferLike>
Returns Promise<boolean>
- Defined in packages/typescript/src/cryptography/publickey.ts:82

verifyTransaction

verifyTransaction(
transaction: Uint8Array,
signature: string | Uint8Array<ArrayBufferLike>,
): Promise<boolean>
Verifies that the signature is valid for for the provided Transaction
Parameters
- transaction: Uint8Array
- signature: string | Uint8Array<ArrayBufferLike>
Returns Promise<boolean>
- Defined in packages/typescript/src/cryptography/publickey.ts:93

verifyWithIntent

verifyWithIntent(
    bytes: Uint8Array,
    signature: string | Uint8Array<ArrayBufferLike>,
    intent: IntentScope,
): Promise<boolean>
Parameters
- bytes: Uint8Array
- signature: string | Uint8Array<ArrayBufferLike>
- intent: IntentScope
Returns Promise<boolean>
- Defined in packages/typescript/src/cryptography/publickey.ts:68