Class BoundWitnessWrapper<TBoundWitness, TPayload>

Type Parameters

TBoundWitness extends BoundWitness<{ schema: string }> = BoundWitness
TPayload extends Payload = Payload

Hierarchy (View Summary)

PayloadWrapperBase<TBoundWitness>
- BoundWitnessWrapper
  - QueryBoundWitnessWrapper

Constructors

`Protected`constructor

new BoundWitnessWrapper<
    TBoundWitness extends BoundWitness<{ schema: string }> = BoundWitness,
    TPayload extends Payload = Payload,
>(
    boundwitness: TBoundWitness,
    payloads?: TPayload[],
    moduleErrors?: Payload[],
): BoundWitnessWrapper<TBoundWitness, TPayload>
Type Parameters
- TBoundWitness extends BoundWitness<{ schema: string }> = BoundWitness
- TPayload extends Payload = Payload
Parameters
- boundwitness: TBoundWitness
- Optionalpayloads: TPayload[]
- OptionalmoduleErrors: Payload[]
Returns BoundWitnessWrapper<TBoundWitness, TPayload>
Overrides PayloadWrapperBase.constructor
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:18

Properties

boundwitness

boundwitness: TBoundWitness

`Optional`moduleErrors

moduleErrors?: Payload[]

payload

payload: TBoundWitness

payloads

payloads: TPayload[]

Accessors

addresses

get addresses(): Lowercase<string>[]
Returns Lowercase<string>[]
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:19

payloadHashes

get payloadHashes(): Lowercase<string>[]
Returns Lowercase<string>[]
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:20

payloadSchemas

get payloadSchemas(): string[]
Returns string[]
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:21

previousHashes

get previousHashes(): DeepRestrictToStringKeys<null | Lowercase<string>>[]
Returns DeepRestrictToStringKeys<null | Lowercase<string>>[]
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:22

Methods

dataHash

dataHash(): Promise<Lowercase<string>>
Returns Promise<Lowercase<string>>
Inherited from PayloadWrapperBase.dataHash
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:18

dig

dig(depth?: number): Promise<BoundWitnessWrapper<TBoundWitness, Payload>>
Parameters
- Optionaldepth: number
Returns Promise<BoundWitnessWrapper<TBoundWitness, Payload>>
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:29

getErrors

getErrors(): Promise<Error[]>
Returns Promise<Error[]>
Inherited from PayloadWrapperBase.getErrors
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:19

getMissingPayloads

getMissingPayloads(): Promise<Lowercase<string>[]>
Returns Promise<Lowercase<string>[]>
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:30

getValid

getValid(): Promise<boolean>
Returns Promise<boolean>
Inherited from PayloadWrapperBase.getValid
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:20

getWrappedPayloads

getWrappedPayloads(): Promise<PayloadWrapper<TPayload>[]>
Returns Promise<PayloadWrapper<TPayload>[]>
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:31

hashesBySchema

hashesBySchema(schema: string): string[]
Parameters
- schema: string
Returns string[]
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:32

payloadsByDataHashes

payloadsByDataHashes(hashes: Lowercase<string>[]): Promise<TPayload[]>
Parameters
- hashes: Lowercase<string>[]
Returns Promise<TPayload[]>
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:33

payloadsByHashes

payloadsByHashes(hashes: Lowercase<string>[]): Promise<TPayload[]>
Parameters
- hashes: Lowercase<string>[]
Returns Promise<TPayload[]>
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:34

payloadsBySchema

payloadsBySchema<T extends Payload>(schema: string): T[]
Type Parameters
- T extends Payload
Parameters
- schema: string
Returns T[]
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:35

payloadsDataHashMap

payloadsDataHashMap(): Promise<Record<Lowercase<string>, TPayload>>
Returns Promise<Record<Lowercase<string>, TPayload>>
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:36

payloadsHashMap

payloadsHashMap(): Promise<Record<Lowercase<string>, TPayload>>
Returns Promise<Record<Lowercase<string>, TPayload>>
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:37

prev(
address: Lowercase<string>,
): DeepRestrictToStringKeys<null | Lowercase<string>>
Parameters
- address: Lowercase<string>
Returns DeepRestrictToStringKeys<null | Lowercase<string>>
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:38

schema

schema(): string
Returns string
Inherited from PayloadWrapperBase.schema
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:21

toResult

toResult(): (TBoundWitness | TPayload[])[]
Returns (TBoundWitness | TPayload[])[]
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:39

validate

validate(): Promise<Error[]>
Returns Promise<Error[]>
Overrides PayloadWrapperBase.validate
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:40

`Static`as

as<T extends BoundWitness = BoundWitness>(
value: unknown,
): undefined | BoundWitnessWrapper<T, Payload>
Type Parameters
- T extends BoundWitness = BoundWitness
Parameters
- value: unknown
Returns undefined | BoundWitnessWrapper<T, Payload>
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:23

`Static`load

load(
address: Lowercase<string>,
): Promise<null | BoundWitnessWrapper<BoundWitness, Payload>>
Parameters
- address: Lowercase<string>
Returns Promise<null | BoundWitnessWrapper<BoundWitness, Payload>>
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:24

`Static`parse

parse<T extends BoundWitness = BoundWitness, P extends Payload = Payload>(
obj: unknown,
payloads?: P[],
): BoundWitnessWrapper<T, P>
Type Parameters
- T extends BoundWitness = BoundWitness
- P extends Payload = Payload
Parameters
- obj: unknown
- Optionalpayloads: P[]
Returns BoundWitnessWrapper<T, P>
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:25

`Static`tryParse

tryParse<T extends BoundWitness, P extends Payload>(
obj: unknown,
payloads?: P[],
): undefined | BoundWitnessWrapper<T, P>
Type Parameters
- T extends BoundWitness
- P extends Payload
Parameters
- obj: unknown
- Optionalpayloads: P[]
Returns undefined | BoundWitnessWrapper<T, P>
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:26

`Static`unwrap

unwrap<TPayload extends Payload = Payload>(
payload?: TPayload,
): undefined | TPayload
Type Parameters
- TPayload extends Payload = Payload
Parameters
- Optionalpayload: TPayload
Returns undefined | TPayload
Inherited from PayloadWrapperBase.unwrap
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:13
unwrap<
    TPayload extends Payload = Payload,
    TWrapper extends
        PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>,
>(
    payload: TPayload | TWrapper,
): TPayload
Type Parameters
- TPayload extends Payload = Payload
- TWrapper extends PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>
Parameters
- payload: TPayload | TWrapper
Returns TPayload
Inherited from PayloadWrapperBase.unwrap
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:14
unwrap<
    TPayload extends Payload = Payload,
    TWrapper extends
        PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>,
>(
    payload: (TPayload | TWrapper)[],
): TPayload[]
Type Parameters
- TPayload extends Payload = Payload
- TWrapper extends PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>
Parameters
- payload: (TPayload | TWrapper)[]
Returns TPayload[]
Inherited from PayloadWrapperBase.unwrap
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:15

`Static`unwrapSinglePayload

unwrapSinglePayload<TPayload extends Payload = Payload>(
payload?: TPayload,
): undefined | TPayload
Type Parameters
- TPayload extends Payload = Payload
Parameters
- Optionalpayload: TPayload
Returns undefined | TPayload
Inherited from PayloadWrapperBase.unwrapSinglePayload
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:16
unwrapSinglePayload<
    TPayload extends Payload = Payload,
    TWrapper extends
        PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>,
>(
    payload: TPayload | TWrapper,
): TPayload
Type Parameters
- TPayload extends Payload = Payload
- TWrapper extends PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>
Parameters
- payload: TPayload | TWrapper
Returns TPayload
Inherited from PayloadWrapperBase.unwrapSinglePayload
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:17

`Static`wrap

wrap<T extends BoundWitness, P extends Payload>(
obj: PayloadWrapperBase<T> | WithoutPrivateStorageMeta<T>,
payloads?: P[],
): BoundWitnessWrapper<T, P>
Type Parameters
- T extends BoundWitness
- P extends Payload
Parameters
- obj: PayloadWrapperBase<T> | WithoutPrivateStorageMeta<T>
- Optionalpayloads: P[]
Returns BoundWitnessWrapper<T, P>
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:27

`Static`wrappedDataHashMap

wrappedDataHashMap<T extends BoundWitness>(
boundWitnesses: (T | BoundWitnessWrapper<T, Payload>)[],
): Promise<Record<string, BoundWitnessWrapper<T, Payload>>>
Type Parameters
- T extends BoundWitness
Parameters
- boundWitnesses: (T | BoundWitnessWrapper<T, Payload>)[]
Returns Promise<Record<string, BoundWitnessWrapper<T, Payload>>>
- Defined in packages/protocol/packages/boundwitness/packages/wrapper/dist/neutral/index.d.ts:28

Class BoundWitnessWrapper<TBoundWitness, TPayload>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns BoundWitnessWrapper<TBoundWitness, TPayload>

Properties

boundwitness

OptionalmoduleErrors

payload

payloads

Accessors

addresses

Returns Lowercase<string>[]

payloadHashes

Returns Lowercase<string>[]

payloadSchemas

Returns string[]

previousHashes

Returns DeepRestrictToStringKeys<null | Lowercase<string>>[]

Methods

dataHash

Returns Promise<Lowercase<string>>

dig

Parameters

Returns Promise<BoundWitnessWrapper<TBoundWitness, Payload>>

getErrors

Returns Promise<Error[]>

getMissingPayloads

Returns Promise<Lowercase<string>[]>

getValid

Returns Promise<boolean>

getWrappedPayloads

Returns Promise<PayloadWrapper<TPayload>[]>

hashesBySchema

Parameters

Returns string[]

payloadsByDataHashes

Parameters

Returns Promise<TPayload[]>

payloadsByHashes

Parameters

Returns Promise<TPayload[]>

payloadsBySchema

Type Parameters

Parameters

Returns T[]

payloadsDataHashMap

Returns Promise<Record<Lowercase<string>, TPayload>>

payloadsHashMap

Returns Promise<Record<Lowercase<string>, TPayload>>

prev

Parameters

Returns DeepRestrictToStringKeys<null | Lowercase<string>>

schema

Returns string

toResult

Returns (TBoundWitness | TPayload[])[]

validate

Returns Promise<Error[]>

Staticas

Type Parameters

Parameters

Returns undefined | BoundWitnessWrapper<T, Payload>

Staticload

Parameters

Returns Promise<null | BoundWitnessWrapper<BoundWitness, Payload>>

Staticparse

Type Parameters

Parameters

Returns BoundWitnessWrapper<T, P>

StatictryParse

Type Parameters

`Protected`constructor

`Optional`moduleErrors

`Static`as

`Static`load

`Static`parse

`Static`tryParse

`Static`unwrap

`Static`unwrapSinglePayload

`Static`wrap

`Static`wrappedDataHashMap