@xyo-network/xl1-protocol 1.3.8 → 1.3.9

package/src/validation/boundwitness/index.ts

@@ -0,0 +1,2 @@
+export * from './BoundWitnessValidationFunction.ts'
+export * from './HydratedBoundWitnessValidationFunction.ts'

package/src/validation/index.ts

@@ -0,0 +1,4 @@
+export * from './block/index.ts'
+export * from './boundwitness/index.ts'
+export * from './payload/index.ts'
+export * from './transaction/index.ts'

package/src/validation/payload/InBlockPayloadValidationFunction.ts

@@ -0,0 +1,8 @@
+import type { Promisable } from '@xylabs/promise'
+import type { Payload, WithHashStorageMeta } from '@xyo-network/payload-model'
+
+import type { HydratedBlock } from '../../protocol/index.ts'
+
+export type InBlockPayloadValidationFunction = (
+  payload: WithHashStorageMeta<Payload>, block: HydratedBlock
+) => Promisable<Error[]>

package/src/validation/payload/index.ts

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

package/src/validation/transaction/HydratedTransactionStateValidationFunction.ts

@@ -0,0 +1,18 @@
+import type { Address } from '@xylabs/hex'
+import type { Promisable } from '@xylabs/promise'
+import type { HydratedBoundWitnessWithStorageMeta, ReadArchivist } from '@xyo-network/archivist-model'
+
+import type { TransactionBoundWitness } from '../../protocol/index.ts'
+
+/**
+ * A function that validates a hydrated transaction against chain state.
+ * @param hydratedTransaction The hydrated transaction to validate.
+ * @param chainId The chain ID to use for validation.
+ * @param archivist The archivist to use for validation.
+ * @returns An array of errors if the transaction is invalid, or an empty array if it is valid.
+ */
+export type HydratedTransactionStateValidationFunction<T extends TransactionBoundWitness = TransactionBoundWitness> = (
+  hydratedTransaction: HydratedBoundWitnessWithStorageMeta<T>,
+  chainId: Address,
+  archivist: ReadArchivist,
+) => Promisable<Error[]>

package/src/validation/transaction/HydratedTransactionValidationFunction.ts

@@ -0,0 +1,16 @@
+import type { Address } from '@xylabs/hex'
+import type { Promisable } from '@xylabs/promise'
+
+import type { HydratedTransaction, HydratedTransactionWithHashStorageMeta } from '../../protocol/HydratedTransaction.ts'
+import type { TransactionBoundWitness } from '../../protocol/TransactionBoundWitness.ts'
+
+/**
+ * A function that validates a hydrated transaction.
+ * @param bw The hydrated transaction to validate.
+ * @param chainId The chain ID to use for validation.
+ * @returns An array of errors if the transaction is invalid, or an empty array if it is valid.
+ */
+export type HydratedTransactionValidatorFunction<T extends TransactionBoundWitness = TransactionBoundWitness> = (
+  hydratedTransaction: HydratedTransactionWithHashStorageMeta<HydratedTransaction<T>>,
+  chainId?: Address,
+) => Promisable<Error[]>

package/src/validation/transaction/index.ts

@@ -0,0 +1,2 @@
+export * from './HydratedTransactionStateValidationFunction.ts'
+export * from './HydratedTransactionValidationFunction.ts'

package/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "entryPoints": ["src/index.ts"],
+  "tsconfig": "./tsconfig.typedoc.json"
+}

package/vite.config.ts

@@ -0,0 +1,30 @@
+import { config } from 'dotenv'
+import { defineConfig } from 'vite'
+import topLevelAwait from 'vite-plugin-top-level-await'
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const TopLevelAwaitPlugin = topLevelAwait as any
+
+config()
+
+const parsedPort = Number.parseInt(process.env.PORT ?? '')
+const port = Number.isNaN(parsedPort) ? 3000 : parsedPort
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  base: '/',
+  build: { target: 'esnext' },
+  // @bitauth/libauth does not have top level awaits that SB does not like
+  optimizeDeps: { exclude: ['@bitauth/libauth'] },
+  plugins: [{
+    ...TopLevelAwaitPlugin({
+      // The export name of top-level await promise for each chunk module
+      promiseExportName: '__tla',
+      // The function to generate import names of top-level await promise in each chunk module
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      promiseImportName: (i: any) => `__tla_${i}`,
+    }),
+    apply: 'serve',
+  }],
+  server: { port, sourcemapIgnoreList: () => true },
+})

package/vitest.config.ts

@@ -0,0 +1,14 @@
+import dotenv from 'dotenv'
+import tsconfigPaths from 'vite-tsconfig-paths'
+import { defineConfig } from 'vitest/config'
+
+dotenv.config()
+
+export default defineConfig({
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  plugins: [(tsconfigPaths as any)()],
+  test: {
+    globals: false,
+    watch: false,
+  },
+})

package/vitest.teardown.ts

@@ -0,0 +1,10 @@
+export default function globalTeardown() {
+  console.log('Stopping Ganache CLI...')
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const ganacheProcess = (globalThis as any).__GANACHE_PROCESS__
+  if (ganacheProcess) {
+    ganacheProcess.kill('SIGTERM')
+    console.log('Ganache CLI stopped.')
+  }
+}

package/vitest.workspace.ts

@@ -0,0 +1,5 @@
+import { defineWorkspace } from 'vitest/config'
+
+export default defineWorkspace([
+  './vitest.config.ts',
+])

package/xy.config.ts

@@ -2,8 +2,8 @@ import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
 const config: XyTsupConfig = {
   compile: {
     browser: {},
-    node: {},
-    neutral: { src: true },
+    neutral: { src: { entry: ['src/index.ts', 'src/cli/index.ts'] } },
+    node: { src: { entry: ['src/index.ts', 'src/cli/index.ts'] } },
   },
 }
 

package/dist/types/transaction/buildTransaction.d.ts

@@ -1,7 +0,0 @@
-import type { Address } from '@xylabs/hex';
-import type { AccountInstance } from '@xyo-network/account-model';
-import type { Payload } from '@xyo-network/payload-model';
-import type { AllowedBlockPayload, HydratedTransactionWithStorageMeta, TransactionFeesBigInt } from '@xyo-network/xl1-model';
-export declare const defaultFees: TransactionFeesBigInt;
-export declare function buildTransaction(chain: Address, elevatedPayloads: AllowedBlockPayload[], additionalPayloads: Payload[], signer: AccountInstance | AccountInstance[], nbf: number, exp: number, from?: Address, fees?: TransactionFeesBigInt): Promise<HydratedTransactionWithStorageMeta>;
-//# sourceMappingURL=buildTransaction.d.ts.map

package/dist/types/transaction/buildTransaction.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"buildTransaction.d.ts","sourceRoot":"","sources":["../../../src/transaction/buildTransaction.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAE1C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAGjE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,KAAK,EACV,mBAAmB,EACnB,kCAAkC,EAA0D,qBAAqB,EAClH,MAAM,wBAAwB,CAAA;AAE/B,eAAO,MAAM,WAAW,EAAE,qBAEzB,CAAA;AAED,wBAAsB,gBAAgB,CACpC,KAAK,EAAE,OAAO,EACd,gBAAgB,EAAE,mBAAmB,EAAE,EACvC,kBAAkB,EAAE,OAAO,EAAE,EAC7B,MAAM,EAAE,eAAe,GAAG,eAAe,EAAE,EAC3C,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,EACX,IAAI,CAAC,EAAE,OAAO,EACd,IAAI,GAAE,qBAAmC,GACxC,OAAO,CAAC,kCAAkC,CAAC,CAmC7C"}

package/dist/types/transaction/hydrateTransaction.d.ts

@@ -1,11 +0,0 @@
-import type { Hash } from '@xylabs/hex';
-import type { ReadArchivist } from '@xyo-network/archivist-model';
-import type { Payload } from '@xyo-network/payload-model';
-import type { HydratedTransaction, HydratedTransactionWithStorageMeta } from '@xyo-network/xl1-model';
-export declare const tryHydrateTransaction: (archivist: ReadArchivist, hash: Hash) => Promise<HydratedTransactionWithStorageMeta | undefined>;
-export declare const hydrateTransaction: (archivist: ReadArchivist, hash: Hash) => Promise<HydratedTransactionWithStorageMeta>;
-export declare const flattenHydratedTransaction: (hydratedTransaction: HydratedTransaction) => Payload[];
-export declare const flattenHydratedTransactions: (hydratedTransactions: HydratedTransaction[]) => Payload[];
-export declare const tryHydrateElevatedTransaction: (archivist: ReadArchivist, hash: Hash) => Promise<HydratedTransaction | undefined>;
-export declare const hydrateElevatedTransaction: (archivist: ReadArchivist, hash: Hash) => Promise<HydratedTransaction>;
-//# sourceMappingURL=hydrateTransaction.d.ts.map

package/dist/types/transaction/hydrateTransaction.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"hydrateTransaction.d.ts","sourceRoot":"","sources":["../../../src/transaction/hydrateTransaction.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,aAAa,CAAA;AACvC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAA;AAEjE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,KAAK,EAEV,mBAAmB,EAAE,kCAAkC,EACxD,MAAM,wBAAwB,CAAA;AAG/B,eAAO,MAAM,qBAAqB,GAChC,WAAW,aAAa,EACxB,MAAM,IAAI,KACT,OAAO,CAAC,kCAAkC,GAAG,SAAS,CAMxD,CAAA;AAED,eAAO,MAAM,kBAAkB,GAC7B,WAAW,aAAa,EACxB,MAAM,IAAI,KACT,OAAO,CAAC,kCAAkC,CAM5C,CAAA;AAED,eAAO,MAAM,0BAA0B,GAAI,qBAAqB,mBAAmB,KAAG,OAAO,EAG5F,CAAA;AAED,eAAO,MAAM,2BAA2B,GAAI,sBAAsB,mBAAmB,EAAE,KAAG,OAAO,EAC7B,CAAA;AAEpE,eAAO,MAAM,6BAA6B,GACxC,WAAW,aAAa,EACxB,MAAM,IAAI,KACT,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAqBzC,CAAA;AAED,eAAO,MAAM,0BAA0B,GACrC,WAAW,aAAa,EACxB,MAAM,IAAI,KACT,OAAO,CAAC,mBAAmB,CAE7B,CAAA"}

package/dist/types/transaction/index.d.ts

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

package/dist/types/transaction/index.d.ts.map

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

package/src/transaction/buildTransaction.ts

@@ -1,61 +0,0 @@
-import { assertEx } from '@xylabs/assert'
-import type { Address } from '@xylabs/hex'
-import { toHex } from '@xylabs/hex'
-import type { AccountInstance } from '@xyo-network/account-model'
-import { BoundWitnessBuilder } from '@xyo-network/boundwitness-builder'
-import { PayloadBuilder } from '@xyo-network/payload-builder'
-import type { Payload } from '@xyo-network/payload-model'
-import type {
-  AllowedBlockPayload,
-  HydratedTransactionWithStorageMeta, TransactionBoundWitness, TransactionBoundWitnessFields, TransactionFeesBigInt,
-} from '@xyo-network/xl1-model'
-
-export const defaultFees: TransactionFeesBigInt = {
-  base: 1000n, gasPrice: 100n, gasLimit: 1_000_000n, priority: 0n,
-}
-
-export async function buildTransaction(
-  chain: Address,
-  elevatedPayloads: AllowedBlockPayload[],
-  additionalPayloads: Payload[],
-  signer: AccountInstance | AccountInstance[],
-  nbf: number,
-  exp: number,
-  from?: Address,
-  fees: TransactionFeesBigInt = defaultFees,
-): Promise<HydratedTransactionWithStorageMeta> {
-  if (from === undefined && Array.isArray(signer)) {
-    throw new Error('from is required when signer is an array')
-  }
-
-  const txBoundWitnessFields: TransactionBoundWitnessFields = {
-    chain,
-    fees: {
-      base: toHex(fees.base),
-      gasLimit: toHex(fees.gasLimit),
-      gasPrice: toHex(fees.gasPrice),
-      priority: toHex(fees.priority),
-    },
-    nbf,
-    exp,
-  }
-
-  const elevatedHashes = await PayloadBuilder.hashes(elevatedPayloads)
-  const script: string[] = []
-  for (const elevatedHash of elevatedHashes) {
-    script.push(`elevate|${elevatedHash}`)
-  }
-
-  const [tx, txPayloads] = await new BoundWitnessBuilder<TransactionBoundWitness>()
-    .fields({
-      ...txBoundWitnessFields,
-      script,
-      from: from ?? (Array.isArray(signer) ? assertEx(signer.at(0)?.address) : signer.address),
-    })
-    .meta({ $signatures: [] })
-    .payloads([...elevatedPayloads, ...additionalPayloads])
-    .signers(Array.isArray(signer) ? signer : [signer])
-    .build()
-
-  return [await PayloadBuilder.addStorageMeta(tx), await PayloadBuilder.addStorageMeta(txPayloads)]
-}

package/src/transaction/hydrateTransaction.ts

@@ -1,73 +0,0 @@
-import { assertEx } from '@xylabs/assert'
-import type { Hash } from '@xylabs/hex'
-import type { ReadArchivist } from '@xyo-network/archivist-model'
-import { hydrateTypedBoundWitness, tryHydrateTypedBoundWitness } from '@xyo-network/archivist-model'
-import type { Payload } from '@xyo-network/payload-model'
-import type {
-  AllowedBlockPayload,
-  HydratedTransaction, HydratedTransactionWithStorageMeta, TransactionBoundWitness,
-} from '@xyo-network/xl1-model'
-import { isAllowedBlockPayload, isTransactionBoundWitnessWithStorageMeta } from '@xyo-network/xl1-model'
-
-export const tryHydrateTransaction = async (
-  archivist: ReadArchivist,
-  hash: Hash,
-): Promise<HydratedTransactionWithStorageMeta | undefined> => {
-  return (await tryHydrateTypedBoundWitness<TransactionBoundWitness>(
-    archivist,
-    hash,
-    isTransactionBoundWitnessWithStorageMeta,
-  )) as HydratedTransactionWithStorageMeta | undefined
-}
-
-export const hydrateTransaction = async (
-  archivist: ReadArchivist,
-  hash: Hash,
-): Promise<HydratedTransactionWithStorageMeta> => {
-  return await hydrateTypedBoundWitness<TransactionBoundWitness>(
-    archivist,
-    hash,
-    isTransactionBoundWitnessWithStorageMeta,
-  ) as HydratedTransactionWithStorageMeta
-}
-
-export const flattenHydratedTransaction = (hydratedTransaction: HydratedTransaction): Payload[] => {
-  const [tx, txPayloads] = hydratedTransaction
-  return [...txPayloads, tx]
-}
-
-export const flattenHydratedTransactions = (hydratedTransactions: HydratedTransaction[]): Payload[] =>
-  hydratedTransactions.flatMap(tx => flattenHydratedTransaction(tx))
-
-export const tryHydrateElevatedTransaction = async (
-  archivist: ReadArchivist,
-  hash: Hash,
-): Promise<HydratedTransaction | undefined> => {
-  const hydratedTransaction = await tryHydrateTransaction(archivist, hash)
-  if (!hydratedTransaction) {
-    return undefined
-  }
-  const [transaction, payloads] = hydratedTransaction
-  const opCodes = (transaction.script ?? []).filter(operation => operation.startsWith('elevate|'))
-  const elevatedPayloads: 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 [transaction, elevatedPayloads]
-  }
-  return undefined
-}
-
-export const hydrateElevatedTransaction = async (
-  archivist: ReadArchivist,
-  hash: Hash,
-): Promise<HydratedTransaction> => {
-  return assertEx(await tryHydrateElevatedTransaction(archivist, hash), () => 'Hydration failed')
-}

package/src/transaction/index.ts

@@ -1,2 +0,0 @@
-export * from './buildTransaction.ts'
-export * from './hydrateTransaction.ts'