@xyo-network/xl1-protocol-sdk 1.16.2 → 1.16.4

package/src/interfaces/viewers/Block.ts

@@ -2,7 +2,7 @@ import type { Hash } from '@xylabs/hex'
 import type { Promisable } from '@xylabs/promise'
 import type { HydratedBlock } from '@xyo-network/xl1-protocol'
 
-export interface BlockViewInterface {
+export interface BlockViewierMethods {
   blockByHash(hash: Hash): Promisable<HydratedBlock | null>
   blockByNumber(blockNumber: number): Promisable<HydratedBlock | null>
   blocksByHash(hash: Hash, limit?: number): Promisable<HydratedBlock[]>

package/src/interfaces/viewers/Chain.ts

@@ -1,6 +1,6 @@
 import type { Promisable } from '@xylabs/promise'
 import type { ChainId } from '@xyo-network/xl1-protocol'
 
-export interface ChainViewInterface {
+export interface ChainViewerMethods {
   chainId(): Promisable<ChainId>
 }

package/src/interfaces/viewers/ChainContract.ts

@@ -1,6 +1,6 @@
 import type { Address } from '@xylabs/hex'
 
-export interface ChainContractViewInterface {
+export interface ChainContractViewerMethods {
   forkedAtBlockNumber(): Promise<bigint>
   forkedAtHash(): Promise<bigint>
   forkedChainId(): Promise<Address>
@@ -8,3 +8,5 @@ export interface ChainContractViewInterface {
   rewardsContract(): Promise<string>
   stakingTokenAddress(): Promise<string>
 }
+
+export interface ChainContractViewer extends ChainContractViewerMethods {}

package/src/interfaces/viewers/Fork.ts

@@ -3,7 +3,7 @@ import type { ChainId } from '@xyo-network/xl1-protocol'
 
 export type ForkHistory = Record<number, ChainId>
 
-export interface ForkViewer {
+export interface ForkViewerMethods {
   chainIdAtBlock(blockNumber: number): Promisable<ChainId | undefined>
   forkHistory(): Promisable<ForkHistory>
 }

package/src/interfaces/viewers/NetworkStakeStepReward.ts

@@ -2,7 +2,7 @@ import type { Address } from '@xylabs/hex'
 import type { Promisable } from '@xylabs/promise'
 import type { StepIdentity, StepIdentityString } from '@xyo-network/xl1-protocol'
 
-export interface NetworkStakeStepAddressRewardViewInterface {
+export interface NetworkStakeStepAddressRewardViewerMethods {
   // the step rewards for a specific network stakers for all of history
   networkStakeStepRewardAddressHistory(address: Address): Promisable<Record<Address, bigint>>
 
@@ -16,7 +16,7 @@ export interface NetworkStakeStepAddressRewardViewInterface {
   networkStakeStepRewardWeightForAddress(context: StepIdentity, address: Address): Promisable<bigint>
 }
 
-export interface NetworkStakeStepPoolRewardViewInterface {
+export interface NetworkStakeStepPoolRewardViewerMethods {
 
   // all the step rewards for all the network stakers for a given step and block
   networkStakeStepRewardPoolRewards(context: StepIdentity): Promisable<Record<Address, bigint>>
@@ -25,7 +25,7 @@ export interface NetworkStakeStepPoolRewardViewInterface {
   networkStakeStepRewardPoolShares(context: StepIdentity): Promisable<Record<Address, bigint>>
 }
 
-export interface NetworkStakeStepRewardPositionViewInterface {
+export interface NetworkStakeStepRewardPositionViewerMethods {
   // estimate the current weight for a given position at a given step
   networkStakeStepRewardPositionWeight(context: StepIdentity, position: number): Promisable<bigint>
 
@@ -33,10 +33,10 @@ export interface NetworkStakeStepRewardPositionViewInterface {
   networkStakeStepRewardPotentialPositionLoss(context: StepIdentity, position: number): Promisable<bigint>
 }
 
-export interface NetworkStakeStepRewardViewInterface extends
-  NetworkStakeStepPoolRewardViewInterface,
-  NetworkStakeStepAddressRewardViewInterface,
-  NetworkStakeStepRewardPositionViewInterface
+export interface NetworkStakeStepRewardViewer extends
+  NetworkStakeStepPoolRewardViewerMethods,
+  NetworkStakeStepAddressRewardViewerMethods,
+  NetworkStakeStepRewardPositionViewerMethods
 {
   networkStakeStepRewardClaimedByAddress(address: Address): Promisable<bigint>
 

package/src/interfaces/viewers/StakeTotalsViewer.ts

@@ -1,7 +1,7 @@
 import type { Address } from '@xylabs/hex'
 import type { Promisable } from '@xylabs/promise'
 
-export interface StakeTotalsViewer {
+export interface StakeTotalsViewerMethods {
   active(): Promisable<bigint>
   activeByStaked(staked: Address): Promisable<bigint>
   activeByStaker(address: Address): Promisable<bigint>
@@ -10,3 +10,5 @@ export interface StakeTotalsViewer {
   withdrawn(): Promisable<bigint>
   withdrawnByStaker(staker: Address): Promisable<bigint>
 }
+
+export interface StakeTotalsViewer extends StakeTotalsViewerMethods {}

package/src/interfaces/viewers/StakeViewer.ts

@@ -1,9 +1,9 @@
 import type { Address } from '@xylabs/hex'
 import type { Promisable } from '@xylabs/promise'
 
-import type { Position } from './Stake.ts'
+import type { Position } from '../../model/index.ts'
 
-export interface StakeViewer {
+export interface StakeViewerMethods {
   stakeById(id: number): Promisable<Position>
   stakeByStaker(staker: Address, slot: number): Promisable<Position>
   /* @deprecated use stakesByStaker */

package/src/interfaces/viewers/StepStake.ts

@@ -2,7 +2,7 @@ import type { Address } from '@xylabs/hex'
 import type { Promisable } from '@xylabs/promise'
 import type { StepIdentity } from '@xyo-network/xl1-protocol'
 
-export interface StepStakeViewInterface {
+export interface StepStakeViewerMethods {
   // this is the prorated stake for all addresses in the step
   stepStake: (step: StepIdentity) => Promisable<Record<Address, bigint>>
 
@@ -17,3 +17,5 @@ export interface StepStakeViewInterface {
    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.
 */
+
+export interface StepStakeViewer extends StepStakeViewerMethods {}

package/src/interfaces/viewers/TimeSync.ts

@@ -2,18 +2,18 @@ import type { Hash } from '@xylabs/hex'
 import type { Promisable } from '@xylabs/promise'
 import type { TimeDomain, TimePayload } from '@xyo-network/xl1-protocol'
 
-export interface TimeSyncViewInterface {
+export interface TimeSyncViewerMethods {
   /** Convert time between different domains */
   convertTime(fromDomain: TimeDomain, toDomain: TimeDomain, from: number): Promisable<number>
 
   /** Get the current time for a given domain */
   currentTime(domain: TimeDomain): Promisable<[string, number]>
-}
 
-export interface TimeSyncViewInterfaceV2 extends TimeSyncViewInterface {
   /** Get the current time for a given domain */
   currentTimeAndHash(domain: TimeDomain): Promisable<[number, Hash | null]>
 
   /** Create a TimePayload with the current time from all configured domains */
   currentTimePayload(): Promisable<TimePayload>
 }
+
+export interface TimeSyncViewer extends TimeSyncViewerMethods {}

package/src/interfaces/viewers/Transaction.ts

@@ -2,7 +2,7 @@ import type { Hash } from '@xylabs/hex'
 import type { Promisable } from '@xylabs/promise'
 import type { SignedHydratedTransaction } from '@xyo-network/xl1-protocol'
 
-export interface TransactionViewInterface {
+export interface TransactionViewerMethods {
   transactionByBlockHashAndIndex(blockHash: Hash, transactionIndex: number): Promisable<SignedHydratedTransaction | null>
   transactionByBlockNumberAndIndex(blockNumber: number, transactionIndex: number): Promisable<SignedHydratedTransaction | null>
   transactionByHash(transactionHash: Hash): Promisable<SignedHydratedTransaction | null>

package/src/interfaces/viewers/TransferBalance.ts

@@ -14,14 +14,14 @@ export type TransferBalanceHistoryItem = [
 ]
 export type TransferPair = [/* from */ Address, /* to */Address]
 
-export interface TransferBalancesViewInterface {
+export interface TransferBalancesViewerMethods {
   transferBalances(address: Address[]): Promisable<Partial<Record<Address, Record<Address, AttoXL1>>>>
   transferBalancesHistories(address: Address[]): Promisable<Partial<Record<Address, Record<Address, TransferBalanceHistoryItem[]>>>>
   transferPairBalances(address: TransferPair[]): Promisable<Partial<Record<Address, Record<Address, AttoXL1>>>>
   transferPairBalancesHistories(address: TransferPair[]): Promisable<Partial<Record<Address, Record<Address, TransferBalanceHistoryItem[]>>>>
 }
 
-export interface TransferBalanceViewInterface {
+export interface TransferBalanceViewerMethods {
   transferBalance(address: Address): Promisable<AttoXL1>
   transferBalanceHistory(address: Address, range?: XL1BlockRange): Promisable<TransferBalanceHistoryItem[]>
   transferPairBalance(address: TransferPair): Promisable<AttoXL1>

package/src/interfaces/viewers/index.ts

@@ -4,7 +4,6 @@ export * from './Chain.ts'
 export * from './ChainContract.ts'
 export * from './Fork.ts'
 export * from './NetworkStakeStepReward.ts'
-export * from './Stake.ts'
 export * from './StakeTotalsViewer.ts'
 export * from './StakeViewer.ts'
 export * from './StepStake.ts'

package/src/model/ChainStake/ChainStakeRead.ts

@@ -1,7 +1,7 @@
 import type { Address } from '@xylabs/hex'
 import type { Promisable } from '@xylabs/promise'
 
-import type { Position } from '../../interfaces/index.ts'
+import type { Position } from '../Position.ts'
 
 export interface ChainStakeRead {
   active(time?: number): Promisable<bigint>

package/src/model/index.ts

@@ -4,6 +4,7 @@ export * from './ChainIdentity.ts'
 export * from './ChainStake/index.ts'
 export * from './ChainStore.ts'
 export * from './PayloadMap.ts'
+export * from './Position.ts'
 export * from './RecordKeyType.ts'
 export * from './StakeEvents.ts'
 export * from './summary.ts'

package/src/provider/XyoGateway.ts

@@ -1,3 +1,5 @@
+import type { Promisable } from '@xylabs/promise'
+
 import type { XyoSigner } from './signer/index.ts'
 import type { XyoConnection } from './XyoConnection.ts'
 
@@ -5,9 +7,15 @@ export interface XyoGateway {
   /**
    * Returns the connection provider for this gateway.
    */
-  connection: XyoConnection
+  connectionInstance: XyoConnection
   /**
    * Returns the signer for this gateway.
    */
-  signer: XyoSigner
+  signerInstance: XyoSigner
+
+  /** @deprecated use connectionInstance */
+  connection(): Promisable<XyoConnection>
+
+  /** @deprecated use signerInstance */
+  signer(): Promisable<XyoSigner>
 }

package/src/provider/viewer/StepViewer.ts

@@ -2,7 +2,7 @@ import type { Address } from '@xylabs/hex'
 import type { Promisable } from '@xylabs/promise'
 import type { PositionId, StepIdentity } from '@xyo-network/xl1-protocol'
 
-import type { Position } from '../../interfaces/index.ts'
+import type { Position } from '../../model/index.ts'
 import type { NetworkStakeStepRewardsViewer } from './NetworkStake/index.ts'
 
 export interface PagedPositionsOptions {

package/src/provider/viewer/XyoViewer.ts

@@ -1,16 +1,19 @@
 import type {
-  AccountBalanceViewInterface, BlockViewInterface, ChainViewInterface,
-  ForkViewer,
-  NetworkStakeStepRewardViewInterface,
-  StakeViewer,
-  TransactionViewInterface, TransferBalanceViewInterface,
+  AccountBalanceViewerMethods,
+  BlockViewierMethods,
+  ChainViewerMethods,
+  ForkViewerMethods,
+  NetworkStakeStepRewardViewer,
+  StakeViewerMethods,
+  TransactionViewerMethods,
+  TransferBalanceViewerMethods,
 } from '../../interfaces/index.ts'
 import type { NetworkStakeViewer } from './NetworkStake/index.ts'
 import type { StepViewer } from './StepViewer.ts'
 
-export interface XyoViewerMethods extends AccountBalanceViewInterface, TransferBalanceViewInterface,
-  NetworkStakeStepRewardViewInterface,
-  ChainViewInterface, BlockViewInterface, TransactionViewInterface, StakeViewer, ForkViewer {
+export interface XyoViewerMethods extends AccountBalanceViewerMethods, TransferBalanceViewerMethods,
+  NetworkStakeStepRewardViewer,
+  ChainViewerMethods, BlockViewierMethods, TransactionViewerMethods, StakeViewerMethods, ForkViewerMethods {
 }
 
 export interface XyoViewer extends XyoViewerMethods {

package/src/services/Chain/ChainService.ts

@@ -1,6 +1,5 @@
+import type { ChainContractViewer } from '../../interfaces/index.ts'
 import type { BaseChainService } from './BaseChainService.ts'
-import type {
-  ChainContractViewer, ChainStaker, ChainStakeViewer,
-} from './interfaces/index.ts'
+import type { ChainStaker, ChainStakeViewer } from './interfaces/index.ts'
 
 export interface ChainService extends ChainContractViewer, ChainStakeViewer, ChainStaker, BaseChainService {}

package/src/services/Chain/interfaces/ChainStakeViewer.ts

@@ -1,5 +1,4 @@
-import type { StakeTotalsViewer } from '../../../interfaces/index.ts'
-import type { ChainContractViewer } from './ChainContractViewer.ts'
+import type { ChainContractViewer, StakeTotalsViewer } from '../../../interfaces/index.ts'
 
 export interface ChainStakeViewer extends ChainContractViewer, StakeTotalsViewer {
 

package/src/services/Chain/interfaces/index.ts

@@ -1,3 +1,2 @@
-export * from './ChainContractViewer.ts'
 export * from './ChainStaker.ts'
 export * from './ChainStakeViewer.ts'

package/src/services/NetworkStakeService.ts

@@ -1,4 +1,4 @@
-import type { NetworkStakeStepRewardViewInterface } from '../interfaces/index.ts'
+import type { NetworkStakeStepRewardViewer } from '../interfaces/index.ts'
 import type { ServiceInterface } from './Service.ts'
 
-export interface NetworkStakeStepRewardService extends NetworkStakeStepRewardViewInterface, ServiceInterface {}
+export interface NetworkStakeStepRewardService extends NetworkStakeStepRewardViewer, ServiceInterface {}

package/src/services/StepStakeService.ts

@@ -1,4 +1,4 @@
-import type { StepStakeViewInterface } from '../interfaces/index.ts'
+import type { StepStakeViewer } from '../interfaces/index.ts'
 import type { ServiceInterface } from './Service.ts'
 
-export interface StepStakeService extends ServiceInterface, StepStakeViewInterface {}
+export interface StepStakeService extends ServiceInterface, StepStakeViewer {}

package/src/services/TimeSyncService.ts

@@ -1,6 +1,4 @@
-import type { TimeSyncViewInterface, TimeSyncViewInterfaceV2 } from '../interfaces/index.ts'
+import type { TimeSyncViewerMethods } from '../interfaces/index.ts'
 import type { ServiceInterface } from './Service.ts'
 
-export interface TimeSyncService extends ServiceInterface, TimeSyncViewInterface {}
-
-export interface TimeSyncServiceV2 extends ServiceInterface, TimeSyncViewInterfaceV2 {}
+export interface TimeSyncService extends ServiceInterface, TimeSyncViewerMethods {}

package/src/simple/gateway/SimpleXyoGateway.ts

@@ -1,3 +1,5 @@
+import type { Promisable } from '@xylabs/promise'
+
 import type {
   XyoConnection, XyoGateway, XyoSigner,
 } from '../../provider/index.ts'
@@ -11,11 +13,19 @@ export class SimpleXyoGateway implements XyoGateway {
     this._connection = connection
   }
 
-  get connection(): XyoConnection {
+  get connectionInstance(): XyoConnection {
+    return this._connection
+  }
+
+  get signerInstance(): XyoSigner {
+    return this._signer
+  }
+
+  connection(): Promisable<XyoConnection> {
     return this._connection
   }
 
-  get signer(): XyoSigner {
+  signer(): Promisable<XyoSigner> {
     return this._signer
   }
 }

package/src/simple/gateway/SimpleXyoGatewayRunner.ts

@@ -3,6 +3,7 @@ import type {
   Address, Hash, Hex,
 } from '@xylabs/hex'
 import { BigIntToJsonZod } from '@xylabs/hex'
+import type { Promisable } from '@xylabs/promise'
 import { isDefined } from '@xylabs/typeof'
 import { PayloadBuilder } from '@xyo-network/payload-builder'
 import type { Payload, WithHashMeta } from '@xyo-network/payload-model'
@@ -32,16 +33,16 @@ export class SimpleXyoGatewayRunner implements XyoGatewayRunner {
     this._dataLakes = [...dataLakes]
   }
 
-  get connection(): XyoConnection {
-    return this.gateway.connection
+  get connectionInstance(): XyoConnection {
+    return this.gateway.connectionInstance
   }
 
   get dataLakes(): DataLakeRunner[] {
     throw new Error('Method not implemented.')
   }
 
-  get signer(): XyoSigner {
-    return this.gateway.signer
+  get signerInstance(): XyoSigner {
+    return this.gateway.signerInstance
   }
 
   addDataLake(dataLake: DataLakeRunner): number {
@@ -55,7 +56,7 @@ export class SimpleXyoGatewayRunner implements XyoGatewayRunner {
     options?: TransactionOptions,
   ): Promise<[Hash, SignedHydratedTransactionWithHashMeta]> {
     // Get chain providers
-    const viewer = assertEx(this.connection.viewer, () => 'No viewer available on connection')
+    const viewer = assertEx(this.connectionInstance.viewer, () => 'No viewer available on connection')
 
     // Resolve transaction options
     const {
@@ -66,13 +67,16 @@ export class SimpleXyoGatewayRunner implements XyoGatewayRunner {
     const resolvedExp = isDefined(exp) ? exp : resolvedNbf + 10
 
     // Build, sign, and broadcast the transaction
-    const tx = await buildUnsignedTransaction(resolvedChainId, onChain, offChain, resolvedNbf, resolvedExp, await this.signer.address(), fees)
+    // eslint-disable-next-line sonarjs/deprecation
+    const tx = await buildUnsignedTransaction(resolvedChainId, onChain, offChain, resolvedNbf, resolvedExp, await (await this.signer()).address(), fees)
     return await this.addTransactionToChain(tx)
   }
 
   async addTransactionToChain(tx: SignedHydratedTransaction): Promise<[Hash, SignedHydratedTransactionWithHashMeta]> {
-    const connection = this.gateway.connection
-    const signer = this.gateway.signer
+    // eslint-disable-next-line sonarjs/deprecation
+    const connection = await this.gateway.connection()
+    // eslint-disable-next-line sonarjs/deprecation
+    const signer = await this.gateway.signer()
     const runner = assertEx(connection.runner, () => 'No runner available on connection')
     const signedTx = await signer.signTransaction(tx)
     await this.addPayloadsToDataLakes(signedTx[1])
@@ -82,6 +86,10 @@ export class SimpleXyoGatewayRunner implements XyoGatewayRunner {
     ), signedTx]
   }
 
+  connection(): Promisable<XyoConnection> {
+    throw new Error('Method not implemented.')
+  }
+
   removeDataLake(index: number): void {
     this._dataLakes[index] = null
   }
@@ -91,7 +99,8 @@ export class SimpleXyoGatewayRunner implements XyoGatewayRunner {
   }
 
   async sendMany(transfers: Record<Address, AttoXL1>, options?: TransactionOptions): Promise<Hash> {
-    const from = await this.signer.address()
+    // eslint-disable-next-line sonarjs/deprecation
+    const from = await (await this.signer()).address()
     const hexTransfers: Record<Address, Hex> = Object.fromEntries(
       Object.entries(transfers).map(([address, amount]) => ([
         address, BigIntToJsonZod.parse(amount),
@@ -106,6 +115,12 @@ export class SimpleXyoGatewayRunner implements XyoGatewayRunner {
     return hash
   }
 
+  /** @deprecated use signerInstance instead */
+  signer(): Promisable<XyoSigner> {
+    // eslint-disable-next-line sonarjs/deprecation
+    return this.gateway.signer()
+  }
+
   protected async addPayloadsToDataLakes(payloads: WithHashMeta<Payload>[]): Promise<void> {
     await Promise.all(this._dataLakes.map(async (dataLake) => {
       await Promise.all(payloads.map(async (payload) => {

package/dist/neutral/interfaces/viewers/Stake.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Stake.d.ts","sourceRoot":"","sources":["../../../../src/interfaces/viewers/Stake.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAA;AAE3D,MAAM,MAAM,QAAQ,GAAG;IAErB,QAAQ,EAAE,MAAM,CAAA;IAEhB,MAAM,EAAE,MAAM,CAAA;IAEd,EAAE,EAAE,UAAU,CAAA;IAEd,WAAW,EAAE,MAAM,CAAA;IAEnB,MAAM,EAAE,OAAO,CAAA;IAEf,MAAM,EAAE,OAAO,CAAA;IAEf,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,yCAAyC;AACzC,MAAM,MAAM,KAAK,GAAG,QAAQ,CAAA"}

package/dist/neutral/services/Chain/interfaces/ChainContractViewer.d.ts

@@ -1,4 +0,0 @@
-import type { ChainContractViewInterface } from '../../../interfaces/index.ts';
-export interface ChainContractViewer extends ChainContractViewInterface {
-}
-//# sourceMappingURL=ChainContractViewer.d.ts.map

package/dist/neutral/services/Chain/interfaces/ChainContractViewer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ChainContractViewer.d.ts","sourceRoot":"","sources":["../../../../../src/services/Chain/interfaces/ChainContractViewer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAA;AAE9E,MAAM,WAAW,mBAAoB,SAAQ,0BAA0B;CAEtE"}

package/src/services/Chain/interfaces/ChainContractViewer.ts

@@ -1,5 +0,0 @@
-import type { ChainContractViewInterface } from '../../../interfaces/index.ts'
-
-export interface ChainContractViewer extends ChainContractViewInterface {
-
-}