kaspeak-sdk / Payload

Class: Payload¶

Defined in: models/payload.ts:21

Constructors¶

Constructor¶

new Payload(prefix, type, identifier, publicKey, signatureType, data): Payload

Defined in: models/payload.ts:32

Parameters¶

prefix¶

Uint8Array

type¶

number

identifier¶

Identifier | SecretIdentifier

publicKey¶

Uint8Array

signatureType¶

number | SignatureType

data¶

Uint8Array

Returns¶

Payload

Properties¶

data¶

data: Uint8Array

Defined in: models/payload.ts:30

id¶

id: Uint8Array

Defined in: models/payload.ts:26

marker¶

marker: Uint8Array

Defined in: models/payload.ts:22

prefix¶

prefix: Uint8Array

Defined in: models/payload.ts:24

publicKey¶

publicKey: Uint8Array

Defined in: models/payload.ts:27

signature¶

signature: Uint8Array

Defined in: models/payload.ts:29

signatureType¶

signatureType: number

Defined in: models/payload.ts:28

type¶

type: number

Defined in: models/payload.ts:25

version¶

version: number

Defined in: models/payload.ts:23

Methods¶

getPrefix()¶

getPrefix(): string

Defined in: models/payload.ts:155

Returns¶

string

getSize()¶

getSize(): number

Defined in: models/payload.ts:151

Returns¶

number

sign()¶

sign(outIds, privs): Promise\<void>

Defined in: models/payload.ts:138

Parameters¶

outIds¶

string

privs¶

(number | bigint | Uint8Array\<ArrayBufferLike>)[]

Returns¶

Promise\<void>

toBytes()¶

toBytes(): Uint8Array

Defined in: models/payload.ts:96

Returns¶

Uint8Array

toHex()¶

toHex(): string

Defined in: models/payload.ts:120

Returns¶

string

verify()¶

verify(outIds): Promise\<boolean>

Defined in: models/payload.ts:142

Parameters¶

outIds¶

string

Returns¶

Promise\<boolean>

fromBytes()¶

static fromBytes(bytes): Payload

Defined in: models/payload.ts:53

Parameters¶

bytes¶

Uint8Array

Returns¶

Payload

fromHex()¶

static fromHex(data): Payload

Defined in: models/payload.ts:80

Parameters¶

data¶

string

Returns¶

Payload

fromIndexerRecord()¶

static fromIndexerRecord(rec): Payload

Defined in: models/payload.ts:84

Parameters¶

rec¶

MessageRecord

Returns¶

Payload