kaspeak-sdk / Payload

Class: Payload¶

Defined in: models/payload.ts:16

Constructors¶

Constructor¶

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

Defined in: models/payload.ts:26

Parameters¶

prefix¶

Uint8Array

type¶

number

identifier¶

Identifier | SecretIdentifier

publicKey¶

Uint8Array

data¶

Uint8Array

Returns¶

Payload

Properties¶

data¶

data: Uint8Array

Defined in: models/payload.ts:24

id¶

id: Uint8Array

Defined in: models/payload.ts:21

marker¶

marker: Uint8Array

Defined in: models/payload.ts:17

prefix¶

prefix: Uint8Array

Defined in: models/payload.ts:19

publicKey¶

publicKey: Uint8Array

Defined in: models/payload.ts:22

signature¶

signature: Uint8Array

Defined in: models/payload.ts:23

type¶

type: number

Defined in: models/payload.ts:20

version¶

version: number

Defined in: models/payload.ts:18

Methods¶

getPrefix()¶

getPrefix(): string

Defined in: models/payload.ts:122

Returns¶

string

getSize()¶

getSize(): number

Defined in: models/payload.ts:118

Returns¶

number

sign()¶

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

Defined in: models/payload.ts:109

Parameters¶

outIds¶

string

priv¶

number | bigint

Returns¶

Promise\<void>

toBytes()¶

toBytes(): Uint8Array

Defined in: models/payload.ts:69

Returns¶

Uint8Array

toHex()¶

toHex(): string

Defined in: models/payload.ts:92

Returns¶

string

verify()¶

verify(outIds): Promise\<boolean>

Defined in: models/payload.ts:113

Parameters¶

outIds¶

string

Returns¶

Promise\<boolean>

fromBytes()¶

static fromBytes(bytes): Payload

Defined in: models/payload.ts:39

Parameters¶

bytes¶

Uint8Array

Returns¶

Payload

fromHex()¶

static fromHex(data): Payload

Defined in: models/payload.ts:65

Parameters¶

data¶

string

Returns¶

Payload