@xyo-network/payload-builder

Primary SDK for using XYO Protocol 2.0

Install

Using npm:

npm install {{name}}

Using yarn:

yarn add {{name}}

Using pnpm:

pnpm add {{name}}

Using bun:

bun add {{name}}

License

See the LICENSE file for license rights and limitations (LGPL-3.0-only).

Reference

packages

protocol

### packages

  ### payload

    ### packages

      ### builder

        ### .temp-typedoc

          ### classes

            ### <a id="PayloadBuilder"></a>PayloadBuilder

@xyo-network/payload-builder

Type Parameters

T

T extends Payload = Payload<AnyObject>

R

R = T

Constructors

Constructor

new PayloadBuilder<T, R>(options): PayloadBuilder<T, R>;

Parameters

options

PayloadBuilderOptions

Returns

PayloadBuilder<T, R>

Properties

options

readonly options: PayloadBuilderOptions;

_fields?

protected optional _fields?: WithoutStorageMeta<WithoutClientMeta<WithoutSchema<T>>>;

_meta?

protected optional _meta?: DeepPickStartsWith<T, "$">;

_schema

protected _schema: Schema;

Methods

addHashMeta()

Call Signature

static addHashMeta<T>(payload): Promise<WithHashMeta<T>>;

Type Parameters

T

T extends Payload

Parameters

payload

T

Returns

Promise<WithHashMeta<T>>

Call Signature

static addHashMeta<T>(payloads): Promise<WithHashMeta<T>[]>;

Type Parameters

T

T extends Payload

Parameters

payloads

T[]

Returns

Promise<WithHashMeta<T>[]>

addStorageMeta()

Call Signature

static addStorageMeta<T>(payload, index?): Promise<WithStorageMeta<T>>;

Type Parameters

T

T extends Payload

Parameters

payload

T

index?

number

Returns

Promise<WithStorageMeta<T>>

Call Signature

static addStorageMeta<T>(payloads): Promise<WithStorageMeta<T>[]>;

Type Parameters

T

T extends Payload

Parameters

payloads

T[]

Returns

Promise<WithStorageMeta<T>[]>

compareStorageMeta()

static compareStorageMeta(
   a, 
   b, 
   comparer?): number;

Parameters

a

WithStorageMeta<Payload>

b

WithStorageMeta<Payload>

comparer?

Compare<Sequence> = SequenceComparer.local

Returns

number

dataHash()

static dataHash<T>(payload): Promise<BrandedHash>;

Type Parameters

T

T extends Payload

Parameters

payload

T

Returns

Promise<BrandedHash>

dataHashPairs()

static dataHashPairs<T>(payloads): Promise<[T, BrandedHash][]>;

Type Parameters

T

T extends Payload

Parameters

payloads

T[]

Returns

Promise<[T, BrandedHash][]>

dataHashableFields()

static dataHashableFields<T>(schema, payload): Promisable<WithoutMeta<T>>;

Type Parameters

T

T extends Payload

Parameters

schema

Schema

payload

WithoutSchema<T>

Returns

Promisable<WithoutMeta<T>>

dataHashes()

Call Signature

static dataHashes(payloads): Promise<undefined>;

Parameters

payloads

undefined

Returns

Promise<undefined>

Call Signature

static dataHashes<T>(payloads): Promise<BrandedHash[]>;

Type Parameters

T

T extends Payload

Parameters

payloads

T[]

Returns

Promise<BrandedHash[]>

filterExclude()

static filterExclude<T>(payloads?, hash): Promise<T[]>;

Type Parameters

T

T extends Payload

Parameters

payloads?

T[] = []

hash

BrandedHash | BrandedHash[]

Returns

Promise<T[]>

filterExcludeByDataHash()

static filterExcludeByDataHash<T>(payloads?, hash): Promise<T[]>;

Type Parameters

T

T extends Payload

Parameters

payloads?

T[] = []

hash

BrandedHash | BrandedHash[]

Returns

Promise<T[]>

filterIncludeByDataHash()

static filterIncludeByDataHash<T>(payloads?, hash): Promise<T[]>;

Type Parameters

T

T extends Payload

Parameters

payloads?

T[] = []

hash

BrandedHash | BrandedHash[]

Returns

Promise<T[]>

filterIncludeByEitherHash()

static filterIncludeByEitherHash<T>(payloads?, hash): Promise<T[]>;

Type Parameters

T

T extends Payload

Parameters

payloads?

T[] = []

hash

BrandedHash | BrandedHash[]

Returns

Promise<T[]>

findByDataHash()

static findByDataHash<T>(payloads?, hash): Promise<T | undefined>;

Type Parameters

T

T extends Payload

Parameters

payloads?

T[] = []

hash

BrandedHash

Returns

Promise<T | undefined>

hash()

static hash<T>(payload): Promise<BrandedHash>;

Type Parameters

T

T extends Payload

Parameters

payload

T

Returns

Promise<BrandedHash>

hashPairs()

static hashPairs<T>(payloads): Promise<[T, BrandedHash][]>;

Creates an array of payload/hash tuples based on the payloads passed in

Type Parameters

T

T extends Payload

Parameters

payloads

T[]

Returns

Promise<[T, BrandedHash][]>

An array of payload/hash tuples

hashableFields()

static hashableFields<T>(payload): WithoutStorageMeta<T>;

Type Parameters

T

T extends Payload

Parameters

payload

T

Returns

WithoutStorageMeta<T>

hashes()

Call Signature

static hashes(payloads): Promise<undefined>;

Parameters

payloads

undefined

Returns

Promise<undefined>

Call Signature

static hashes<T>(payloads): Promise<BrandedHash[]>;

Type Parameters

T

T extends Payload

Parameters

payloads

T[]

Returns

Promise<BrandedHash[]>

omitClientMeta()

Call Signature

static omitClientMeta<T>(payloads, maxDepth?): WithoutClientMeta<T>[];

Type Parameters

T

T extends Payload

Parameters

payloads

T[]

maxDepth?

number

Returns

WithoutClientMeta<T>[]

Call Signature

static omitClientMeta<T>(payloads, maxDepth?): WithoutClientMeta<T>[];

Type Parameters

T

T extends object

Parameters

payloads

T[]

maxDepth?

number

Returns

WithoutClientMeta<T>[]

Call Signature

static omitClientMeta<T>(payload, maxDepth?): WithoutClientMeta<T>;

Type Parameters

T

T extends Payload

Parameters

payload

T

maxDepth?

number

Returns

WithoutClientMeta<T>

Call Signature

static omitClientMeta<T>(payload, maxDepth?): WithoutClientMeta<T>;

Type Parameters

T

T extends object

Parameters

payload

T

maxDepth?

number

Returns

WithoutClientMeta<T>

omitMeta()

Call Signature

static omitMeta<T>(payloads, maxDepth?): WithoutMeta<T>[];

Type Parameters

T

T extends Payload

Parameters

payloads

T[]

maxDepth?

number

Returns

WithoutMeta<T>[]

Call Signature

static omitMeta<T>(payloads, maxDepth?): WithoutMeta<T>[];

Type Parameters

T

T extends object

Parameters

payloads

T[]

maxDepth?

number

Returns

WithoutMeta<T>[]

Call Signature

static omitMeta<T>(payload, maxDepth?): WithoutMeta<T>;

Type Parameters

T

T extends Payload

Parameters

payload

T

maxDepth?

number

Returns

WithoutMeta<T>

Call Signature

static omitMeta<T>(payload, maxDepth?): WithoutMeta<T>;

Type Parameters

T

T extends object

Parameters

payload

T

maxDepth?

number

Returns

WithoutMeta<T>

omitPrivateStorageMeta()

Call Signature

static omitPrivateStorageMeta<T>(payloads, maxDepth?): WithoutPrivateStorageMeta<T>[];

Type Parameters

T

T extends Payload

Parameters

payloads

T[]

maxDepth?

number

Returns

WithoutPrivateStorageMeta<T>[]

Call Signature

static omitPrivateStorageMeta<T>(payloads, maxDepth?): WithoutPrivateStorageMeta<T>[];

Type Parameters

T

T extends object

Parameters

payloads

T[]

maxDepth?

number

Returns

WithoutPrivateStorageMeta<T>[]

Call Signature

static omitPrivateStorageMeta<T>(payload, maxDepth?): WithoutPrivateStorageMeta<T>;

Type Parameters

T

T extends Payload

Parameters

payload

T

maxDepth?

number

Returns

WithoutPrivateStorageMeta<T>

Call Signature

static omitPrivateStorageMeta<T>(payload, maxDepth?): WithoutPrivateStorageMeta<T>;

Type Parameters

T

T extends object

Parameters

payload

T

maxDepth?

number

Returns

WithoutPrivateStorageMeta<T>

omitStorageMeta()

Call Signature

static omitStorageMeta<T>(payloads, maxDepth?): WithoutStorageMeta<T[number]>[];

Type Parameters

T

T extends object[]

Parameters

payloads

T

maxDepth?

number

Returns

WithoutStorageMeta<T[number]>[]

Call Signature

static omitStorageMeta<T>(payloads, maxDepth?): WithoutStorageMeta<T[number]>[];

Type Parameters

T

T extends Payload[]

Parameters

payloads

T

maxDepth?

number

Returns

WithoutStorageMeta<T[number]>[]

Call Signature

static omitStorageMeta<T>(payload, maxDepth?): WithoutStorageMeta<T>;

Type Parameters

T

T extends object

Parameters

payload

T

maxDepth?

number

Returns

WithoutStorageMeta<T>

Call Signature

static omitStorageMeta<T>(payload, maxDepth?): WithoutStorageMeta<T>;

Type Parameters

T

T extends Payload

Parameters

payload

T

maxDepth?

number

Returns

WithoutStorageMeta<T>

pickClientMeta()

Call Signature

static pickClientMeta<T>(payloads, maxDepth?): WithOnlyClientMeta<T>[];

Type Parameters

T

T extends Payload

Parameters

payloads

T[]

maxDepth?

number

Returns

WithOnlyClientMeta<T>[]

Call Signature

static pickClientMeta<T>(payload, maxDepth?): WithOnlyClientMeta<T>;

Type Parameters

T

T extends Payload

Parameters

payload

T

maxDepth?

number

Returns

WithOnlyClientMeta<T>

sortByStorageMeta()

static sortByStorageMeta<T>(
   payloads, 
   direction?, 
   comparer?): WithStorageMeta<T>[];

Type Parameters

T

T extends Payload

Parameters

payloads

WithStorageMeta<T>[]

direction?

-1 | 1

comparer?

Compare<Sequence> = SequenceComparer.local

Returns

WithStorageMeta<T>[]

toAllHashMap()

static toAllHashMap<T>(payloads): Promise<Record<BrandedHash, T>>;

Type Parameters

T

T extends Payload

Parameters

payloads

T[]

Returns

Promise<Record<BrandedHash, T>>

toDataHashMap()

static toDataHashMap<T>(objs): Promise<Record<BrandedHash, T>>;

Type Parameters

T

T extends Payload

Parameters

objs

T[]

Returns

Promise<Record<BrandedHash, T>>

toHashMap()

static toHashMap<T>(objs): Promise<Record<BrandedHash, T>>;

Creates an object map of payload hashes to payloads based on the payloads passed in

Type Parameters

T

T extends Payload

Parameters

objs

T[]

Any array of payloads

Returns

Promise<Record<BrandedHash, T>>

A map of hashes to payloads

build()

build(): R;

Returns

R

dataHashableFields()

dataHashableFields(): Promise<WithoutMeta<T>>;

Returns

Promise<WithoutMeta<T>>

fields()

fields(fields): PayloadBuilder<T, R>;

Parameters

fields

WithoutSchema<WithoutStorageMeta<WithoutClientMeta<T>>>

Returns

PayloadBuilder<T, R>

meta()

meta(meta): PayloadBuilder<T, R>;

Parameters

meta

DeepPickStartsWith<T>

Returns

PayloadBuilder<T, R>

schema()

schema(value): void;

Parameters

value

Schema

Returns

void

          ### functions

            ### <a id="omitSchema"></a>omitSchema

@xyo-network/payload-builder

function omitSchema<T>(payload): WithoutSchema<T>;

Type Parameters

T

T extends WithOptionalSchema

Parameters

payload

T

Returns

WithoutSchema<T>

          ### interfaces

            ### <a id="PayloadBuilderOptions"></a>PayloadBuilderOptions

@xyo-network/payload-builder

Properties

logger?

readonly optional logger?: Logger;

schema

readonly schema: Schema;