@xyo-network/xl1-protocol-sdk 1.15.26 → 1.15.28

package/src/model/ChainStake/ChainStakeRead.ts

@@ -1,17 +1,17 @@
 import type { Address } from '@xylabs/hex'
 import type { Promisable } from '@xylabs/promise'
-import type { Stake } from '@xyo-network/xl1-protocol'
+import type { Position } from '@xyo-network/xl1-protocol'
 
 export interface ChainStakeRead {
-  active(): Promisable<bigint>
-  activeByAddressStaked(address: string): Promisable<bigint>
-  activeByStaker(address: string): Promisable<bigint>
-  pending(): Promisable<bigint>
-  pendingByStaker(staker: string): Promisable<bigint>
-  stakeById(id: number): Promisable<Stake>
-  stakeByStaker(staker: Address, slot: number): Promisable<Stake>
-  stakesByStaked(staked: Address, range?: [number, number | 'latest']): Promisable<Stake[]>
-  stakesByStaker(staker: Address, range?: [number, number | 'latest']): Promisable<Stake[]>
-  withdrawn(): Promisable<bigint>
-  withdrawnByStaker(staker: string): Promisable<bigint>
+  active(time?: number): Promisable<bigint>
+  activeByAddressStaked(address: string, time?: number): Promisable<bigint>
+  activeByStaker(address: string, time?: number): Promisable<bigint>
+  pending(time?: number): Promisable<bigint>
+  pendingByStaker(staker: string, time?: number): Promisable<bigint>
+  stakeById(id: number, time?: number): Promisable<Position>
+  stakeByStaker(staker: Address, slot: number, time?: number): Promisable<Position>
+  stakesByStaked(staked: Address, range?: [number, number | undefined]): Promisable<Position[]>
+  stakesByStaker(staker: Address, range?: [number, number | undefined]): Promisable<Position[]>
+  withdrawn(time?: number): Promisable<bigint>
+  withdrawnByStaker(staker: string, time?: number): Promisable<bigint>
 }

package/src/model/StakeEvents.ts

@@ -34,5 +34,6 @@ export interface StakeEvent<TName extends StakeEventName = StakeEventName> exten
 }
 
 export interface StakeEventsRead {
+  positionCount(range: [number, number | 'latest']): Promisable<number>
   stakeEvents<TName extends StakeEventName>(range: [number, number | 'latest'], filter?: StakeEventFilter<TName>): Promisable<StakeEvent<TName>[]>
 }

package/src/primitives/index.ts

@@ -1,4 +1,5 @@
 export * from './readPayloadMapFromStore.ts'
 export * from './step/index.ts'
 export * from './summary/index.ts'
+export * from './timeBudget.ts'
 export * from './transaction/index.ts'

package/src/primitives/summary/balances/balancesStepSummaryFromRange.ts

@@ -25,7 +25,7 @@ export async function balancesStepSummaryFromRange(
   // console.log(`balanceStepSummaryFromRange: head=${head}, range=${range[0]}-${range[1]}`)
   const frameHeadHash = await hashFromBlockNumber(context, range[1])
   const frameSize = range[1] - range[0] + 1
-  const head = await context.head()
+  const [headHash] = await context.head()
 
   let result: BalancesStepSummary | undefined = undefined
 
@@ -37,7 +37,7 @@ export async function balancesStepSummaryFromRange(
       balances[address as Address] = toSignedBigInt(balance)
     }
     result = {
-      schema: BalancesStepSummarySchema, hash: head, stepSize: -1, balances,
+      schema: BalancesStepSummarySchema, hash: headHash, stepSize: -1, balances,
     }
   } else {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/src/primitives/summary/balances/balancesSummary.ts

@@ -13,9 +13,9 @@ export async function balancesSummary(
   context: BalanceStepSummaryContext,
 ): Promise<Partial<Record<Address, bigint>>> {
   return await spanRootAsync('balanceSummary', async () => {
-    const head = await context.head()
-    const headResult = await context.store.chainMap.get(head)
-    const headBoundWitness = asBlockBoundWitnessWithStorageMeta(headResult, () => `Head block not found for hash: ${context.head}`, { required: true })
+    const [headHash] = await context.head()
+    const headResult = await context.store.chainMap.get(headHash)
+    const headBoundWitness = asBlockBoundWitnessWithStorageMeta(headResult, () => `Head block not found for hash: ${headHash}`, { required: true })
     const rangeStart = asXL1BlockNumber(isDefined(context.windowSize) ? Math.max(headBoundWitness.block - context.windowSize + 1, 0) : 0)
     const ranges = deepCalculateFramesFromRange([rangeStart, asXL1BlockNumber(headBoundWitness.block)])
     const summaries = await Promise.all(ranges.map(range => balancesStepSummaryFromRange(context, range)))

package/src/primitives/summary/transfers/transfersStepSummaryFromRange.ts

@@ -25,7 +25,7 @@ export async function transfersStepSummaryFromRange(
   // console.log(`transfersStepSummaryFromRange: head=${head}, range=${range[0]}-${range[1]}`)
   const frameHeadHash = await hashFromBlockNumber(context, range[1])
   const frameSize = range[1] - range[0] + 1
-  const head = await context.head()
+  const [headHash] = await context.head()
 
   let result: TransfersStepSummary | undefined = undefined
 
@@ -40,7 +40,7 @@ export async function transfersStepSummaryFromRange(
       }
     }
     result = {
-      schema: TransfersStepSummarySchema, hash: head, stepSize: -1, transfers,
+      schema: TransfersStepSummarySchema, hash: headHash, stepSize: -1, transfers,
     }
   } else {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any

package/src/primitives/summary/transfers/transfersSummary.ts

@@ -14,9 +14,9 @@ export async function transfersSummary(
   context: TransfersStepSummaryContext,
 ): Promise<Partial<Record<Address, Partial<Record<Address, bigint>>>>> {
   return await spanRootAsync('transferSummary', async () => {
-    const head = await context.head()
-    const headResult = await context.store.chainMap.get(head)
-    const headBoundWitness = asBlockBoundWitnessWithStorageMeta(headResult, () => `Head block not found for hash: ${context.head}`, { required: true })
+    const [headHash] = await context.head()
+    const headResult = await context.store.chainMap.get(headHash)
+    const headBoundWitness = asBlockBoundWitnessWithStorageMeta(headResult, () => `Head block not found for hash: ${headHash}`, { required: true })
     const rangeStart = asXL1BlockNumber(isDefined(context.windowSize) ? Math.max(headBoundWitness.block - context.windowSize + 1, 0) : 0)
     const ranges = deepCalculateFramesFromRange([rangeStart, asXL1BlockNumber(headBoundWitness.block)])
     const summaries = await Promise.all(ranges.map(range => transfersStepSummaryFromRange(context, range)))

package/src/primitives/timeBudget.ts

@@ -0,0 +1,11 @@
+import { type Logger } from '@xylabs/logger'
+
+export async function timeBudget<TResult>(name: string, logger: Logger | undefined, func: () => Promise<TResult>, budget: number): Promise<TResult> {
+  const start = Date.now()
+  const result = await func()
+  const duration = Date.now() - start
+  if (duration > budget) {
+    logger?.warn(`Function [${name}] execution exceeded budget: ${duration}ms > ${budget}ms`)
+  }
+  return result
+}

package/src/transaction/buildUnsignedTransaction.ts

@@ -4,12 +4,8 @@ import { BoundWitnessBuilder } from '@xyo-network/boundwitness-builder'
 import { PayloadBuilder } from '@xyo-network/payload-builder'
 import type { Payload } from '@xyo-network/payload-model'
 import type {
-  AllowedBlockPayload,
-  ChainId,
-  ExecutableFields,
-  FromFields,
-  TransactionBoundWitness, TransactionBoundWitnessFields, TransactionFeesBigInt,
-  UnsignedHydratedTransactionWithHashStorageMeta,
+  AllowedBlockPayload, ChainId, ExecutableFields, FromFields, TransactionBoundWitness, TransactionBoundWitnessFields, TransactionFeesBigInt,
+  UnsignedHydratedTransaction,
 } from '@xyo-network/xl1-protocol'
 import { defaultTransactionFees } from '@xyo-network/xl1-protocol'
 
@@ -21,7 +17,7 @@ export async function buildUnsignedTransaction(
   exp: number,
   from: Address,
   fees: TransactionFeesBigInt = defaultTransactionFees,
-): Promise<UnsignedHydratedTransactionWithHashStorageMeta> {
+): Promise<UnsignedHydratedTransaction> {
   const txBoundWitnessFields: TransactionBoundWitnessFields = {
     chain,
     fees: {
@@ -55,5 +51,5 @@ export async function buildUnsignedTransaction(
     .payloads([...onChainPayloads, ...offChainPayloads])
     .build()
 
-  return [await PayloadBuilder.addStorageMeta(tx), await PayloadBuilder.addStorageMeta(txPayloads)]
+  return [tx, txPayloads]
 }

package/src/transaction/primitives/transactionElevatedPayloads.ts

@@ -1,5 +1,5 @@
 import { asHash, type Hash } from '@xylabs/hex'
-import type { Payload, WithHashStorageMeta } from '@xyo-network/payload-model'
+import type { Payload, WithHashMeta } from '@xyo-network/payload-model'
 import type { SignedHydratedTransactionWithStorageMeta, TransactionBoundWitness } from '@xyo-network/xl1-protocol'
 
 import { crackOperations } from './transactionOperations.ts'
@@ -9,7 +9,7 @@ export function transactionElevatedPayloadHashes(transaction: TransactionBoundWi
   return elevateOperations.map(op => asHash(op[1][0], true))
 }
 
-export function transactionElevatedPayloads([transaction, payloads]: SignedHydratedTransactionWithStorageMeta): WithHashStorageMeta<Payload>[] {
+export function transactionElevatedPayloads([transaction, payloads]: SignedHydratedTransactionWithStorageMeta): WithHashMeta<Payload>[] {
   const hashes = transactionElevatedPayloadHashes(transaction)
   const elevatedPayloads = payloads.filter(payload => hashes.includes(payload._hash))
   return elevatedPayloads

package/src/transaction/script.ts

@@ -3,7 +3,7 @@ import { assertEx } from '@xylabs/assert'
 import { asHash, type Hash } from '@xylabs/hex'
 import type { WithStorageMeta } from '@xyo-network/payload-model'
 import type { AllowedBlockPayload, HydratedTransactionWithStorageMeta } from '@xyo-network/xl1-protocol'
-import { isAllowedBlockPayloadWithHashStorageMeta } from '@xyo-network/xl1-protocol'
+import { isAllowedBlockPayloadWithHashMeta } from '@xyo-network/xl1-protocol'
 
 export const tryExtractElevatedHashesFromScript = (strings: string[]): Hash[] => {
   const hashes = strings
@@ -27,7 +27,7 @@ export const tryExtractElevatedHashes = (tx: HydratedTransactionWithStorageMeta)
   const hashes = script ? tryExtractElevatedHashesFromScript(script) : []
   return payloads
     .filter(p => hashes.includes(p._hash))
-    .filter(isAllowedBlockPayloadWithHashStorageMeta)
+    .filter(isAllowedBlockPayloadWithHashMeta)
 }
 
 export const extractElevatedHashes = (tx: HydratedTransactionWithStorageMeta): WithStorageMeta<AllowedBlockPayload>[] => {
@@ -36,7 +36,7 @@ export const extractElevatedHashes = (tx: HydratedTransactionWithStorageMeta): W
   const hashes = script ? tryExtractElevatedHashesFromScript(script) : []
   const filtered = payloads
     .filter(p => hashes.includes(p._hash))
-    .filter(isAllowedBlockPayloadWithHashStorageMeta)
+    .filter(isAllowedBlockPayloadWithHashMeta)
   assertEx(filtered.length === hashes.length, () => 'Invalid elevated hashes')
   return filtered
 }

package/dist/neutral/ChainServiceCollection.d.ts

@@ -1,61 +0,0 @@
-import type { ArchivistInstance, WriteArchivist } from '@xyo-network/archivist-model';
-import type { WalletInstance } from '@xyo-network/wallet-model';
-import type { AccountBalanceService, BlockProducerService, BlockRewardService, ChainContractViewer, ChainStaker, ChainStakeViewer, ElectionService, EventingChainBlockNumberIteratorService, StakeIntentService } from '@xyo-network/xl1-protocol';
-/** @deprecated use ChainServiceCollectionV2 */
-export 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?: EventingChainBlockNumberIteratorService;
-    /**
-     * 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;
-}
-//# sourceMappingURL=ChainServiceCollection.d.ts.map

package/dist/neutral/ChainServiceCollection.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ChainServiceCollection.d.ts","sourceRoot":"","sources":["../../src/ChainServiceCollection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAA;AACrF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAC/D,OAAO,KAAK,EACV,qBAAqB,EAAE,oBAAoB,EAC3C,kBAAkB,EAAE,mBAAmB,EAAE,WAAW,EAAE,gBAAgB,EAAE,eAAe,EAAE,uCAAuC,EAChI,kBAAkB,EACnB,MAAM,2BAA2B,CAAA;AAElC,+CAA+C;AAC/C,MAAM,WAAW,sBAAsB;IAErC;;OAEG;IACH,OAAO,EAAE,cAAc,CAAA;IACvB;;OAEG;IACH,cAAc,EAAE,qBAAqB,CAAA;IACrC;;OAEG;IACH,cAAc,EAAE,iBAAiB,CAAA;IACjC;;;OAGG;IACH,mBAAmB,EAAE,mBAAmB,CAAA;IACxC;;OAEG;IACH,aAAa,CAAC,EAAE,uCAAuC,CAAA;IACvD;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,CAAA;IAClC;;OAEG;IACH,WAAW,EAAE,WAAW,CAAA;IACxB;;OAEG;IACH,8BAA8B,EAAE,cAAc,CAAA;IAC9C;;OAEG;IACH,eAAe,EAAE,eAAe,CAAA;IAChC;;;OAGG;IACH,wCAAwC,EAAE,iBAAiB,CAAA;IAC3D;;OAEG;IACH,QAAQ,EAAE,oBAAoB,CAAA;IAC9B;;OAEG;IACH,aAAa,EAAE,kBAAkB,CAAA;IACjC;;OAEG;IACH,kBAAkB,EAAE,kBAAkB,CAAA;CACvC"}

package/dist/neutral/instances/ShiftedBigIntConfig.d.ts

@@ -1,9 +0,0 @@
-/** @deprecated use from \@xyo-network/xl1-protocol instead */
-export interface ShiftedBigIntConfig {
-    locale: Intl.LocalesArgument;
-    maxCharacters: number;
-    maxDecimal: number;
-    minDecimals: number;
-    places: number;
-}
-//# sourceMappingURL=ShiftedBigIntConfig.d.ts.map

package/dist/neutral/instances/ShiftedBigIntConfig.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ShiftedBigIntConfig.d.ts","sourceRoot":"","sources":["../../../src/instances/ShiftedBigIntConfig.ts"],"names":[],"mappings":"AAAA,8DAA8D;AAC9D,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/instances/XL1Amount.d.ts

@@ -1,15 +0,0 @@
-import type { AttoXL1, FemtoXL1, MicroXL1, MilliXL1, NanoXL1, PicoXL1 } from '@xyo-network/xl1-protocol';
-import type { ShiftedBigIntConfig } from './ShiftedBigIntConfig.ts';
-/** @deprecated use from \@xyo-network/xl1-protocol instead */
-export 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;
-}
-//# sourceMappingURL=XL1Amount.d.ts.map

package/dist/neutral/instances/XL1Amount.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"XL1Amount.d.ts","sourceRoot":"","sources":["../../../src/instances/XL1Amount.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EACxD,MAAM,2BAA2B,CAAA;AAElC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAEnE,8DAA8D;AAC9D,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,OAAO,CAAA;IAEd,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;IAEnC,KAAK,EAAE,QAAQ,CAAA;IAEf,KAAK,EAAE,QAAQ,CAAA;IAEf,IAAI,EAAE,OAAO,CAAA;IAEb,IAAI,EAAE,OAAO,CAAA;IAEb,KAAK,EAAE,QAAQ,CAAA;IAEf,IAAI,EAAE,OAAO,CAAA;IAEb,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,mBAAmB,CAAC,GAAG,MAAM,CAAA;CACvE"}

package/src/ChainServiceCollection.ts

@@ -1,66 +0,0 @@
-import type { ArchivistInstance, WriteArchivist } from '@xyo-network/archivist-model'
-import type { WalletInstance } from '@xyo-network/wallet-model'
-import type {
-  AccountBalanceService, BlockProducerService,
-  BlockRewardService, ChainContractViewer, ChainStaker, ChainStakeViewer, ElectionService, EventingChainBlockNumberIteratorService,
-  StakeIntentService,
-} from '@xyo-network/xl1-protocol'
-
-/** @deprecated use ChainServiceCollectionV2 */
-export 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?: EventingChainBlockNumberIteratorService
-  /**
-   * 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
-}

package/src/instances/ShiftedBigIntConfig.ts

@@ -1,8 +0,0 @@
-/** @deprecated use from \@xyo-network/xl1-protocol instead */
-export interface ShiftedBigIntConfig {
-  locale: Intl.LocalesArgument
-  maxCharacters: number
-  maxDecimal: number
-  minDecimals: number
-  places: number
-}

package/src/instances/XL1Amount.ts

@@ -1,29 +0,0 @@
-/* eslint-disable sonarjs/deprecation */
-/* eslint-disable @typescript-eslint/member-ordering */
-
-import type {
-  AttoXL1, FemtoXL1, MicroXL1, MilliXL1, NanoXL1, PicoXL1,
-} from '@xyo-network/xl1-protocol'
-
-import type { ShiftedBigIntConfig } from './ShiftedBigIntConfig.ts'
-
-/** @deprecated use from \@xyo-network/xl1-protocol instead */
-export 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
-}