@xyo-network/xl1-protocol-sdk 1.15.12 → 1.15.14

package/src/primitives/readPayloadMapFromStore.ts

@@ -0,0 +1,24 @@
+import type { Hash } from '@xylabs/hex'
+import { isDefined } from '@xylabs/typeof'
+import type { ReadArchivist } from '@xyo-network/archivist-model'
+import type { Payload } from '@xyo-network/payload-model'
+
+import { isReadArchivist } from '../block/index.ts'
+import type { PayloadMapRead } from '../model/index.ts'
+
+export function readPayloadMapFromStore<T extends Payload>(store: ReadArchivist<T> | PayloadMapRead<T>): PayloadMapRead<T> {
+  if (isReadArchivist(store)) {
+    return {
+      get: async (hash: Hash): Promise<T | undefined> => {
+        return (await store.get([hash]))[0]
+      },
+      getMany: async (hashes: Hash[]): Promise<T[]> => {
+        return (await store.get(hashes))
+      },
+      has: async (hash: Hash): Promise<boolean> => {
+        return isDefined((await store.get([hash]))[0])
+      },
+    }
+  }
+  return store
+}

package/src/{block/primitives → primitives/summary}/balances/balancesStepSummaryFromRange.ts

@@ -7,15 +7,16 @@ import { isAnyPayload } from '@xyo-network/payload-model'
 import type { XL1BlockRange } from '@xyo-network/xl1-protocol'
 import { StepSizes } from '@xyo-network/xl1-protocol'
 
-import { netBalancesForPayloads } from '../../../payload/index.ts'
+import {
+  deepCalculateFramesFromRange, hashFromBlockNumber,
+  hydrateBlock,
+} from '../../../block/index.ts'
+import type { BalanceStepSummaryContext } from '../../../model/index.ts'
+import type { BalancesStepSummary } from '../../../payloads/index.ts'
+import { BalancesStepSummarySchema, netBalancesForPayloads } from '../../../payloads/index.ts'
 import {
   parseSignedBigInt, type SignedBigInt, toSignedBigInt,
 } from '../../../SignedBigInt.ts'
-import { hydrateBlock } from '../../hydrate/index.ts'
-import { deepCalculateFramesFromRange } from '../frames/index.ts'
-import { hashFromBlockNumber } from '../hashFromBlockNumber.ts'
-import type { BalanceStepSummaryContext } from '../model.ts'
-import { type BalancesStepSummary, BalancesStepSummarySchema } from '../payloads/index.ts'
 
 export async function balancesStepSummaryFromRange(
   context: BalanceStepSummaryContext,

package/src/{block/primitives → primitives/summary}/balances/balancesSummary.ts

@@ -4,9 +4,9 @@ import { spanRootAsync } from '@xylabs/telemetry'
 import { isDefined } from '@xylabs/typeof'
 import { asBlockBoundWitnessWithStorageMeta, asXL1BlockNumber } from '@xyo-network/xl1-protocol'
 
+import { deepCalculateFramesFromRange } from '../../../block/index.ts'
+import type { BalanceStepSummaryContext } from '../../../model/index.ts'
 import { parseSignedBigInt } from '../../../SignedBigInt.ts'
-import { deepCalculateFramesFromRange } from '../frames/index.ts'
-import type { BalanceStepSummaryContext } from '../model.ts'
 import { balancesStepSummaryFromRange } from './balancesStepSummaryFromRange.ts'
 
 export async function balancesSummary(

package/src/primitives/summary/index.ts

@@ -0,0 +1,2 @@
+export * from './balances/index.ts'
+export * from './balances/index.ts'

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

@@ -0,0 +1,2 @@
+export * from './transfersStepSummaryFromRange.ts'
+export * from './transfersSummary.ts'

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

@@ -0,0 +1,96 @@
+/* eslint-disable max-statements */
+import { assertEx } from '@xylabs/assert'
+import { type Address } from '@xylabs/hex'
+import { PayloadBuilder } from '@xyo-network/payload-builder'
+import type { WithStorageMeta } from '@xyo-network/payload-model'
+import { isAnyPayload } from '@xyo-network/payload-model'
+import type { XL1BlockRange } from '@xyo-network/xl1-protocol'
+import { StepSizes } from '@xyo-network/xl1-protocol'
+
+import {
+  deepCalculateFramesFromRange,
+  hashFromBlockNumber, hydrateBlock,
+} from '../../../block/index.ts'
+import type { TransfersStepSummaryContext } from '../../../model/index.ts'
+import type { TransfersStepSummary } from '../../../payloads/index.ts'
+import { netTransfersForPayloads, TransfersStepSummarySchema } from '../../../payloads/index.ts'
+import {
+  parseSignedBigInt, type SignedBigInt, toSignedBigInt,
+} from '../../../SignedBigInt.ts'
+
+export async function transfersStepSummaryFromRange(
+  context: TransfersStepSummaryContext,
+  range: XL1BlockRange,
+): Promise<WithStorageMeta<TransfersStepSummary>> {
+  // 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()
+
+  let result: TransfersStepSummary | undefined = undefined
+
+  if (frameSize === 1) {
+    const hash = await hashFromBlockNumber(context, range[0])
+    const [, payloads] = await hydrateBlock(context.store, hash)
+    const transfers: Record<Address, Record<Address, SignedBigInt>> = {}
+    for (const [from, toMap] of Object.entries(netTransfersForPayloads(payloads))) {
+      transfers[from as Address] = transfers[from as Address] ?? {}
+      for (const [to, amount] of Object.entries(toMap)) {
+        transfers[from as Address][to as Address] = toSignedBigInt(amount)
+      }
+    }
+    result = {
+      schema: TransfersStepSummarySchema, hash: head, stepSize: -1, transfers,
+    }
+  } else {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const step = (StepSizes as any).indexOf(frameSize)
+    assertEx(step !== -1, () => `Invalid step size: ${frameSize}. Must be one of ${StepSizes.join(', ')}`)
+
+    const summaryResult = await context.summaryMap.get(`${frameHeadHash}|${frameSize}`)
+    if (isAnyPayload(summaryResult)) {
+      result = summaryResult as WithStorageMeta<TransfersStepSummary>
+    } else {
+      await context.stepSemaphores[step].acquire()
+      // We do not have it, so lets build it
+      try {
+        const subRanges = deepCalculateFramesFromRange(range, step - 1)
+        const promises = subRanges.map(subRange => transfersStepSummaryFromRange(
+          context,
+          subRange,
+        ))
+        const subResults = await Promise.all(promises)
+
+        // add them all up
+        const bigIntBalances: Record<Address, Record<Address, bigint>> = {}
+        for (const subResult of subResults) {
+          for (const [from, toMap] of Object.entries(subResult.transfers)) {
+            bigIntBalances[from as Address] = bigIntBalances[from as Address] ?? {}
+            for (const [to, transfer] of Object.entries(toMap)) {
+              bigIntBalances[from as Address][to as Address] = (bigIntBalances[from as Address][to as Address] ?? 0n) + parseSignedBigInt(transfer)
+            }
+          }
+        }
+
+        const transfers: Record<Address, Record<Address, SignedBigInt>> = {}
+        for (const [from, toMap] of Object.entries(bigIntBalances)) {
+          transfers[from as Address] = transfers[from as Address] ?? {}
+          for (const [to, transfer] of Object.entries(toMap)) {
+            transfers[from as Address][to as Address] = toSignedBigInt(transfer)
+          }
+        }
+
+        result = {
+          schema: TransfersStepSummarySchema, hash: frameHeadHash, stepSize: frameSize, transfers,
+        }
+
+        await context.summaryMap.set(`${frameHeadHash}|${frameSize}`, result)
+      } finally {
+        context.stepSemaphores[step].release()
+      }
+    }
+  }
+  // console.log(`transfersStepSummaryFromRange-result: head=${head}, range=${range[0]}-${range[1]}: ${toSafeJsonString(result, 10)}`)
+  const finalResult = await PayloadBuilder.addStorageMeta(result)
+  return finalResult
+}

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

@@ -0,0 +1,36 @@
+import type { Address } from '@xylabs/hex'
+import { asAddress } from '@xylabs/hex'
+import { spanRootAsync } from '@xylabs/telemetry'
+import { isDefined } from '@xylabs/typeof'
+import { asBlockBoundWitnessWithStorageMeta, asXL1BlockNumber } from '@xyo-network/xl1-protocol'
+
+import { deepCalculateFramesFromRange } from '../../../block/index.ts'
+import type { TransfersStepSummaryContext } from '../../../model/index.ts'
+import { parseSignedBigInt } from '../../../SignedBigInt.ts'
+import { transfersStepSummaryFromRange } from './transfersStepSummaryFromRange.ts'
+
+// the summary of amount of rewards claimed from the step reward pool by addresses
+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 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)))
+    const transfers: Partial<Record<Address, Partial<Record<Address, bigint>>>> = {}
+    for (let summary of summaries) {
+      for (const [from, toMap] of Object.entries(summary.transfers)) {
+        const validFrom = asAddress(from, () => `Invalid address: ${from}`)
+        transfers[validFrom] = transfers[validFrom] ?? {}
+        for (const [to, transfer] of Object.entries(toMap)) {
+          const validTo = asAddress(to, () => `Invalid address: ${to}`)
+          transfers[validFrom][validTo] = (transfers[validFrom][validTo] ?? 0n) + parseSignedBigInt(transfer)
+        }
+      }
+    }
+    return transfers
+  })
+}

package/dist/neutral/block/primitives/balances/balancesStepSummaryFromRange.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"balancesStepSummaryFromRange.d.ts","sourceRoot":"","sources":["../../../../../src/block/primitives/balances/balancesStepSummaryFromRange.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAEjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAU9D,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAA;AAC5D,OAAO,EAAE,KAAK,mBAAmB,EAA6B,MAAM,sBAAsB,CAAA;AAE1F,wBAAsB,4BAA4B,CAChD,OAAO,EAAE,yBAAyB,EAClC,KAAK,EAAE,aAAa,GACnB,OAAO,CAAC,eAAe,CAAC,mBAAmB,CAAC,CAAC,CA+D/C"}

package/dist/neutral/block/primitives/balances/balancesSummary.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"balancesSummary.d.ts","sourceRoot":"","sources":["../../../../../src/block/primitives/balances/balancesSummary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAQ1C,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAA;AAG5D,wBAAsB,eAAe,CACnC,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,CAiB3C"}

package/dist/neutral/block/primitives/balances/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/block/primitives/balances/index.ts"],"names":[],"mappings":"AAAA,cAAc,mCAAmC,CAAA;AACjD,cAAc,sBAAsB,CAAA"}

package/dist/neutral/block/primitives/payloads/BalancesStepSummary.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"BalancesStepSummary.d.ts","sourceRoot":"","sources":["../../../../../src/block/primitives/payloads/BalancesStepSummary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAE1C,OAAO,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAGzE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,eAAO,MAAM,yBAAyB,EAAE,MAA4C,CAAA;AACpF,MAAM,MAAM,yBAAyB,GAAG,OAAO,yBAAyB,CAAA;AAExE,MAAM,MAAM,mBAAmB,GAAG,WAAW,CAAC;IAC5C,QAAQ,EAAE,MAAM,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;CACxC,EAAE,yBAAyB,CAAC,CAAA;AAE7B;;GAEG;AACH,eAAO,MAAM,qBAAqB,kDAAwE,CAAA;AAC1G,eAAO,MAAM,qBAAqB,8DAAqE,CAAA;AAEvG;;GAEG;AACH,eAAO,MAAM,oCAAoC,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,eAAe,CAAC,mBAAmB,CAEjH,CAAA;AACD,eAAO,MAAM,oCAAoC,+EAAqG,CAAA"}

package/dist/neutral/block/primitives/payloads/StepSummary.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"StepSummary.d.ts","sourceRoot":"","sources":["../../../../../src/block/primitives/payloads/StepSummary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AAEjE,eAAO,MAAM,iBAAiB,EAAE,MAAmC,CAAA;AACnE,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAA;AAExD,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,IAAI,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,MAAM,WAAW,CAAC,iBAAiB,SAAS,WAAW,GAAG,IAAI,GAAG,IAAI,EACzE,OAAO,SAAS,MAAM,GAAG,IAAI,GAAG,IAAI,IAAI,OAAO,CAAC,iBAAiB,SAAS,IAAI,GAAG,iBAAiB,GAAG,iBAAiB,GAAG,iBAAiB,EAC1I,OAAO,SAAS,IAAI,GAAG,iBAAiB,GAAG,OAAO,CAAC,CAAA"}

package/dist/neutral/block/primitives/payloads/TransfersSummary.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"TransfersSummary.d.ts","sourceRoot":"","sources":["../../../../../src/block/primitives/payloads/TransfersSummary.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAE1C,OAAO,KAAK,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAGzE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAEnD,eAAO,MAAM,0BAA0B,EAAE,MAA4C,CAAA;AACrF,MAAM,MAAM,0BAA0B,GAAG,OAAO,0BAA0B,CAAA;AAE1E,MAAM,MAAM,oBAAoB,GAAG,WAAW,CAAC;IAC7C,SAAS,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAA;CAC1D,EAAE,0BAA0B,CAAC,CAAA;AAE9B;;GAEG;AACH,eAAO,MAAM,sBAAsB,mDAA0E,CAAA;AAC7G,eAAO,MAAM,sBAAsB,+DAAuE,CAAA;AAE1G;;GAEG;AACH,eAAO,MAAM,qCAAqC,GAAI,OAAO,OAAO,KAAG,KAAK,IAAI,eAAe,CAAC,oBAAoB,CAEnH,CAAA;AACD,eAAO,MAAM,qCAAqC,gFACsD,CAAA"}

package/dist/neutral/payload/AddressPairPayload.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AddressPairPayload.d.ts","sourceRoot":"","sources":["../../../src/payload/AddressPairPayload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAE1C,OAAO,EAAyB,KAAK,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAEhF,eAAO,MAAM,iBAAiB,EAAG,0BAAmC,CAAA;AACpE,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAA;AAExD,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;CAC9B;AAED,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,aAAa,EAAE,iBAAiB,CAAC,CAAA;AAE1E;;GAEG;AACH,eAAO,MAAM,oBAAoB,iDAA+D,CAAA;AAChG,eAAO,MAAM,oBAAoB,6DAA+C,CAAA;AAChF,eAAO,MAAM,4BAA4B,oFAAuD,CAAA"}

package/dist/neutral/payload/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/payload/index.ts"],"names":[],"mappings":"AAAA,cAAc,yBAAyB,CAAA;AACvC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,8BAA8B,CAAA"}

package/dist/neutral/payload/netBalancesForPayloads.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"netBalancesForPayloads.d.ts","sourceRoot":"","sources":["../../../src/payload/netBalancesForPayloads.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAGzD,eAAO,MAAM,sBAAsB,GAAI,UAAU,OAAO,EAAE;;;;WAczD,CAAA"}

package/dist/neutral/payload/netTransfersForPayloads.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"netTransfersForPayloads.d.ts","sourceRoot":"","sources":["../../../src/payload/netTransfersForPayloads.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,OAAO,EACb,MAAM,aAAa,CAAA;AAEpB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAIzD,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAgBrG"}