@xyo-network/xl1-protocol 4.0.10 → 4.0.12

package/dist/neutral/modules/protocol-model/TransferPayload.d.ts

@@ -0,0 +1,79 @@
+import { z } from 'zod/mini';
+/** Schema identifier for XYO transfer payloads */
+export declare const TransferSchema: "network.xyo.transfer" & {
+    readonly __schema: true;
+};
+/** The literal type of the transfer schema string */
+export type TransferSchema = typeof TransferSchema;
+/** Zod schema for the fields specific to a transfer payload */
+export declare const TransferFieldsZod: z.ZodMiniObject<{
+    context: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+    epoch: z.ZodMiniNumber<number>;
+    from: z.ZodMiniUnion<readonly [z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<Lowercase<string> & {
+        readonly __hex: true;
+    } & {
+        readonly __address: true;
+    }, string>>, z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<import("@xyo-network/sdk").XyoQuantAddress, string>>]>;
+    transfers: z.ZodMiniRecord<z.ZodMiniUnion<readonly [z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<Lowercase<string> & {
+        readonly __hex: true;
+    } & {
+        readonly __address: true;
+    }, string>>, z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<import("@xyo-network/sdk").XyoQuantAddress, string>>]>, z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<import("@ariestools/sdk").BrandedHex, string>>>;
+}, z.core.$strip>;
+/** Zod schema for a complete transfer payload including schema and fields */
+export declare const TransferZod: z.ZodMiniObject<{
+    schema: z.ZodMiniLiteral<"network.xyo.transfer" & {
+        readonly __schema: true;
+    }>;
+    context: z.ZodMiniOptional<z.ZodMiniRecord<z.ZodMiniString<string>, z.ZodMiniType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+    epoch: z.ZodMiniNumber<number>;
+    from: z.ZodMiniUnion<readonly [z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<Lowercase<string> & {
+        readonly __hex: true;
+    } & {
+        readonly __address: true;
+    }, string>>, z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<import("@xyo-network/sdk").XyoQuantAddress, string>>]>;
+    transfers: z.ZodMiniRecord<z.ZodMiniUnion<readonly [z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<Lowercase<string> & {
+        readonly __hex: true;
+    } & {
+        readonly __address: true;
+    }, string>>, z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<import("@xyo-network/sdk").XyoQuantAddress, string>>]>, z.ZodMiniPipe<z.ZodMiniString<string>, z.ZodMiniTransform<import("@ariestools/sdk").BrandedHex, string>>>;
+}, z.core.$strip>;
+/** A transfer payload representing the movement of XL1 tokens between addresses */
+export type Transfer = z.infer<typeof TransferZod>;
+/** Type guard that checks if a value is a Transfer payload */
+export declare const isTransfer: (x?: unknown) => x is {
+    schema: "network.xyo.transfer" & {
+        readonly __schema: true;
+    };
+    epoch: number;
+    from: (Lowercase<string> & {
+        readonly __hex: true;
+    } & {
+        readonly __address: true;
+    }) | import("@xyo-network/sdk").XyoQuantAddress;
+    transfers: Record<(Lowercase<string> & {
+        readonly __hex: true;
+    } & {
+        readonly __address: true;
+    }) | import("@xyo-network/sdk").XyoQuantAddress, import("@ariestools/sdk").BrandedHex>;
+    context?: Record<string, unknown> | undefined;
+};
+/** Casts a value to Transfer or returns undefined if invalid */
+export declare const asTransfer: import("@ariestools/sdk").AsTypeFunction<{
+    schema: "network.xyo.transfer" & {
+        readonly __schema: true;
+    };
+    epoch: number;
+    from: (Lowercase<string> & {
+        readonly __hex: true;
+    } & {
+        readonly __address: true;
+    }) | import("@xyo-network/sdk").XyoQuantAddress;
+    transfers: Record<(Lowercase<string> & {
+        readonly __hex: true;
+    } & {
+        readonly __address: true;
+    }) | import("@xyo-network/sdk").XyoQuantAddress, import("@ariestools/sdk").BrandedHex>;
+    context?: Record<string, unknown> | undefined;
+}>;
+//# sourceMappingURL=TransferPayload.d.ts.map

package/dist/neutral/modules/protocol-model/TransferPayload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransferPayload.d.ts","sourceRoot":"","sources":["../../../../src/modules/protocol-model/TransferPayload.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,CAAC,EAAE,MAAM,UAAU,CAAA;AAE5B,kDAAkD;AAClD,eAAO,MAAM,cAAc;;CAAyC,CAAA;AACpE,qDAAqD;AACrD,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAA;AAElD,+DAA+D;AAC/D,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;iBAO5B,CAAA;AAEF,6EAA6E;AAC7E,eAAO,MAAM,WAAW;;;;;;;;;;;;;;;;iBAAwE,CAAA;AAEhG,mFAAmF;AACnF,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAA;AAElD,8DAA8D;AAC9D,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;CAAkD,CAAA;AAEzE,gEAAgE;AAChE,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;EAAqC,CAAA"}

package/dist/neutral/modules/protocol-model/amount/ShiftedBigIntConfig.d.ts

@@ -0,0 +1,9 @@
+/** Configuration for formatting a ShiftedBigInt as a decimal string */
+export interface ShiftedBigIntConfig {
+    locale: Intl.LocalesArgument;
+    maxCharacters: number;
+    maxDecimal: number;
+    minDecimals: number;
+    places: number;
+}
+//# sourceMappingURL=ShiftedBigIntConfig.d.ts.map

package/dist/neutral/modules/protocol-model/amount/ShiftedBigIntConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ShiftedBigIntConfig.d.ts","sourceRoot":"","sources":["../../../../../src/modules/protocol-model/amount/ShiftedBigIntConfig.ts"],"names":[],"mappings":"AAAA,uEAAuE;AACvE,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,IAAI,CAAC,eAAe,CAAA;IAC5B,aAAa,EAAE,MAAM,CAAA;IACrB,UAAU,EAAE,MAAM,CAAA;IAClB,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;CACf"}

package/dist/neutral/modules/protocol-model/amount/index.d.ts

@@ -0,0 +1,3 @@
+export * from './ShiftedBigIntConfig.js';
+export * from './xl1AmountInstance.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/neutral/modules/protocol-model/amount/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/modules/protocol-model/amount/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAA;AACxC,cAAc,wBAAwB,CAAA"}

package/dist/neutral/modules/protocol-model/amount/xl1AmountInstance.d.ts

@@ -0,0 +1,16 @@
+import type { AttoXL1, FemtoXL1, MicroXL1, MilliXL1, NanoXL1, PicoXL1, XL1 } from '../xl1/index.js';
+import type { ShiftedBigIntConfig } from './ShiftedBigIntConfig.js';
+/** Interface for an XL1 token amount with conversion accessors for various denominations */
+export interface XL1AmountInstance {
+    atto: AttoXL1;
+    femto: FemtoXL1;
+    micro: MicroXL1;
+    milli: MilliXL1;
+    nano: NanoXL1;
+    pico: PicoXL1;
+    value: AttoXL1;
+    xl1: XL1;
+    to(places: bigint | number): bigint;
+    toString(places: number, config: Partial<ShiftedBigIntConfig>): string;
+}
+//# sourceMappingURL=xl1AmountInstance.d.ts.map

package/dist/neutral/modules/protocol-model/amount/xl1AmountInstance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"xl1AmountInstance.d.ts","sourceRoot":"","sources":["../../../../../src/modules/protocol-model/amount/xl1AmountInstance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAC7D,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAEnE,4FAA4F;AAC5F,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,OAAO,CAAA;IACb,KAAK,EAAE,QAAQ,CAAA;IACf,KAAK,EAAE,QAAQ,CAAA;IACf,KAAK,EAAE,QAAQ,CAAA;IACf,IAAI,EAAE,OAAO,CAAA;IACb,IAAI,EAAE,OAAO,CAAA;IACb,KAAK,EAAE,OAAO,CAAA;IACd,GAAG,EAAE,GAAG,CAAA;IAER,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;IACnC,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,MAAM,CAAA;CACvE"}

package/dist/neutral/modules/protocol-model/block/AllowedBlockPayload.d.ts

@@ -0,0 +1,40 @@
+import type { SchemaPayload, WithStorageMeta } from '@xyo-network/sdk';
+import { z } from 'zod';
+import type { BridgeDestinationObservation, BridgeIntent, BridgeSourceObservation, ChainStakeIntent, HashPayload, StepComplete, TimePayload } from '../payload/index.js';
+import { type TransactionBoundWitness } from '../transaction/index.js';
+import { type Transfer } from '../TransferPayload.js';
+/** AllowedBlockPayload type. */
+export type AllowedBlockPayload = BridgeDestinationObservation | BridgeIntent | BridgeSourceObservation | ChainStakeIntent | HashPayload | SchemaPayload | StepComplete | TimePayload | TransactionBoundWitness | Transfer;
+/** AllowedBlockPayloadSchemas constant. */
+export declare const AllowedBlockPayloadSchemas: (("network.xyo.chain.bridge.observation.destination" & {
+    readonly __schema: true;
+}) | ("network.xyo.chain.bridge.intent" & {
+    readonly __schema: true;
+}) | ("network.xyo.chain.bridge.observation.source" & {
+    readonly __schema: true;
+}) | ("network.xyo.chain.stake.intent" & {
+    readonly __schema: true;
+}) | ("network.xyo.hash" & {
+    readonly __schema: true;
+}) | ("network.xyo.chain.step.complete" & {
+    readonly __schema: true;
+}) | ("network.xyo.time" & {
+    readonly __schema: true;
+}) | ("network.xyo.transfer" & {
+    readonly __schema: true;
+}) | ("network.xyo.boundwitness" & {
+    readonly __schema: true;
+}) | ("network.xyo.schema" & {
+    readonly __schema: true;
+}))[];
+/** AllowedBlockPayloadSchemaZod constant. */
+export declare const AllowedBlockPayloadSchemaZod: z.ZodEnum<{}>;
+/** Schema type for AllowedBlockPayload payloads. */
+export type AllowedBlockPayloadSchema = z.infer<typeof AllowedBlockPayloadSchemaZod>;
+/** Schema identifier for isAllowedBlockPayload payloads. */
+export declare const isAllowedBlockPayloadSchema: <T>(value: T) => value is T;
+/** Type guard that checks if a value is a valid AllowedBlockPayload. */
+export declare const isAllowedBlockPayload: <T>(value: T) => value is AllowedBlockPayload & T;
+/** Type guard that checks if a value is a valid AllowedBlockPayloadWithHashMeta. */
+export declare const isAllowedBlockPayloadWithHashMeta: <T>(value: T) => value is WithStorageMeta<AllowedBlockPayload & T>;
+//# sourceMappingURL=AllowedBlockPayload.d.ts.map

package/dist/neutral/modules/protocol-model/block/AllowedBlockPayload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AllowedBlockPayload.d.ts","sourceRoot":"","sources":["../../../../../src/modules/protocol-model/block/AllowedBlockPayload.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACF,aAAa,EAAE,eAAe,EACvC,MAAM,kBAAkB,CAAA;AAIzB,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,KAAK,EACV,4BAA4B,EAAE,YAAY,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,WAAW,EAAE,YAAY,EAAE,WAAW,EAC9H,MAAM,qBAAqB,CAAA;AAM5B,OAAO,EAA6B,KAAK,uBAAuB,EAAE,MAAM,yBAAyB,CAAA;AACjG,OAAO,EACO,KAAK,QAAQ,EAC1B,MAAM,uBAAuB,CAAA;AAE9B,gCAAgC;AAChC,MAAM,MAAM,mBAAmB,GACzB,4BAA4B,GAC5B,YAAY,GACZ,uBAAuB,GACvB,gBAAgB,GAChB,WAAW,GACX,aAAa,GACb,YAAY,GACZ,WAAW,GACX,uBAAuB,GACvB,QAAQ,CAAA;AAEd,2CAA2C;AAC3C,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;KAWnB,CAAA;AAEpB,6CAA6C;AAC7C,eAAO,MAAM,4BAA4B,eAAqC,CAAA;AAC9E,oDAAoD;AACpD,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAA;AACpF,4DAA4D;AAC5D,eAAO,MAAM,2BAA2B,6BAA6C,CAAA;AAErF,wEAAwE;AACxE,eAAO,MAAM,qBAAqB,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,KAAK,IAAI,mBAAmB,GAAG,CAUlF,CAAA;AAED,oFAAoF;AACpF,eAAO,MAAM,iCAAiC,GAAI,CAAC,EAAE,OAAO,CAAC,KAAG,KAAK,IAAI,eAAe,CAAC,mBAAmB,GAAG,CAAC,CAE/G,CAAA"}