@xyo-network/xl1-protocol 1.12.6 → 1.12.8

package/src/interfaces/StepStake.ts

@@ -0,0 +1,20 @@
+import type { Address } from '@xylabs/hex'
+import type { Promisable } from '@xylabs/promise'
+
+import type { CompletedStep } from '../model.ts'
+
+export interface StepStakeInterface {
+  // this is the prorated stake for all addresses in the step
+  stepStake: (step: CompletedStep) => Promisable<Record<Address, bigint>>
+
+  // this is the prorated stake for a specific address in the step
+  stepStakeForAddress: (address: Address, step: CompletedStep) => Promisable<bigint>
+}
+
+/* Prorated stake is the amount of stake that is allocated to a specific step
+   based on the total stake and the number of steps. This is used to ensure
+   that the stake is distributed fairly among all steps.
+
+   The simplest way to calculate it is to enumerate every XL1 block in the step add the current stake at that point to a counter.
+   For example, if an Address had a stake of 100 for the entire time, then the prorated stake would be 100 * number of blocks in the step.
+*/

package/src/interfaces/TimeSync.ts

@@ -0,0 +1,7 @@
+import type { Promisable } from '@xylabs/promise'
+
+import type { TimeDomain } from '../payload/index.ts'
+
+export interface TimeSyncInterface {
+  convertTime: (from: TimeDomain, to: TimeDomain) => Promisable<number>
+}

package/src/interfaces/index.ts

@@ -7,4 +7,5 @@ export * from './Fork.ts'
 export * from './NetworkStakeStepReward.ts'
 export * from './Stake.ts'
 export * from './StakeTotals.ts'
+export * from './StepStake.ts'
 export * from './Transaction.ts'

package/src/model.ts

@@ -1,3 +1,12 @@
-import type { Address, Hex } from '@xylabs/hex'
+import type {
+  Address, Hash, Hex,
+} from '@xylabs/hex'
 
 export type Chain = Address | Hex
+
+export type CompletedStep = [
+  /* Hash of the block whose previous hash is the last item in the step */
+  Hash,
+  /* Step number [index into StepSizes] */
+  number,
+]

package/src/payload/elevatable/BridgeBack.ts

@@ -0,0 +1,26 @@
+import type { Address, EthAddress } from '@xylabs/hex'
+import { AsObjectFactory } from '@xylabs/object'
+import type { Payload } from '@xyo-network/payload-model'
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+
+import type { FromFields } from './Executable.ts'
+
+export const BridgeBackSchema = 'network.xyo.chain.bridge.back' as const
+export type BridgeBackSchema = typeof BridgeBackSchema
+
+/* Report a bridging from WXL1 to XL1 */
+
+export interface BridgeBackFields extends FromFields {
+  destAddress: Address
+  src: 'ethereum'
+  srcAddress: EthAddress
+  // usually the source's block number
+  srcTime: number
+}
+
+// if this payload is included in a boundwitness, it needs to be available for inspection to be included in block
+export type BridgeBack = Payload<BridgeBackFields, BridgeBackSchema>
+
+export const isBridgeBack = isPayloadOfSchemaType<BridgeBack>(BridgeBackSchema)
+
+export const asBridgeBack = AsObjectFactory.create(isBridgeBack)

package/src/payload/elevatable/BridgeComplete.ts

@@ -0,0 +1,24 @@
+import type { Hash } from '@xylabs/hex'
+import { AsObjectFactory } from '@xylabs/object'
+import type { Payload } from '@xyo-network/payload-model'
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+
+import type { FromFields } from './Executable.ts'
+
+export const BridgeCompleteSchema = 'network.xyo.chain.bridge.complete' as const
+export type BridgeCompleteSchema = typeof BridgeCompleteSchema
+
+/* Complete a bridging from XL1 to WXL1 */
+
+export interface BridgeCompleteFields extends FromFields {
+  // usually the destination's block number
+  destTime: number
+  request: Hash
+}
+
+// if this payload is included in a boundwitness, it needs to be available for inspection to be included in block
+export type BridgeComplete = Payload<BridgeCompleteFields, BridgeCompleteSchema>
+
+export const isBridgeComplete = isPayloadOfSchemaType<BridgeComplete>(BridgeCompleteSchema)
+
+export const asBridgeComplete = AsObjectFactory.create(isBridgeComplete)

package/src/payload/elevatable/BridgeRequest.ts

@@ -0,0 +1,30 @@
+import type {
+  Address, EthAddress, Hex,
+} from '@xylabs/hex'
+import { AsObjectFactory } from '@xylabs/object'
+import type { Payload } from '@xyo-network/payload-model'
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+
+import type { FromFields } from './Executable.ts'
+
+/* Request a bridging from XL1 to WXL1 */
+
+export const BridgeRequestSchema = 'network.xyo.chain.bridge.request' as const
+export type BridgeRequestSchema = typeof BridgeRequestSchema
+
+export interface BridgeRequestFields extends FromFields {
+  amount: Hex
+
+  dest: 'ethereum'
+  destAddress: EthAddress
+
+  // xl1 address
+  srcAddress: Address
+}
+
+// if this payload is included in a boundwitness, it needs to be available for inspection to be included in block
+export type BridgeRequest = Payload<BridgeRequestFields, BridgeRequestSchema>
+
+export const isBridgeRequest = isPayloadOfSchemaType<BridgeRequest>(BridgeRequestSchema)
+
+export const asBridgeRequest = AsObjectFactory.create(isBridgeRequest)

package/src/payload/elevatable/Time.ts

@@ -0,0 +1,25 @@
+import { AsObjectFactory } from '@xylabs/object'
+import type { Payload } from '@xyo-network/payload-model'
+import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
+
+// xl1 = xl1 block number, epoch = epoch number, ethereum = ethereum block number
+export type TimeDomain = 'xl1' | 'epoch' | 'ethereum'
+
+export const TimeSchema = 'network.xyo.time' as const
+export type TimeSchema = typeof TimeSchema
+
+export interface TimeFields {
+  // in milliseconds
+  epoch: number
+  // in block number
+  ethereum?: number
+  // in block number
+  xl1?: number
+}
+
+export type TimePayload = Payload<TimeFields, TimeSchema>
+
+export const isTimePayload = isPayloadOfSchemaType<TimePayload>(TimeSchema)
+
+export const asTimePayload = AsObjectFactory.create(isTimePayload)
+export const asTimePayloadWithStorageMeta = AsObjectFactory.create(isTimePayload)

package/src/payload/elevatable/index.ts

@@ -1,6 +1,9 @@
+export * from './BridgeBack.ts'
+export * from './BridgeComplete.ts'
+export * from './BridgeRequest.ts'
 export * from './ChainStakeIntent.ts'
 export * from './Executable.ts'
 export * from './Hash.ts'
 export * from './StepComplete.ts'
+export * from './Time.ts'
 export * from './TransferPayload.ts'
-export * from './TransferRequest.ts'

package/src/services/BlockRewardService.ts

@@ -3,5 +3,6 @@ import type { Promisable } from '@xylabs/promise'
 import type { ServiceInterface } from './Service.ts'
 
 export interface BlockRewardService extends ServiceInterface {
+  // The amount of xl1 to send to the producer from the block reward
   getRewardForBlock(block: bigint): Promisable<bigint>
 }

package/src/services/BlockRewardServiceV2.ts

@@ -0,0 +1,8 @@
+import type { Promisable } from '@xylabs/promise'
+
+import type { BlockRewardService } from './BlockRewardService.ts'
+
+export interface BlockRewardServiceV2 extends BlockRewardService {
+  // The amount of xl1 to send to the step pool from the block reward
+  getRewardForStepPool(block: bigint): Promisable<bigint>
+}

package/src/services/NetworkStakeService.ts

@@ -0,0 +1,9 @@
+import type { Address } from '@xylabs/hex'
+import type { Promisable } from '@xylabs/promise'
+
+import type { CompletedStep } from '../model.ts'
+import type { ServiceInterface } from './Service.ts'
+
+export interface NetworkStakeService extends ServiceInterface {
+  stepStakeForAddress: (address: Address, step: CompletedStep) => Promisable<bigint>
+}

package/src/services/index.ts

@@ -1,11 +1,13 @@
 export * from './AccountBalanceService.ts'
 export * from './BlockProducerService.ts'
 export * from './BlockRewardService.ts'
+export * from './BlockRewardServiceV2.ts'
 export * from './Chain/index.ts'
 export * from './ChainIterator/index.ts'
 export * from './ChainServiceCollection.ts'
 export * from './ChainServiceCollectionV2.ts'
 export * from './Election.ts'
+export * from './NetworkStakeService.ts'
 export * from './PendingTransactionsService.ts'
 export * from './Service.ts'
 export * from './StakeIntentService/index.ts'

package/dist/neutral/payload/elevatable/TransferRequest.d.ts

@@ -1,13 +0,0 @@
-import type { Address, Hex } from '@xylabs/hex';
-import type { Payload } from '@xyo-network/payload-model';
-import type { FromFields } from './Executable.ts';
-export declare const TransferRequestSchema: "network.xyo.transfer.request";
-export type TransferRequestSchema = typeof TransferRequestSchema;
-export interface TransferRequestFields extends FromFields {
-    epoch: number;
-    transfers: Partial<Record<Address, Hex>>;
-}
-export type TransferRequest = Payload<TransferRequestFields, TransferRequestSchema>;
-export declare const isTransferRequest: (x?: unknown | null) => x is TransferRequest;
-export declare const asTransferRequest: import("@xylabs/object").AsTypeFunction<TransferRequest>;
-//# sourceMappingURL=TransferRequest.d.ts.map

package/dist/neutral/payload/elevatable/TransferRequest.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"TransferRequest.d.ts","sourceRoot":"","sources":["../../../../src/payload/elevatable/TransferRequest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,GAAG,EACJ,MAAM,aAAa,CAAA;AAEpB,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAGzD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,eAAO,MAAM,qBAAqB,EAAG,8BAAuC,CAAA;AAC5E,MAAM,MAAM,qBAAqB,GAAG,OAAO,qBAAqB,CAAA;AAKhE,MAAM,WAAW,qBAAsB,SAAQ,UAAU;IACvD,KAAK,EAAE,MAAM,CAAA;IAEb,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAA;CACzC;AAGD,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC,qBAAqB,EAAE,qBAAqB,CAAC,CAAA;AAEnF,eAAO,MAAM,iBAAiB,8CAAgE,CAAA;AAE9F,eAAO,MAAM,iBAAiB,0DAA4C,CAAA"}

package/src/payload/elevatable/TransferRequest.ts

@@ -1,28 +0,0 @@
-import type {
-  Address,
-  Hex,
-} from '@xylabs/hex'
-import { AsObjectFactory } from '@xylabs/object'
-import type { Payload } from '@xyo-network/payload-model'
-import { isPayloadOfSchemaType } from '@xyo-network/payload-model'
-
-import type { FromFields } from './Executable.ts'
-
-export const TransferRequestSchema = 'network.xyo.transfer.request' as const
-export type TransferRequestSchema = typeof TransferRequestSchema
-
-/* The initial use for this is for a network staker to request a transfer from the step reward account to them for the rewards they are owed */
-/* By definition, a request is valid for 1000 blocks following its inclusion in a block or until the request has been filled */
-
-export interface TransferRequestFields extends FromFields {
-  epoch: number
-  // the amount that is requested to be sent to other addresses
-  transfers: Partial<Record<Address, Hex>>
-}
-
-// if this payload is included in a boundwitness, it needs to be available for inspection to be included in block
-export type TransferRequest = Payload<TransferRequestFields, TransferRequestSchema>
-
-export const isTransferRequest = isPayloadOfSchemaType<TransferRequest>(TransferRequestSchema)
-
-export const asTransferRequest = AsObjectFactory.create(isTransferRequest)