@xyo-network/xl1-protocol-sdk 1.15.10 → 1.15.11

package/dist/neutral/primitives/index.d.ts

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/primitives/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,wBAAwB,CAAA"}

package/dist/neutral/primitives/step/completedStepRewardAddress.d.ts

@@ -0,0 +1,4 @@
+import { type Address } from '@xylabs/hex';
+import type { StepIdentity } from '@xyo-network/xl1-protocol';
+export declare function completedStepRewardAddress({ block, step }: StepIdentity): Address;
+//# sourceMappingURL=completedStepRewardAddress.d.ts.map

package/dist/neutral/primitives/step/completedStepRewardAddress.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"completedStepRewardAddress.d.ts","sourceRoot":"","sources":["../../../../src/primitives/step/completedStepRewardAddress.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAa,MAAM,aAAa,CAAA;AACrD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAG7D,wBAAgB,0BAA0B,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,YAAY,GAAG,OAAO,CAGjF"}

package/dist/neutral/primitives/step/derivedReceiveAddress.d.ts

@@ -0,0 +1,3 @@
+import { type Address } from '@xylabs/hex';
+export declare function derivedReceiveAddress(address: Address, scope?: string): Address;
+//# sourceMappingURL=derivedReceiveAddress.d.ts.map

package/dist/neutral/primitives/step/derivedReceiveAddress.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"derivedReceiveAddress.d.ts","sourceRoot":"","sources":["../../../../src/primitives/step/derivedReceiveAddress.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAa,MAAM,aAAa,CAAA;AAIrD,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAG/E"}

package/dist/neutral/primitives/step/index.d.ts

@@ -0,0 +1,5 @@
+export * from './completedStepRewardAddress.ts';
+export * from './derivedReceiveAddress.ts';
+export * from './stepBlockRange.ts';
+export * from './stepTransferIndex.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/neutral/primitives/step/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/primitives/step/index.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAA;AAC/C,cAAc,4BAA4B,CAAA;AAC1C,cAAc,qBAAqB,CAAA;AACnC,cAAc,wBAAwB,CAAA"}

package/dist/neutral/primitives/step/spec/stepTransferIndex.spec.d.ts

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

package/dist/neutral/primitives/step/spec/stepTransferIndex.spec.d.ts.map

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

package/dist/neutral/primitives/step/stepBlockRange.d.ts

@@ -0,0 +1,3 @@
+import type { StepIdentity, XL1BlockRange } from '@xyo-network/xl1-protocol';
+export declare function stepBlockRange({ block, step }: StepIdentity): XL1BlockRange;
+//# sourceMappingURL=stepBlockRange.d.ts.map

package/dist/neutral/primitives/step/stepBlockRange.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stepBlockRange.d.ts","sourceRoot":"","sources":["../../../../src/primitives/step/stepBlockRange.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAG5E,wBAAgB,cAAc,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,YAAY,GAAG,aAAa,CAI3E"}

package/dist/neutral/primitives/step/stepTransferIndex.d.ts

@@ -0,0 +1,2 @@
+export declare function stepTransferIndex(block: number, step: number): number[];
+//# sourceMappingURL=stepTransferIndex.d.ts.map

package/dist/neutral/primitives/step/stepTransferIndex.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stepTransferIndex.d.ts","sourceRoot":"","sources":["../../../../src/primitives/step/stepTransferIndex.ts"],"names":[],"mappings":"AAGA,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,YAc5D"}

package/dist/neutral/primitives/transaction/elevatedPayloads.d.ts

@@ -0,0 +1,4 @@
+import type { WithStorageMeta } from '@xyo-network/payload-model';
+import type { AllowedBlockPayload, SignedHydratedTransactionWithStorageMeta } from '@xyo-network/xl1-protocol';
+export declare function elevatedPayloads([tx, payloads]: SignedHydratedTransactionWithStorageMeta): WithStorageMeta<AllowedBlockPayload>[];
+//# sourceMappingURL=elevatedPayloads.d.ts.map

package/dist/neutral/primitives/transaction/elevatedPayloads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"elevatedPayloads.d.ts","sourceRoot":"","sources":["../../../../src/primitives/transaction/elevatedPayloads.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AACjE,OAAO,KAAK,EAAE,mBAAmB,EAAE,wCAAwC,EAAE,MAAM,2BAA2B,CAAA;AAG9G,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE,wCAAwC,0CAgBxF"}

package/dist/neutral/primitives/transaction/index.d.ts

@@ -0,0 +1,2 @@
+export * from './elevatedPayloads.ts';
+//# sourceMappingURL=index.d.ts.map

package/dist/neutral/primitives/transaction/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/primitives/transaction/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json.schemastore.org/package.json",
   "name": "@xyo-network/xl1-protocol-sdk",
-  "version": "1.15.10",
+  "version": "1.15.11",
   "description": "XYO Layer One SDK Protocol",
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -56,6 +56,7 @@
     "@xyo-network/wallet-model": "~5.1.6",
     "@xyo-network/xl1-protocol": "~1.12.81",
     "async-mutex": "~0.5.0",
+    "ethers": "~6.15.0",
     "zod": "~4.1.12"
   },
   "devDependencies": {

package/src/config/RewardRedemptionApi.ts

@@ -7,18 +7,18 @@ export const RewardRedemptionApiConfigZod = z.object({
   host: z.string().default('localhost').register(globalRegistry, {
     default: 'localhost',
     description: 'Host for the Redemption API',
-    title: 'redemption.host',
+    title: 'rewardRedemptionApi.host',
     type: 'string',
   }),
   mnemonic: MnemonicStringZod.optional().register(globalRegistry, {
     description: 'Mnemonic for the Redemption API wallet',
-    title: 'redemption.mnemonic',
+    title: 'rewardRedemptionApi.mnemonic',
     type: 'string',
   }),
   port: z.coerce.number().default(8082).register(globalRegistry, {
     default: 8082,
     description: 'Port for the Redemption API',
-    title: 'redemption.port',
+    title: 'rewardRedemptionApi.port',
     type: 'number',
   }),
 })

package/src/config/Validation.ts

@@ -13,7 +13,16 @@ export const ValidationConfigZod = z.object({
     title: 'allowedRewardRedeemers',
     type: 'array',
   })),
-
+  allowedRewardEscrowAccountSigners: z.preprocess((val) => {
+    if (typeof val === 'string') {
+      return val.split(',').map(s => asAddress(s.trim()))
+    }
+    return val
+  }, z.array(AddressZod).optional().register(globalRegistry, {
+    description: 'List of allowed reward escrow account signer addresses, if undefined anyone can participate',
+    title: 'allowedRewardEscrowAccountSigners',
+    type: 'array',
+  })),
 })
 
 export type ValidationConfig = z.infer<typeof ValidationConfigZod>

package/src/index.ts

@@ -8,6 +8,8 @@ export * from './map/index.ts'
 export * from './model/index.ts'
 export * from './multipliers.ts'
 export * from './payload/index.ts'
+export * from './primitives/index.ts'
+export * from './primitives/index.ts'
 export * from './SignedBigInt.ts'
 export * from './time/index.ts'
 export * from './transaction/index.ts'

package/src/primitives/index.ts

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

package/src/primitives/step/completedStepRewardAddress.ts

@@ -0,0 +1,8 @@
+import { type Address, toAddress } from '@xylabs/hex'
+import type { StepIdentity } from '@xyo-network/xl1-protocol'
+import { keccak256 } from 'ethers'
+
+export function completedStepRewardAddress({ block, step }: StepIdentity): Address {
+  const addressKey = new TextEncoder().encode(`${block}|${step}`)
+  return toAddress(keccak256(addressKey).slice(-40), { prefix: false })
+}

package/src/primitives/step/derivedReceiveAddress.ts

@@ -0,0 +1,8 @@
+import { type Address, toAddress } from '@xylabs/hex'
+import { isDefined } from '@xylabs/typeof'
+import { keccak256 } from 'ethers'
+
+export function derivedReceiveAddress(address: Address, scope?: string): Address {
+  const addressKey = new TextEncoder().encode(isDefined(scope) ? `${scope}|${address}` : address)
+  return toAddress(keccak256(addressKey).slice(-40), { prefix: false })
+}

package/src/primitives/step/index.ts

@@ -0,0 +1,4 @@
+export * from './completedStepRewardAddress.ts'
+export * from './derivedReceiveAddress.ts'
+export * from './stepBlockRange.ts'
+export * from './stepTransferIndex.ts'

package/src/primitives/step/spec/stepTransferIndex.spec.ts

@@ -0,0 +1,23 @@
+import { StepSizes } from '@xyo-network/xl1-protocol'
+import {
+  describe, expect, it,
+} from 'vitest'
+
+import { stepTransferIndex } from '../stepTransferIndex.ts'
+
+describe('getStepTransferIndex', () => {
+  it('should get index [single entry]', { timeout: 120_000 }, () => {
+    const index = stepTransferIndex(StepSizes[3], 3)
+    expect (index[0]).toBe(0)
+    expect (index[1]).toBe(1)
+  })
+  it('should get index [double entry]', { timeout: 120_000 }, () => {
+    const index3 = stepTransferIndex(StepSizes[3] * StepSizes[4], 3)
+    expect (index3[0]).toBe(0)
+    expect (index3[1]).toBe(2)
+
+    const index4 = stepTransferIndex(StepSizes[3] * StepSizes[4], 4)
+    expect (index4[0]).toBe(1)
+    expect (index4[1]).toBe(2)
+  })
+})

package/src/primitives/step/stepBlockRange.ts

@@ -0,0 +1,8 @@
+import type { StepIdentity, XL1BlockRange } from '@xyo-network/xl1-protocol'
+import { asXL1BlockRange, StepSizes } from '@xyo-network/xl1-protocol'
+
+export function stepBlockRange({ block, step }: StepIdentity): XL1BlockRange {
+  const stepSize = StepSizes[step]
+  const start = block - stepSize
+  return asXL1BlockRange([start, start + stepSize - 1])
+}

package/src/primitives/step/stepTransferIndex.ts

@@ -0,0 +1,18 @@
+import { assertEx } from '@xylabs/assert'
+import { StepSizes } from '@xyo-network/xl1-protocol'
+
+export function stepTransferIndex(block: number, step: number) {
+  let rewardTransferCount = 0
+  let rewardTransferIndex = -1
+  for (let i = 3; i < StepSizes.length; i++) {
+    const stepSize = StepSizes[i]
+    if (block % stepSize === 0) {
+      if (stepSize === StepSizes[step]) {
+        rewardTransferIndex = rewardTransferCount
+      }
+      rewardTransferCount++
+    }
+  }
+  assertEx(rewardTransferIndex >= 0, () => `Error: Could not find step size for step ${step} at block ${block}`)
+  return [rewardTransferIndex, rewardTransferCount]
+}

package/src/primitives/transaction/elevatedPayloads.ts

@@ -0,0 +1,21 @@
+import type { WithStorageMeta } from '@xyo-network/payload-model'
+import type { AllowedBlockPayload, SignedHydratedTransactionWithStorageMeta } from '@xyo-network/xl1-protocol'
+import { isAllowedBlockPayload } from '@xyo-network/xl1-protocol'
+
+export function elevatedPayloads([tx, payloads]: SignedHydratedTransactionWithStorageMeta) {
+  const opCodes = (tx.script ?? []).filter(operation => operation.startsWith('elevate|'))
+  const elevatedPayloads: WithStorageMeta<AllowedBlockPayload>[] = []
+  for (const opCode of opCodes) {
+    const [code, hash] = opCode.split('|')
+    if (code === 'elevated') {
+      const elevatedPayload = payloads.find(payload => payload._hash === hash)
+      if (isAllowedBlockPayload(elevatedPayload)) {
+        elevatedPayloads.push(elevatedPayload)
+      }
+    }
+  }
+  if (opCodes.length === elevatedPayloads.length) {
+    return elevatedPayloads
+  }
+  throw new Error('Not all elevated payloads could be found in the transaction payloads')
+}

package/src/primitives/transaction/index.ts

@@ -0,0 +1 @@
+export * from './elevatedPayloads.ts'