@xyo-network/xl1-protocol-sdk 1.6.6 → 1.7.0

package/dist/neutral/block/primitives/frames/spec/calculateFramesFromRange.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=calculateFramesFromRange.spec.d.ts.map

package/dist/neutral/block/primitives/frames/spec/calculateFramesFromRange.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"calculateFramesFromRange.spec.d.ts","sourceRoot":"","sources":["../../../../../../src/block/primitives/frames/spec/calculateFramesFromRange.spec.ts"],"names":[],"mappings":""}

package/dist/neutral/block/primitives/frames/spec/deepCalculateFramesFromRange.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=deepCalculateFramesFromRange.spec.d.ts.map

package/dist/neutral/block/primitives/frames/spec/deepCalculateFramesFromRange.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deepCalculateFramesFromRange.spec.d.ts","sourceRoot":"","sources":["../../../../../../src/block/primitives/frames/spec/deepCalculateFramesFromRange.spec.ts"],"names":[],"mappings":""}

package/dist/neutral/index.d.ts

@@ -0,0 +1,339 @@
+import { Hash, Hex, Address } from '@xylabs/hex';
+import { ReadArchivist, ArchivistInstance, WriteArchivist, HydratedBoundWitness } from '@xyo-network/archivist-model';
+import { WithStorageMeta, Payload, Schema, WithHashStorageMeta } from '@xyo-network/payload-model';
+import { HydratedBlock, TransactionBoundWitness, PayloadRepository, AccountBalanceService, ChainContractViewer, EventingChainBlockNumberIterator, ChainStakeViewer, ChainStaker, ElectionService, BlockProducerService, BlockRewardService, StakeIntentService, AccountBalanceServiceV2, PendingTransactionsService, AttoXL1, MilliXL1, MicroXL1, NanoXL1, PicoXL1, FemtoXL1, AllowedBlockPayload, HydratedTransaction, TransactionFeesBigInt } from '@xyo-network/xl1-protocol';
+import * as _xylabs_object_model from '@xylabs/object-model';
+import { EmptyObject } from '@xylabs/object';
+import { WalletInstance } from '@xyo-network/wallet-model';
+import { Promisable } from '@xylabs/promise';
+import { BoundWitness } from '@xyo-network/boundwitness-model';
+import { AccountInstance } from '@xyo-network/account-model';
+
+declare function allHashesPresent(hashes: Hash[], payloads: WithStorageMeta<Payload>[]): boolean;
+declare const tryHydrateBlock: (archivist: ReadArchivist, hash: Hash, maxDepth?: number) => Promise<HydratedBlock | undefined>;
+declare const hydrateBlock: (archivist: ReadArchivist, hash: Hash, maxDepth?: number, minDepth?: number) => Promise<HydratedBlock>;
+declare const flattenHydratedBlock: (hydratedBlock: HydratedBlock) => WithStorageMeta<Payload>[];
+declare const flattenHydratedBlocks: (hydratedBlocks: HydratedBlock[]) => WithStorageMeta<Payload>[];
+declare const transactionsFromHydratedBlock: (block: HydratedBlock) => WithStorageMeta<TransactionBoundWitness>[];
+declare const blockPayloadsFromHydratedBlock: (block: HydratedBlock) => WithStorageMeta<Payload>[];
+
+type BlockNumberRange = [number, number];
+
+interface NegativeBigInt {
+    negative: Hex;
+}
+interface PositiveBigInt {
+    positive: Hex;
+}
+type SignedBigInt = NegativeBigInt | PositiveBigInt;
+declare const isNegativeBigInt: (value: unknown) => value is NegativeBigInt;
+declare const isPositiveBigInt: (value: unknown) => value is PositiveBigInt;
+declare const parseSignedBigInt: (value: SignedBigInt) => bigint;
+declare const toSignedBigInt: (value: bigint) => SignedBigInt;
+declare const toPositiveBigInt: (value: unknown) => PositiveBigInt;
+
+declare const StepSummarySchema: Schema;
+type StepSummarySchema = typeof StepSummarySchema;
+interface StepSummaryFields {
+    hash: Hash;
+    stepSize: number;
+}
+interface ChainWindow {
+    depth: number;
+    head: Hash;
+}
+type StepSummary<TAdditionalFields extends EmptyObject | void = void, TSchema extends Schema | void = void> = Payload<TAdditionalFields extends void ? StepSummaryFields : TAdditionalFields & StepSummaryFields, TSchema extends void ? StepSummarySchema : TSchema>;
+declare const BalancesStepSummarySchema: Schema;
+type BalancesStepSummarySchema = typeof BalancesStepSummarySchema;
+type BalancesStepSummary = StepSummary<{
+    balances: Record<Address, SignedBigInt>;
+}, BalancesStepSummarySchema>;
+/**
+ * Identity function for determining if an object is an BalancesStepSummary
+ */
+declare const isBalancesStepSummary: (x?: unknown | null) => x is BalancesStepSummary;
+declare const asBalancesStepSummary: _xylabs_object_model.AsTypeFunction<BalancesStepSummary>;
+/**
+ * Identity function for determining if an object is an BalancesStepSummary with Storage Meta
+ */
+declare const isBalancesStepSummaryWithStorageMeta: (value: unknown) => value is WithStorageMeta<BalancesStepSummary>;
+declare const asBalancesStepSummaryWithStorageMeta: _xylabs_object_model.AsTypeFunction<WithStorageMeta<BalancesStepSummary>>;
+
+interface ChainContext {
+    chainArchivist: ReadArchivist;
+    head: Hash;
+    windowSize?: number;
+}
+interface ChainSummaryContext<T extends Payload> extends ChainContext {
+    summaryRepository: PayloadRepository<Hash, T>;
+}
+interface BalanceStepSummaryContext extends ChainSummaryContext<BalancesStepSummary> {
+}
+
+declare function balanceStepSummaryFromRange(context: BalanceStepSummaryContext, range: BlockNumberRange): Promise<WithStorageMeta<BalancesStepSummary>>;
+
+declare function balanceSummary(context: BalanceStepSummaryContext): Promise<Partial<Record<Address, bigint>>>;
+
+declare function calculateFramesFromRange(range: BlockNumberRange, step: number): [
+    BlockNumberRange[],
+    BlockNumberRange[]
+];
+
+declare function deepCalculateFramesFromRange(range: BlockNumberRange, startingStep?: number): BlockNumberRange[];
+
+declare function hashFromBlockNumber(context: ChainContext, blockNumber: number): Promise<Hash>;
+
+interface ChainServiceCollection {
+    /**
+     * The account which is used to sign transactions
+     */
+    account: WalletInstance;
+    /**
+     * Services for working with account balances
+     */
+    balanceService: AccountBalanceService;
+    /**
+     * The archivist which the chain data is stored in
+     */
+    chainArchivist: ArchivistInstance;
+    /**
+     * Service for viewing codified chain information
+     * from a contract
+     */
+    chainContractViewer: ChainContractViewer;
+    /**
+     * The chain iterator
+     */
+    chainIterator?: EventingChainBlockNumberIterator;
+    /**
+     * Service for viewing stake information
+     */
+    chainStakeViewer: ChainStakeViewer;
+    /**
+     * Service for staking
+     */
+    chainStaker: ChainStaker;
+    /**
+     * The archivist which the chain submissions are stored in
+     */
+    chainSubmissionsArchivistWrite: WriteArchivist;
+    /**
+     * Service for determining leader election
+     */
+    electionService: ElectionService;
+    /**
+     * The archivist which the pending transactions are stored
+     * as bundled transactions
+     */
+    pendingBundledTransactionsArchivistWrite: ArchivistInstance;
+    /**
+     * The block producer service
+     */
+    producer: BlockProducerService;
+    /**
+     * Service response for calculating block rewards
+     */
+    rewardService: BlockRewardService;
+    /**
+     * Services for working with staked intents
+     */
+    stakeIntentService: StakeIntentService;
+}
+
+interface ChainServiceCollectionV2 {
+    /**
+     * The account which is used to sign transactions
+     */
+    account: WalletInstance;
+    /**
+     * Services for working with account balances
+     */
+    balanceService: AccountBalanceServiceV2;
+    /**
+     * The archivist which the chain data is stored in
+     */
+    chainArchivist: ArchivistInstance;
+    /**
+     * Service for viewing codified chain information
+     * from a contract
+     */
+    chainContractViewer: ChainContractViewer;
+    /**
+     * The chain iterator
+     */
+    chainIterator?: EventingChainBlockNumberIterator;
+    /**
+     * Service for viewing stake information
+     */
+    chainStakeViewer: ChainStakeViewer;
+    /**
+     * Service for staking
+     */
+    chainStaker: ChainStaker;
+    /**
+     * The archivist which the chain submissions are stored in
+     */
+    chainSubmissionsArchivistWrite: WriteArchivist;
+    /**
+     * Service for determining leader election
+     */
+    electionService: ElectionService;
+    /**
+     * The archivist which the pending transactions are stored
+     * as bundled transactions
+     */
+    pendingBundledTransactionsArchivistWrite: ArchivistInstance;
+    /**
+     * Service for managing pending transactions
+     */
+    pendingTransactionsService: PendingTransactionsService;
+    /**
+     * The block producer service
+     */
+    producer: BlockProducerService;
+    /**
+     * Service response for calculating block rewards
+     */
+    rewardService: BlockRewardService;
+    /**
+     * Services for working with staked intents
+     */
+    stakeIntentService: StakeIntentService;
+}
+
+interface BlockWindowInstance {
+    count: number;
+    numberRange: [number, number];
+    range: [Hash, Hash];
+}
+
+interface BlockWindowStateInstance {
+    blockWindow: BlockWindowInstance;
+}
+
+interface ValidatableInstance {
+    validate(): Promisable<Error[]>;
+}
+
+interface ShiftedBigIntConfig {
+    locale: Intl.LocalesArgument;
+    maxCharacters: number;
+    maxDecimal: number;
+    minDecimals: number;
+    places: number;
+}
+
+interface XL1AmountInstance {
+    value: AttoXL1;
+    to(places: bigint | number): bigint;
+    milli: MilliXL1;
+    micro: MicroXL1;
+    nano: NanoXL1;
+    pico: PicoXL1;
+    femto: FemtoXL1;
+    atto: AttoXL1;
+    toString(places: number, config: Partial<ShiftedBigIntConfig>): string;
+}
+
+interface AddressInstance extends ValidatableInstance {
+    address: Address;
+}
+interface AddressStateInstance extends AddressInstance, BlockWindowStateInstance {
+    balance(): Promisable<[XL1AmountInstance, BlockWindowInstance]>;
+}
+
+interface DataInstance<T> {
+    data: T;
+}
+
+interface HydratedBoundWitnessInstance<T extends HydratedBoundWitness = HydratedBoundWitness> extends ValidatableInstance, DataInstance<T> {
+    boundWitness: T[0];
+    payloadCount: number;
+    payloads: T[1][number][];
+    payload(index: number): T[1][number] | undefined;
+}
+
+interface SignatureInstance extends ValidatableInstance {
+    address: Address;
+    hash: Hash;
+    signature: Hex;
+}
+
+interface SignedInstance {
+    signatureCount: number;
+    signatures: SignatureInstance[];
+    signature(index: number): SignatureInstance | undefined;
+}
+
+interface TransactionFeesInstance extends ValidatableInstance {
+    base: bigint;
+    gasLimit: bigint;
+    gasPrice: bigint;
+    priority: bigint;
+}
+
+interface TransactionFieldsInstance<TBlockPayload extends AllowedBlockPayload = AllowedBlockPayload> {
+    elevatedPayloadCount: number;
+    elevatedPayloads: WithStorageMeta<TBlockPayload>[];
+    externalPayloads: Record<Hash, Schema | Payload>;
+    fees: TransactionFeesInstance;
+    privateExternalPayloads: Record<Hash, Schema>;
+    publicExternalPayloads: Payload[];
+    elevatedPayload(index: number): TBlockPayload | undefined;
+    reward(): bigint;
+}
+
+interface HydratedTransactionInstance<T extends HydratedTransaction = HydratedTransaction, TElevatedPayload extends AllowedBlockPayload = AllowedBlockPayload> extends TransactionFieldsInstance<T[1][number] & TElevatedPayload>, HydratedBoundWitnessInstance<T>, SignedInstance {
+}
+
+interface BlockFieldsInstance<TTransactionResult> {
+    reward: bigint;
+    signatureCount: number;
+    signatures: SignatureInstance[];
+    transactionCount: number;
+    transactions: TTransactionResult[];
+    signature(index: number): SignatureInstance | undefined;
+    transaction(index: number): TTransactionResult | undefined;
+}
+
+interface HydratedBlockInstance<T extends HydratedBlock = HydratedBlock> extends BlockFieldsInstance<HydratedTransactionInstance>, HydratedBoundWitnessInstance<T>, SignedInstance {
+}
+
+interface ObjectInstance<T extends EmptyObject = EmptyObject> extends DataInstance<T> {
+}
+
+interface PayloadInstance<TPayload extends Payload = Payload> extends ObjectInstance<TPayload>, ValidatableInstance {
+}
+
+interface BoundWitnessInstance<TBoundWitness extends BoundWitness = BoundWitness, TPayload extends Payload = Payload> extends PayloadInstance<TBoundWitness> {
+    payloadCount: number;
+    payloads: PayloadInstance<TPayload>[];
+    payload(index: number): PayloadInstance<TPayload> | undefined;
+}
+
+declare const netBalancesForPayloads: (payloads: Payload[]) => Record<Lowercase<string>, bigint>;
+
+declare function buildTransaction(chain: Address, elevatedPayloads: AllowedBlockPayload[], additionalPayloads: Payload[], signer: AccountInstance | AccountInstance[], nbf: number, exp: number, from?: Address, fees?: TransactionFeesBigInt): Promise<HydratedTransaction>;
+
+declare const tryHydrateTransaction: (archivist: ReadArchivist, hash: Hash) => Promise<HydratedTransaction | undefined>;
+declare const hydrateTransaction: (archivist: ReadArchivist, hash: Hash) => Promise<HydratedTransaction>;
+declare const flattenHydratedTransaction: (hydratedTransaction: HydratedTransaction) => Payload[];
+declare const flattenHydratedTransactions: (hydratedTransactions: HydratedTransaction[]) => Payload[];
+declare const tryHydrateElevatedTransaction: (archivist: ReadArchivist, hash: Hash) => Promise<HydratedTransaction | undefined>;
+declare const hydrateElevatedTransaction: (archivist: ReadArchivist, hash: Hash) => Promise<HydratedTransaction>;
+
+/** The number of bytes that a transaction and its payloads will take up in a block */
+declare function transactionBlockByteCount([transaction, payloads]: HydratedTransaction): number;
+
+declare function transactionElevatedPayloadHashes(transaction: TransactionBoundWitness): Hash[];
+declare function transactionElevatedPayloads([transaction, payloads]: HydratedTransaction): WithHashStorageMeta<Payload>[];
+
+declare function crackOperation(operation: string): [string, string[]];
+declare function crackOperations(operations: string[]): [string, string[]][];
+
+/** The required gas for the byte storage on the block chain for a transaction */
+declare function transactionBytesRequiredGas([transaction, payloads]: HydratedTransaction): AttoXL1;
+declare function transactionRequiredGas(hydratedTransaction: HydratedTransaction): AttoXL1;
+
+export { BalancesStepSummarySchema, StepSummarySchema, allHashesPresent, asBalancesStepSummary, asBalancesStepSummaryWithStorageMeta, balanceStepSummaryFromRange, balanceSummary, blockPayloadsFromHydratedBlock, buildTransaction, calculateFramesFromRange, crackOperation, crackOperations, deepCalculateFramesFromRange, flattenHydratedBlock, flattenHydratedBlocks, flattenHydratedTransaction, flattenHydratedTransactions, hashFromBlockNumber, hydrateBlock, hydrateElevatedTransaction, hydrateTransaction, isBalancesStepSummary, isBalancesStepSummaryWithStorageMeta, isNegativeBigInt, isPositiveBigInt, netBalancesForPayloads, parseSignedBigInt, toPositiveBigInt, toSignedBigInt, transactionBlockByteCount, transactionBytesRequiredGas, transactionElevatedPayloadHashes, transactionElevatedPayloads, transactionRequiredGas, transactionsFromHydratedBlock, tryHydrateBlock, tryHydrateElevatedTransaction, tryHydrateTransaction };
+export type { AddressInstance, AddressStateInstance, BalanceStepSummaryContext, BalancesStepSummary, BlockNumberRange, BlockWindowInstance, BlockWindowStateInstance, BoundWitnessInstance, ChainContext, ChainServiceCollection, ChainServiceCollectionV2, ChainSummaryContext, ChainWindow, DataInstance, HydratedBlockInstance, HydratedTransactionInstance, NegativeBigInt, ObjectInstance, PayloadInstance, PositiveBigInt, ShiftedBigIntConfig, SignatureInstance, SignedBigInt, SignedInstance, StepSummary, StepSummaryFields, TransactionFeesInstance, ValidatableInstance, XL1AmountInstance };

package/dist/neutral/transaction/primitives/spec/transactionBlockByteCount.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=transactionBlockByteCount.spec.d.ts.map

package/dist/neutral/transaction/primitives/spec/transactionBlockByteCount.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactionBlockByteCount.spec.d.ts","sourceRoot":"","sources":["../../../../../src/transaction/primitives/spec/transactionBlockByteCount.spec.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json.schemastore.org/package.json",
   "name": "@xyo-network/xl1-protocol-sdk",
-  "version": "1.6.6",
+  "version": "1.7.0",
   "description": "XYO Layer One SDK Protocol",
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -22,37 +22,37 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/types/index.d.ts",
+      "types": "./dist/neutral/index.d.ts",
       "default": "./dist/neutral/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "./dist/neutral/index.mjs",
-  "types": "./dist/types/index.d.ts",
+  "types": "./dist/neutral/index.d.ts",
   "scripts": {
     "deploy": "echo Deploy not allowed!",
     "deploy3": "echo Deploy3 not allowed!"
   },
   "dependencies": {
-    "@xylabs/array": "^4.13.5",
-    "@xylabs/assert": "^4.13.5",
-    "@xylabs/hex": "^4.13.5",
-    "@xylabs/object": "^4.13.5",
-    "@xylabs/promise": "^4.13.5",
-    "@xylabs/typeof": "^4.13.5",
-    "@xyo-network/account-model": "^4.0.3",
-    "@xyo-network/archivist-model": "^4.0.3",
-    "@xyo-network/boundwitness-builder": "^4.0.3",
-    "@xyo-network/boundwitness-model": "^4.0.3",
-    "@xyo-network/payload-builder": "^4.0.3",
-    "@xyo-network/payload-model": "^4.0.3",
-    "@xyo-network/wallet-model": "^4.0.3",
-    "@xyo-network/xl1-protocol": "^1.6.2"
+    "@xylabs/array": "^4.13.15",
+    "@xylabs/assert": "^4.13.15",
+    "@xylabs/hex": "^4.13.15",
+    "@xylabs/object": "^4.13.15",
+    "@xylabs/promise": "^4.13.15",
+    "@xylabs/typeof": "^4.13.15",
+    "@xyo-network/account-model": "^4.1.1",
+    "@xyo-network/archivist-model": "^4.1.1",
+    "@xyo-network/boundwitness-builder": "^4.1.1",
+    "@xyo-network/boundwitness-model": "^4.1.1",
+    "@xyo-network/payload-builder": "^4.1.1",
+    "@xyo-network/payload-model": "^4.1.1",
+    "@xyo-network/wallet-model": "^4.1.1",
+    "@xyo-network/xl1-protocol": "^1.6.4"
   },
   "devDependencies": {
     "@types/node": "^24.0.13",
-    "@xylabs/ts-scripts-yarn3": "^6.5.18",
-    "@xylabs/tsconfig": "^6.5.18",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.23",
+    "@xylabs/tsconfig": "^7.0.0-rc.23",
     "knip": "^5.61.3",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"

package/dist/types/index.d.ts

@@ -1,8 +0,0 @@
-export * from './block/index.ts';
-export * from './ChainServiceCollection.ts';
-export * from './ChainServiceCollectionV2.ts';
-export * from './instances/index.ts';
-export * from './payload/index.ts';
-export * from './SignedBigInt.ts';
-export * from './transaction/index.ts';
-//# sourceMappingURL=index.d.ts.map