@xyo-network/boundwitness-model

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

  ### boundwitness

    ### packages

      ### model

        ### .temp-typedoc

          ### functions

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

@xyo-network/boundwitness-model

function BoundWitnessJsonSchema(): object;

Returns

object

$id

$id: string = 'https://schemas.xyo.network/2.0/boundwitness';

additionalProperties

additionalProperties: boolean = false;

properties

properties: object;

properties.addresses

addresses: object;

properties.addresses.items

items: object;

properties.addresses.items.type

type: string = 'string';

properties.addresses.type

type: string = 'array';

properties.payload_hashes

payload_hashes: object;

properties.payload_hashes.items

items: object;

properties.payload_hashes.items.type

type: string = 'string';

properties.payload_hashes.type

type: string = 'array';

properties.payload_schemas

payload_schemas: object;

properties.payload_schemas.items

items: object;

properties.payload_schemas.items.type

type: string = 'string';

properties.payload_schemas.type

type: string = 'array';

properties.previous_hashes

previous_hashes: object;

properties.previous_hashes.items

items: object;

properties.previous_hashes.items.nullable

nullable: boolean = true;

properties.previous_hashes.items.type

type: string = 'string';

properties.previous_hashes.type

type: string = 'array';

properties.schema

schema: object;

properties.schema.type

type: string = 'string';

required

required: string[];

type

type: string = 'object';

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

@xyo-network/boundwitness-model

function HydratedBoundWitnessZodBuilder<T>(bwZod): ZodTuple<[T, ZodArray<ZodObject<{
  schema: ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>;
}, $loose>>], null>;

Type Parameters

T

T extends ZodType<{ addresses: BrandedAddress[]; payload_hashes: BrandedHash[]; payload_schemas: BrandedSchema<string>[]; previous_hashes: (BrandedHash | null)[]; $destination?: BrandedAddress; $sourceQuery?: BrandedHash; schema: "network.xyo.boundwitness" & object; $signatures: (BrandedHex | null)[]; }, unknown, $ZodTypeInternals<{ addresses: BrandedAddress[]; payload_hashes: BrandedHash[]; payload_schemas: BrandedSchema<string>[]; previous_hashes: (BrandedHash | null)[]; $destination?: BrandedAddress; $sourceQuery?: BrandedHash; schema: "network.xyo.boundwitness" & object; $signatures: (BrandedHex | null)[]; }, unknown>>

Parameters

bwZod

T

Returns

ZodTuple<[T, ZodArray<ZodObject<{ schema: ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>; }, $loose>>], null>

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

@xyo-network/boundwitness-model

function isQueryBoundWitness(x?): x is UnsignedQueryBoundWitness;

Parameters

x?

unknown

Returns

x is UnsignedQueryBoundWitness

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

@xyo-network/boundwitness-model

function isQueryBoundWitnessWithStorageMeta(x?): x is WithStorageMeta<UnsignedQueryBoundWitness>;

Parameters

x?

unknown

Returns

x is WithStorageMeta<UnsignedQueryBoundWitness>

          ### type-aliases

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

@xyo-network/boundwitness-model

type AnyBoundWitness = z.infer<typeof AnyBoundWitnessZod>;

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

@xyo-network/boundwitness-model

type AnySignedBoundWitness = z.infer<typeof AnySignedBoundWitnessZod>;

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

@xyo-network/boundwitness-model

type AnyUnsignedBoundWitness = z.infer<typeof AnyUnsignedBoundWitnessZod>;

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

@xyo-network/boundwitness-model

type BoundWitness = z.infer<typeof BoundWitnessZod>;

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

@xyo-network/boundwitness-model

type BoundWitnessMeta = z.infer<typeof BoundWitnessMetaZod>;

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

@xyo-network/boundwitness-model

type BoundWitnessRequiredFields = z.infer<typeof BoundWitnessRequiredFieldsZod>;

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

@xyo-network/boundwitness-model

type BoundWitnessSchema = typeof BoundWitnessSchema;

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

@xyo-network/boundwitness-model

type PossiblySigned<T> = Unsigned<T> | Signed<T>;

Type Parameters

T

T extends BoundWitness

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

@xyo-network/boundwitness-model

type QueryBoundWitness = UnsignedQueryBoundWitness;

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

@xyo-network/boundwitness-model

type QueryBoundWitnessFields = object;

Properties

error_hashes?

optional error_hashes?: Hash[];

query

query: Hash;

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

@xyo-network/boundwitness-model

type SignaturesMeta = z.infer<typeof SignaturesMetaZod>;

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

@xyo-network/boundwitness-model

type Signed<T> = Omit<T, "$signatures"> & SignedSignaturesMeta;

Type Parameters

T

T extends BoundWitness

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

@xyo-network/boundwitness-model

type SignedBoundWitness = z.infer<typeof SignedBoundWitnessZod>;

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

@xyo-network/boundwitness-model

type SignedSignaturesMeta = z.infer<typeof SignedSignaturesMetaZod>;

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

@xyo-network/boundwitness-model

type Unsigned<T> = Omit<T, "$signatures"> & UnsignedSignaturesMeta;

Type Parameters

T

T extends BoundWitness

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

@xyo-network/boundwitness-model

type UnsignedBoundWitness = z.infer<typeof UnsignedBoundWitnessZod>;

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

@xyo-network/boundwitness-model

type UnsignedQueryBoundWitness = BoundWitness & QueryBoundWitnessFields;

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

@xyo-network/boundwitness-model

type UnsignedSignaturesMeta = z.infer<typeof UnsignedSignaturesMetaZod>;

          ### variables

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

@xyo-network/boundwitness-model

const AnyBoundWitnessZod: ZodObject<{
  addresses: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
  payload_hashes: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
  payload_schemas: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>>;
  previous_hashes: ZodArray<ZodNullable<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>>;
  $destination: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
  $sourceQuery: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
  schema: ZodLiteral<"network.xyo.boundwitness" & object>;
  $signatures: ZodArray<ZodUnion<readonly [ZodPipe<ZodString, ZodTransform<BrandedHex, string>>, ZodNull]>>;
}, $loose>;

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

@xyo-network/boundwitness-model

const AnySignedBoundWitnessZod: ZodObject<{
  addresses: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
  payload_hashes: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
  payload_schemas: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>>;
  previous_hashes: ZodArray<ZodNullable<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>>;
  $destination: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
  $sourceQuery: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
  schema: ZodLiteral<"network.xyo.boundwitness" & object>;
  $signatures: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHex, string>>>;
}, $loose>;

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

@xyo-network/boundwitness-model

const AnyUnsignedBoundWitnessZod: ZodObject<{
  addresses: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
  payload_hashes: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
  payload_schemas: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>>;
  previous_hashes: ZodArray<ZodNullable<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>>;
  $destination: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
  $sourceQuery: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
  schema: ZodLiteral<"network.xyo.boundwitness" & object>;
  $signatures: ZodArray<ZodNull>;
}, $loose>;

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

@xyo-network/boundwitness-model

const BoundWitnessMetaZod: ZodObject<{
  $destination: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
  $sourceQuery: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
  $signatures: ZodArray<ZodUnion<readonly [ZodPipe<ZodString, ZodTransform<BrandedHex, string>>, ZodNull]>>;
}, $strip>;

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

@xyo-network/boundwitness-model

const BoundWitnessRequiredFieldsZod: ZodObject<{
  addresses: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
  payload_hashes: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
  payload_schemas: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>>;
  previous_hashes: ZodArray<ZodNullable<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>>;
}, $strip>;

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

@xyo-network/boundwitness-model

const BoundWitnessSchema: "network.xyo.boundwitness" & object;

Type Declaration

__schema

readonly __schema: true;

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

@xyo-network/boundwitness-model

const BoundWitnessZod: ZodObject<{
  addresses: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
  payload_hashes: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
  payload_schemas: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>>;
  previous_hashes: ZodArray<ZodNullable<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>>;
  $destination: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
  $sourceQuery: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
  schema: ZodLiteral<"network.xyo.boundwitness" & object>;
  $signatures: ZodArray<ZodUnion<readonly [ZodPipe<ZodString, ZodTransform<BrandedHex, string>>, ZodNull]>>;
}, $strip>;

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

@xyo-network/boundwitness-model

const HydratedBoundWitnessZod: ZodTuple<[ZodObject<{
  addresses: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
  payload_hashes: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
  payload_schemas: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>>;
  previous_hashes: ZodArray<ZodNullable<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>>;
  $destination: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
  $sourceQuery: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
  schema: ZodLiteral<"network.xyo.boundwitness" & object>;
  $signatures: ZodArray<ZodUnion<readonly [ZodPipe<ZodString, ZodTransform<BrandedHex, string>>, ZodNull]>>;
}, $strip>, ZodArray<ZodObject<{
  schema: ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>;
}, $loose>>], null>;

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

@xyo-network/boundwitness-model

const SignaturesMetaZod: ZodObject<{
  $signatures: ZodArray<ZodUnion<readonly [ZodPipe<ZodString, ZodTransform<BrandedHex, string>>, ZodNull]>>;
}, $strip>;

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

@xyo-network/boundwitness-model

const SignedBoundWitnessZod: ZodObject<{
  addresses: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
  payload_hashes: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
  payload_schemas: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>>;
  previous_hashes: ZodArray<ZodNullable<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>>;
  $destination: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
  $sourceQuery: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
  schema: ZodLiteral<"network.xyo.boundwitness" & object>;
  $signatures: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHex, string>>>;
}, $strip>;

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

@xyo-network/boundwitness-model

const SignedHydratedBoundWitnessZod: ZodTuple<[ZodObject<{
  addresses: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
  payload_hashes: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
  payload_schemas: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>>;
  previous_hashes: ZodArray<ZodNullable<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>>;
  $destination: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
  $sourceQuery: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
  schema: ZodLiteral<"network.xyo.boundwitness" & object>;
  $signatures: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHex, string>>>;
}, $strip>, ZodArray<ZodObject<{
  schema: ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>;
}, $loose>>], null>;

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

@xyo-network/boundwitness-model

const SignedSignaturesMetaZod: ZodObject<{
  $signatures: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHex, string>>>;
}, $strip>;

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

@xyo-network/boundwitness-model

const UnsignedBoundWitnessZod: ZodObject<{
  addresses: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
  payload_hashes: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
  payload_schemas: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>>;
  previous_hashes: ZodArray<ZodNullable<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>>;
  $destination: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
  $sourceQuery: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
  schema: ZodLiteral<"network.xyo.boundwitness" & object>;
  $signatures: ZodArray<ZodNull>;
}, $strip>;

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

@xyo-network/boundwitness-model

const UnsignedHydratedBoundWitnessZod: ZodTuple<[ZodObject<{
  addresses: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
  payload_hashes: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
  payload_schemas: ZodArray<ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>>;
  previous_hashes: ZodArray<ZodNullable<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>>;
  $destination: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedAddress, string>>>;
  $sourceQuery: ZodOptional<ZodPipe<ZodString, ZodTransform<BrandedHash, string>>>;
  schema: ZodLiteral<"network.xyo.boundwitness" & object>;
  $signatures: ZodArray<ZodNull>;
}, $strip>, ZodArray<ZodObject<{
  schema: ZodPipe<ZodString, ZodTransform<BrandedSchema<string>, string>>;
}, $loose>>], null>;

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

@xyo-network/boundwitness-model

const UnsignedSignaturesMetaZod: ZodObject<{
  $signatures: ZodArray<ZodNull>;
}, $strip>;

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

@xyo-network/boundwitness-model

const asBoundWitness: {
<T>  (value): T & object | undefined;
<T>  (value, assert): T & object;
};

Call Signature

<T>(value): T & object | undefined;

Type Parameters

T

T

Parameters

value

T

Returns

T & object | undefined

Call Signature

<T>(value, assert): T & object;

Type Parameters

T

T

Parameters

value

T

assert

ZodFactoryConfig

Returns

T & object

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

@xyo-network/boundwitness-model

const isBoundWitness: <T>(value) => value is T & { addresses: BrandedAddress[]; payload_hashes: BrandedHash[]; payload_schemas: BrandedSchema<string>[]; previous_hashes: (BrandedHash | null)[]; $destination?: BrandedAddress; $sourceQuery?: BrandedHash; schema: "network.xyo.boundwitness" & { __schema: true }; $signatures: (BrandedHex | null)[] };

Type Parameters

T

T

Parameters

value

T

Returns

value is T & { addresses: BrandedAddress[]; payload_hashes: BrandedHash[]; payload_schemas: BrandedSchema<string>[]; previous_hashes: (BrandedHash | null)[]; $destination?: BrandedAddress; $sourceQuery?: BrandedHash; schema: "network.xyo.boundwitness" & { __schema: true }; $signatures: (BrandedHex | null)[] }

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

@xyo-network/boundwitness-model

const toBoundWitness: {
<T>  (value): T & object | undefined;
<T>  (value, assert): T & object;
};

Call Signature

<T>(value): T & object | undefined;

Type Parameters

T

T

Parameters

value

T

Returns

T & object | undefined

Call Signature

<T>(value, assert): T & object;

Type Parameters

T

T

Parameters

value

T

assert

ZodFactoryConfig

Returns

T & object