@xyo-network/xl1-rpc 1.2.4 → 1.2.6

package/dist/types/provider/viewer/NodeXyoViewer.d.ts

@@ -1,68 +0,0 @@
-import { type Address, type Hash } from '@xylabs/hex';
-import type { ArchivistInstance } from '@xyo-network/archivist-model';
-import type { ModuleIdentifier } from '@xyo-network/module-model';
-import type { NodeInstance } from '@xyo-network/node-model';
-import { type SignedHydratedBlock, type SignedHydratedTransaction, type XyoViewer } from '@xyo-network/xl1-model';
-export declare class NodeXyoViewer implements XyoViewer {
-    protected readonly finalizedArchivistPath: ModuleIdentifier;
-    protected readonly headValidationDivinerPath: ModuleIdentifier;
-    protected readonly node: NodeInstance;
-    private _chainId;
-    private _finalizedArchivist;
-    constructor(node: NodeInstance);
-    accountBalance(address: Address, blockNumber: number, full: boolean): Promise<bigint>;
-    blockByHash(hash: Hash): Promise<SignedHydratedBlock | null>;
-    blockByNumber(blockNumber: number): Promise<SignedHydratedBlock | null>;
-    blocksByHash(hash: Hash, limit?: number): Promise<SignedHydratedBlock[]>;
-    chainId(): Promise<Address>;
-    currentBlock(): Promise<SignedHydratedBlock>;
-    currentBlockHash(): Promise<Hash>;
-    currentBlockNumber(): Promise<number>;
-    transactionByBlockHashAndIndex(blockHash: Hash, transactionIndex?: number): Promise<SignedHydratedTransaction | null>;
-    transactionByBlockNumberAndIndex(blockNumber: number, transactionIndex?: number): Promise<SignedHydratedTransaction | null>;
-    transactionByHash(transactionHash: Hash): Promise<SignedHydratedTransaction | null>;
-    protected getArchivist: (identifier: ModuleIdentifier) => Promise<ArchivistInstance<import("@xylabs/base").BaseParamsFields & {
-        account?: import("@xyo-network/account-model").AccountInstance | "random";
-        addToResolvers?: boolean;
-        additionalSigners?: import("@xyo-network/account-model").AccountInstance[];
-        allowNameResolution?: boolean;
-        config: import("@xyo-network/module-model").AnyConfigSchema<import("@xyo-network/archivist-model").ArchivistConfig>;
-        ephemeralQueryAccountEnabled?: boolean;
-        moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[];
-        privateChildren?: import("@xyo-network/module-model").ModuleInstance[];
-        publicChildren?: import("@xyo-network/module-model").ModuleInstance[];
-    } & import("@xyo-network/archivist-model").ArchivistParamFields & object, import("@xyo-network/archivist-model").ArchivistModuleEventData, import("@xyo-network/payload-model").Payload<void, void>>>;
-    protected getDiviner: (identifier: ModuleIdentifier) => Promise<import("@xyo-network/diviner-model").DivinerInstance<import("@xylabs/base").BaseParamsFields & {
-        account?: import("@xyo-network/account-model").AccountInstance | "random";
-        addToResolvers?: boolean;
-        additionalSigners?: import("@xyo-network/account-model").AccountInstance[];
-        allowNameResolution?: boolean;
-        config: import("@xyo-network/module-model").AnyConfigSchema<import("@xyo-network/diviner-model").DivinerConfig>;
-        ephemeralQueryAccountEnabled?: boolean;
-        moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[];
-        privateChildren?: import("@xyo-network/module-model").ModuleInstance[];
-        publicChildren?: import("@xyo-network/module-model").ModuleInstance[];
-    }, import("@xyo-network/payload-model").Payload<void, void>, import("@xyo-network/payload-model").Payload<void, void>, import("@xyo-network/diviner-model").DivinerModuleEventData<import("@xyo-network/module-model").ModuleInstance<import("@xylabs/base").BaseParamsFields & {
-        account?: import("@xyo-network/account-model").AccountInstance | "random";
-        addToResolvers?: boolean;
-        additionalSigners?: import("@xyo-network/account-model").AccountInstance[];
-        allowNameResolution?: boolean;
-        config: import("@xyo-network/module-model").AnyConfigSchema<import("@xyo-network/module-model").ModuleConfig>;
-        ephemeralQueryAccountEnabled?: boolean;
-        moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[];
-        privateChildren?: import("@xyo-network/module-model").ModuleInstance[];
-        publicChildren?: import("@xyo-network/module-model").ModuleInstance[];
-    }, import("@xyo-network/module-model").ModuleEventData<object>>, import("@xyo-network/payload-model").Payload, import("@xyo-network/payload-model").Payload>>>;
-    protected getFinalizedArchivist: () => Promise<ArchivistInstance<import("@xylabs/base").BaseParamsFields & {
-        account?: import("@xyo-network/account-model").AccountInstance | "random";
-        addToResolvers?: boolean;
-        additionalSigners?: import("@xyo-network/account-model").AccountInstance[];
-        allowNameResolution?: boolean;
-        config: import("@xyo-network/module-model").AnyConfigSchema<import("@xyo-network/archivist-model").ArchivistConfig>;
-        ephemeralQueryAccountEnabled?: boolean;
-        moduleIdentifierTransformers?: import("@xyo-network/module-model").ModuleIdentifierTransformer[];
-        privateChildren?: import("@xyo-network/module-model").ModuleInstance[];
-        publicChildren?: import("@xyo-network/module-model").ModuleInstance[];
-    } & import("@xyo-network/archivist-model").ArchivistParamFields & object, import("@xyo-network/archivist-model").ArchivistModuleEventData, import("@xyo-network/payload-model").Payload>>;
-}
-//# sourceMappingURL=NodeXyoViewer.d.ts.map

package/dist/types/provider/viewer/NodeXyoViewer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"NodeXyoViewer.d.ts","sourceRoot":"","sources":["../../../../src/provider/viewer/NodeXyoViewer.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,OAAO,EAAE,KAAK,IAAI,EAAE,MAAM,aAAa,CAAA;AAErD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AAOrE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAA;AACjE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAA;AAE3D,OAAO,EACiH,KAAK,mBAAmB,EAC9I,KAAK,yBAAyB,EAAE,KAAK,SAAS,EAC/C,MAAM,wBAAwB,CAAA;AAK/B,qBAAa,aAAc,YAAW,SAAS;IAE7C,SAAS,CAAC,QAAQ,CAAC,sBAAsB,EAAE,gBAAgB,CAA6B;IACxF,SAAS,CAAC,QAAQ,CAAC,yBAAyB,EAAE,gBAAgB,CAAyC;IACvG,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAA;IAErC,OAAO,CAAC,QAAQ,CAAqB;IACrC,OAAO,CAAC,mBAAmB,CAA+B;gBAE9C,IAAI,EAAE,YAAY;IAIxB,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO;IAgBnE,WAAW,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;IAK5D,aAAa,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC;IAmBvE,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,GAAE,MAAW,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAc5E,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC;IAS3B,YAAY,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAK5C,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAMjC,kBAAkB,IAAI,OAAO,CAAC,MAAM,CAAC;IAMrC,8BAA8B,CAAC,SAAS,EAAE,IAAI,EAAE,gBAAgB,GAAE,MAAU,GAAG,OAAO,CAAC,yBAAyB,GAAG,IAAI,CAAC;IAiBxH,gCAAgC,CAAC,WAAW,EAAE,MAAM,EAAE,gBAAgB,GAAE,MAAU,GAAG,OAAO,CAAC,yBAAyB,GAAG,IAAI,CAAC;IAU9H,iBAAiB,CAAC,eAAe,EAAE,IAAI,GAAG,OAAO,CAAC,yBAAyB,GAAG,IAAI,CAAC;IASzF,SAAS,CAAC,YAAY,GAAU,YAAY,gBAAgB;;;;;;;;;;0MAG3D;IAED,SAAS,CAAC,UAAU,GAAU,YAAY,gBAAgB;;;;;;;;;;;;;;;;;;;;mKAGzD;IAED,SAAS,CAAC,qBAAqB;;;;;;;;;;8LAI9B;CACF"}

package/src/provider/viewer/NodeXyoViewer.ts

@@ -1,168 +0,0 @@
-import { filterAs } from '@xylabs/array'
-import { assertEx } from '@xylabs/assert'
-import { exists } from '@xylabs/exists'
-import { type Address, type Hash } from '@xylabs/hex'
-import { hexToBigInt } from '@xylabs/hex'
-import type { ArchivistInstance } from '@xyo-network/archivist-model'
-import { asArchivistInstance } from '@xyo-network/archivist-model'
-import { BoundWitnessSchema, type Signed } from '@xyo-network/boundwitness-model'
-import {
-  analyzeChain, BalanceAnalyzer, findMostRecentBlock, hydrateBlock, hydrateTransaction, isChainSummaryBalances,
-} from '@xyo-network/chain-protocol'
-import { asDivinerInstance } from '@xyo-network/diviner-model'
-import type { ModuleIdentifier } from '@xyo-network/module-model'
-import type { NodeInstance } from '@xyo-network/node-model'
-import type { WithStorageMeta } from '@xyo-network/payload-model'
-import {
-  asOptionalBlockBoundWitnessWithStorageMeta, asOptionalTransactionBoundWitnessWithStorageMeta, type BlockBoundWitness, type SignedHydratedBlock,
-  type SignedHydratedTransaction, type XyoViewer,
-} from '@xyo-network/xl1-model'
-
-const WindowLimit = 1000
-const WindowLimitBigInt = BigInt(WindowLimit)
-
-export class NodeXyoViewer implements XyoViewer {
-  // TODO: Make configurable with defaults
-  protected readonly finalizedArchivistPath: ModuleIdentifier = 'XYOChain:Chain:Finalized'
-  protected readonly headValidationDivinerPath: ModuleIdentifier = 'XYOChain:Chain:HeadValidationDiviner'
-  protected readonly node: NodeInstance
-
-  private _chainId: Address | undefined
-  private _finalizedArchivist: ArchivistInstance | undefined
-
-  constructor(node: NodeInstance) {
-    this.node = node
-  }
-
-  async accountBalance(address: Address, blockNumber: number, full: boolean) {
-    const head = await this.blockByNumber(blockNumber)
-    if (!head) {
-      throw new Error(`Error: Could not find block ${blockNumber}`)
-    }
-    const analysis = await analyzeChain(
-      await this.getFinalizedArchivist(),
-      [new BalanceAnalyzer()],
-      head,
-      null,
-      full ? -1n : WindowLimitBigInt,
-    )
-    const balances = assertEx(analysis.find(isChainSummaryBalances)?.balances, () => 'Failed to sync balances')
-    return balances[address] ? hexToBigInt(balances[address]) : 0n
-  }
-
-  async blockByHash(hash: Hash): Promise<SignedHydratedBlock | null> {
-    const finalizedArchivist = await this.getFinalizedArchivist()
-    return await hydrateBlock(finalizedArchivist, hash)
-  }
-
-  async blockByNumber(blockNumber: number): Promise<SignedHydratedBlock | null> {
-    const finalizedArchivist = await this.getFinalizedArchivist()
-    const result = await this.currentBlock()
-    let currentBlock: WithStorageMeta<Signed<BlockBoundWitness>> = result[0]
-    if (currentBlock.block === blockNumber) return result
-    if (blockNumber > currentBlock.block) throw new Error(`Error: Block number ${blockNumber} is greater than current block number ${currentBlock.block}`)
-    if (blockNumber < 0) throw new Error(`Error: Block number ${blockNumber} is less than 0`)
-    if (blockNumber - currentBlock.block > WindowLimit) throw new Error(`Error: Block number ${blockNumber} is too far in the past`)
-    do {
-      const { previous } = currentBlock
-      if (previous === null) return null
-      const nextBlock = asOptionalBlockBoundWitnessWithStorageMeta((await finalizedArchivist.get([previous]))[0])
-      if (!nextBlock) return null
-      currentBlock = nextBlock
-    }
-    while (blockNumber != currentBlock.block)
-    return currentBlock.block === blockNumber ? await hydrateBlock(finalizedArchivist, currentBlock._hash) : null
-  }
-
-  async blocksByHash(hash: Hash, limit: number = 10): Promise<SignedHydratedBlock[]> {
-    assertEx(limit > 0, () => 'Error: limit must be greater than 0')
-    assertEx(limit <= 100, () => 'Error: limit must be less than 100')
-    const blocks: SignedHydratedBlock[] = []
-    let current = await this.blockByHash(hash)
-    while (current && blocks.length < limit) {
-      blocks.push(current)
-      const previousHash = current[0].previous
-      if (!previousHash) break
-      current = await this.blockByHash(previousHash)
-    }
-    return blocks
-  }
-
-  async chainId(): Promise<Address> {
-    if (this._chainId) return this._chainId
-    const finalizedArchivist = await this.getFinalizedArchivist()
-    const block = await findMostRecentBlock(finalizedArchivist)
-    if (!block) throw new Error('Error: Could not find most recent block')
-    this._chainId = block.chain
-    return await Promise.resolve(this._chainId)
-  }
-
-  async currentBlock(): Promise<SignedHydratedBlock> {
-    const finalizedArchivist = await this.getFinalizedArchivist()
-    return await hydrateBlock(finalizedArchivist, await this.currentBlockHash())
-  }
-
-  async currentBlockHash(): Promise<Hash> {
-    const finalizedArchivist = await this.getFinalizedArchivist()
-    const block = assertEx(await findMostRecentBlock(finalizedArchivist), () => 'Error: Could not find most recent block')
-    return block._hash
-  }
-
-  async currentBlockNumber(): Promise<number> {
-    const finalizedArchivist = await this.getFinalizedArchivist()
-    const block = assertEx(await findMostRecentBlock(finalizedArchivist), () => 'Error: Could not find most recent block')
-    return block.block
-  }
-
-  async transactionByBlockHashAndIndex(blockHash: Hash, transactionIndex: number = 0): Promise<SignedHydratedTransaction | null> {
-    assertEx(transactionIndex >= 0, () => 'Error: transactionIndex must be greater than or equal to 0')
-    try {
-      const block = await this.blockByHash(blockHash)
-      if (!block) return null
-      const blockBoundWitnessIndexes = block[0].payload_schemas.map((schema, index) => schema === BoundWitnessSchema ? index : undefined).filter(exists)
-      const blockBoundWitnessHashes = new Set(blockBoundWitnessIndexes.map(index => block[0].payload_hashes[index]))
-      const blockBoundWitnesses = block[1].filter(payload => blockBoundWitnessHashes.has(payload._hash) || blockBoundWitnessHashes.has(payload._dataHash))
-      const blockTransactionBoundWitnesses = filterAs(blockBoundWitnesses, asOptionalTransactionBoundWitnessWithStorageMeta)
-      const transaction = blockTransactionBoundWitnesses.at(transactionIndex)
-      if (!transaction) return null
-      return await this.transactionByHash(transaction._hash)
-    } catch {
-      return null
-    }
-  }
-
-  async transactionByBlockNumberAndIndex(blockNumber: number, transactionIndex: number = 0): Promise<SignedHydratedTransaction | null> {
-    try {
-      const block = await this.blockByNumber(blockNumber)
-      if (!block) return null
-      return await this.transactionByBlockHashAndIndex(block[0]._hash, transactionIndex)
-    } catch {
-      return null
-    }
-  }
-
-  async transactionByHash(transactionHash: Hash): Promise<SignedHydratedTransaction | null> {
-    try {
-      const finalizedArchivist = await this.getFinalizedArchivist()
-      return await hydrateTransaction(finalizedArchivist, transactionHash)
-    } catch {
-      return null
-    }
-  }
-
-  protected getArchivist = async (identifier: ModuleIdentifier) => {
-    const diviner = await this.node.resolve(identifier)
-    return assertEx(asArchivistInstance(diviner), () => `Error: Could not resolve ${identifier} to an archivist instance`)
-  }
-
-  protected getDiviner = async (identifier: ModuleIdentifier) => {
-    const diviner = await this.node.resolve(identifier)
-    return assertEx(asDivinerInstance(diviner), () => `Error: Could not resolve ${identifier} to a diviner instance`)
-  }
-
-  protected getFinalizedArchivist = async () => {
-    if (this._finalizedArchivist) return this._finalizedArchivist
-    this._finalizedArchivist = await this.getArchivist(this.finalizedArchivistPath)
-    return this._finalizedArchivist
-  }
-}