@xyo-network/xl1-rpc 1.8.1 → 1.8.3

package/dist/node/transport/post-message/helpers.d.ts

@@ -1,11 +1,14 @@
 import type { JsonRpcRequest } from '@metamask/utils';
 import type { JsonObject } from '@xylabs/object';
+/** @deprecated - no longer part of the public rpc implementation */
 export type JsonRpcRequestWithId = JsonRpcRequest & {
     id: string;
 };
+/** @deprecated - no longer part of the public rpc implementation */
 export interface RpcError extends JsonObject {
     error: boolean;
     message: string;
 }
+/** @deprecated - no longer part of the public rpc implementation */
 export declare const isRpcError: (data: any) => data is RpcError;
 //# sourceMappingURL=helpers.d.ts.map

package/dist/node/transport/post-message/helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../../src/transport/post-message/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAEhD,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAClD,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAED,MAAM,WAAW,QAAS,SAAQ,UAAU;IAC1C,KAAK,EAAE,OAAO,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;CAChB;AAGD,eAAO,MAAM,UAAU,GAAI,MAAM,GAAG,KAAG,IAAI,IAAI,QAO9C,CAAA"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../../src/transport/post-message/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAEhD,oEAAoE;AACpE,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG;IAClD,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAED,oEAAoE;AACpE,MAAM,WAAW,QAAS,SAAQ,UAAU;IAC1C,KAAK,EAAE,OAAO,CAAA;IACd,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,oEAAoE;AAEpE,eAAO,MAAM,UAAU,GAAI,MAAM,GAAG,KAAG,IAAI,IAAI,QAO9C,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json.schemastore.org/package.json",
   "name": "@xyo-network/xl1-rpc",
-  "version": "1.8.1",
+  "version": "1.8.3",
   "description": "XYO Layer One API",
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -61,7 +61,6 @@
     "@metamask/utils": "^11.4.2",
     "@xylabs/assert": "^4.15.0",
     "@xylabs/axios": "^4.15.0",
-    "@xylabs/delay": "^4.15.0",
     "@xylabs/hex": "^4.15.0",
     "@xylabs/object": "^4.15.0",
     "@xylabs/promise": "^4.15.0",
@@ -76,8 +75,8 @@
     "@xyo-network/payload-model": "^4.3.0",
     "@xyo-network/payload-wrapper": "^4.3.0",
     "@xyo-network/xl1-protocol": "^1.7.33",
-    "@xyo-network/xl1-protocol-sdk": "^1.8.1",
-    "@xyo-network/xl1-wrappers": "^1.8.1",
+    "@xyo-network/xl1-protocol-sdk": "^1.8.3",
+    "@xyo-network/xl1-wrappers": "^1.8.3",
     "axios": "^1.11.0",
     "uuid": "^11.1.0",
     "zod": "^3.25.76"

package/src/provider/provider/HttpRpcXyoConnection.ts

@@ -0,0 +1,32 @@
+import { isDefined } from '@xylabs/typeof'
+import type { AccountInstance } from '@xyo-network/account-model'
+
+import { HttpRpcTransport } from '../../transport/index.ts'
+import { XyoRunnerRpcSchemas, XyoViewerRpcSchemas } from '../../types/index.ts'
+import { JsonRpcXyoRunner } from '../runner/index.ts'
+import { MemoryXyoSigner } from '../signer/index.ts'
+import { JsonRpcXyoViewer } from '../viewer/index.ts'
+import { XyoConnection } from './XyoConnection.ts'
+
+export interface RpcXyoProviderParams {
+  account?: AccountInstance
+  endpoint: string
+}
+
+export class HttpRpcXyoConnection extends XyoConnection {
+  constructor(params: RpcXyoProviderParams) {
+    const { account, endpoint } = params
+    const signer = isDefined(account) ? new MemoryXyoSigner(account) : undefined
+    const transport = new HttpRpcTransport(endpoint, { ...XyoRunnerRpcSchemas, ...XyoViewerRpcSchemas })
+    const runner = new JsonRpcXyoRunner(transport)
+    const viewer = new JsonRpcXyoViewer(transport)
+    super({
+      signer, runner, viewer,
+    })
+  }
+}
+
+/**
+ * @deprecated Use `HttpRpcXyoConnection` instead.
+ */
+export class RpcXyoConnection extends HttpRpcXyoConnection {}

package/src/provider/provider/index.ts

@@ -1,4 +1,2 @@
-export * from './confirmSubmittedTransaction.ts'
-export * from './confirmTransaction.ts'
-export * from './RpcXyoConnection.ts'
+export * from './HttpRpcXyoConnection.ts'
 export * from './XyoConnection.ts'

package/src/transport/post-message/PostMessageRpcTransport.ts

@@ -10,6 +10,7 @@ import type { JsonRpcRequestWithId } from './helpers.ts'
 import { isRpcError } from './helpers.ts'
 import { buildSessionMessageRequest } from './SessionEnvelope.ts'
 
+/** @deprecated - now part of a client gateway */
 export class PostMessageRpcTransport<T extends RpcSchemaMap = RpcSchemaMap> implements RpcTransport<T> {
   protected readonly destination?: string
   protected readonly schemas: T

package/src/transport/post-message/SessionEnvelope.ts

@@ -8,6 +8,7 @@ export interface SessionMessageEnvelope<T extends JsonValue> {
 }
 
 /** Only intended for web pages where the xyo global object was injected  */
+/** @deprecated - rely on the postMessageBus to handle this for you */
 export const buildSessionMessageRequest = <T extends JsonRpcRequest>(data: T, destination?: string) => {
   const request: SessionMessageEnvelope<T> = {
     data,

package/src/transport/post-message/helpers.ts

@@ -1,15 +1,18 @@
 import type { JsonRpcRequest } from '@metamask/utils'
 import type { JsonObject } from '@xylabs/object'
 
+/** @deprecated - no longer part of the public rpc implementation */
 export type JsonRpcRequestWithId = JsonRpcRequest & {
   id: string
 }
 
+/** @deprecated - no longer part of the public rpc implementation */
 export interface RpcError extends JsonObject {
   error: boolean
   message: string
 }
 
+/** @deprecated - no longer part of the public rpc implementation */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export const isRpcError = (data: any): data is RpcError => {
   return (

package/dist/neutral/provider/provider/RpcXyoConnection.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"RpcXyoConnection.d.ts","sourceRoot":"","sources":["../../../../src/provider/provider/RpcXyoConnection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAQjE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAElD,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,eAAe,CAAA;IACzB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,qBAAa,gBAAiB,SAAQ,aAAa;gBACrC,MAAM,EAAE,oBAAoB;CASzC"}

package/dist/neutral/provider/provider/confirmSubmittedTransaction.d.ts

@@ -1,21 +0,0 @@
-import type { Logger } from '@xylabs/logger';
-import type { Signed } from '@xyo-network/boundwitness-model';
-import type { HydratedTransaction, TransactionBoundWitness, XyoConnectionProvider } from '@xyo-network/xl1-protocol';
-export type ConfirmSubmittedTransactionOptions = {
-    /**
-     * Number of attempts to confirm the transaction.
-     * Defaults to 20.
-     */
-    attempts?: number;
-    /**
-     * Delay in milliseconds between confirmation attempts.
-     * Defaults to 1000 (1 second).
-     */
-    delay?: number;
-    /**
-     * Optional logger instance for logging progress.
-     */
-    logger?: Logger;
-};
-export declare const confirmSubmittedTransaction: (provider: XyoConnectionProvider, txBW: Signed<TransactionBoundWitness>, options?: ConfirmSubmittedTransactionOptions) => Promise<HydratedTransaction>;
-//# sourceMappingURL=confirmSubmittedTransaction.d.ts.map

package/dist/neutral/provider/provider/confirmSubmittedTransaction.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"confirmSubmittedTransaction.d.ts","sourceRoot":"","sources":["../../../../src/provider/provider/confirmSubmittedTransaction.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAE5C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAA;AAE7D,OAAO,KAAK,EACV,mBAAmB,EAAE,uBAAuB,EAAE,qBAAqB,EACpE,MAAM,2BAA2B,CAAA;AAKlC,MAAM,MAAM,kCAAkC,GAAG;IAC/C;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,eAAO,MAAM,2BAA2B,GACtC,UAAU,qBAAqB,EAC/B,MAAM,MAAM,CAAC,uBAAuB,CAAC,EACrC,UAAU,kCAAkC,KAC3C,OAAO,CAAC,mBAAmB,CAqB7B,CAAA"}

package/dist/neutral/provider/provider/confirmTransaction.d.ts

@@ -1,4 +0,0 @@
-import type { Signed } from '@xyo-network/boundwitness-model';
-import type { TransactionBoundWitness, XyoConnectionProvider } from '@xyo-network/xl1-protocol';
-export declare const confirmTransaction: (provider: XyoConnectionProvider, txBW: Signed<TransactionBoundWitness>, onConfirm?: (txBWHash: string) => void, onTimeout?: () => void) => Promise<void>;
-//# sourceMappingURL=confirmTransaction.d.ts.map

package/dist/neutral/provider/provider/confirmTransaction.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"confirmTransaction.d.ts","sourceRoot":"","sources":["../../../../src/provider/provider/confirmTransaction.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAA;AAE7D,OAAO,KAAK,EAAE,uBAAuB,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAA;AAK/F,eAAO,MAAM,kBAAkB,GAC7B,UAAU,qBAAqB,EAC/B,MAAM,MAAM,CAAC,uBAAuB,CAAC,EACrC,YAAY,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,EACtC,YAAY,MAAM,IAAI,kBAwBvB,CAAA"}

package/dist/node/provider/provider/RpcXyoConnection.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"RpcXyoConnection.d.ts","sourceRoot":"","sources":["../../../../src/provider/provider/RpcXyoConnection.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAQjE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAElD,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,EAAE,eAAe,CAAA;IACzB,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED,qBAAa,gBAAiB,SAAQ,aAAa;gBACrC,MAAM,EAAE,oBAAoB;CASzC"}

package/dist/node/provider/provider/confirmSubmittedTransaction.d.ts

@@ -1,21 +0,0 @@
-import type { Logger } from '@xylabs/logger';
-import type { Signed } from '@xyo-network/boundwitness-model';
-import type { HydratedTransaction, TransactionBoundWitness, XyoConnectionProvider } from '@xyo-network/xl1-protocol';
-export type ConfirmSubmittedTransactionOptions = {
-    /**
-     * Number of attempts to confirm the transaction.
-     * Defaults to 20.
-     */
-    attempts?: number;
-    /**
-     * Delay in milliseconds between confirmation attempts.
-     * Defaults to 1000 (1 second).
-     */
-    delay?: number;
-    /**
-     * Optional logger instance for logging progress.
-     */
-    logger?: Logger;
-};
-export declare const confirmSubmittedTransaction: (provider: XyoConnectionProvider, txBW: Signed<TransactionBoundWitness>, options?: ConfirmSubmittedTransactionOptions) => Promise<HydratedTransaction>;
-//# sourceMappingURL=confirmSubmittedTransaction.d.ts.map

package/dist/node/provider/provider/confirmSubmittedTransaction.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"confirmSubmittedTransaction.d.ts","sourceRoot":"","sources":["../../../../src/provider/provider/confirmSubmittedTransaction.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAE5C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAA;AAE7D,OAAO,KAAK,EACV,mBAAmB,EAAE,uBAAuB,EAAE,qBAAqB,EACpE,MAAM,2BAA2B,CAAA;AAKlC,MAAM,MAAM,kCAAkC,GAAG;IAC/C;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,eAAO,MAAM,2BAA2B,GACtC,UAAU,qBAAqB,EAC/B,MAAM,MAAM,CAAC,uBAAuB,CAAC,EACrC,UAAU,kCAAkC,KAC3C,OAAO,CAAC,mBAAmB,CAqB7B,CAAA"}

package/dist/node/provider/provider/confirmTransaction.d.ts

@@ -1,4 +0,0 @@
-import type { Signed } from '@xyo-network/boundwitness-model';
-import type { TransactionBoundWitness, XyoConnectionProvider } from '@xyo-network/xl1-protocol';
-export declare const confirmTransaction: (provider: XyoConnectionProvider, txBW: Signed<TransactionBoundWitness>, onConfirm?: (txBWHash: string) => void, onTimeout?: () => void) => Promise<void>;
-//# sourceMappingURL=confirmTransaction.d.ts.map

package/dist/node/provider/provider/confirmTransaction.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"confirmTransaction.d.ts","sourceRoot":"","sources":["../../../../src/provider/provider/confirmTransaction.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iCAAiC,CAAA;AAE7D,OAAO,KAAK,EAAE,uBAAuB,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAA;AAK/F,eAAO,MAAM,kBAAkB,GAC7B,UAAU,qBAAqB,EAC/B,MAAM,MAAM,CAAC,uBAAuB,CAAC,EACrC,YAAY,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,EACtC,YAAY,MAAM,IAAI,kBAwBvB,CAAA"}

package/src/provider/provider/RpcXyoConnection.ts

@@ -1,26 +0,0 @@
-import type { AccountInstance } from '@xyo-network/account-model'
-
-import {
-  HttpRpcTransport, XyoRunnerRpcSchemas, XyoViewerRpcSchemas,
-} from '../../index-node.ts'
-import { JsonRpcXyoRunner } from '../runner/index.ts'
-import { MemoryXyoSigner } from '../signer/index.ts'
-import { JsonRpcXyoViewer } from '../viewer/index.ts'
-import { XyoConnection } from './XyoConnection.ts'
-
-export interface RpcXyoProviderParams {
-  account?: AccountInstance
-  endpoint: string
-}
-
-export class RpcXyoConnection extends XyoConnection {
-  constructor(params: RpcXyoProviderParams) {
-    const transport = new HttpRpcTransport(params.endpoint, { ...XyoRunnerRpcSchemas, ...XyoViewerRpcSchemas })
-    const signer = params.account ? new MemoryXyoSigner(params.account) : undefined
-    const runner = new JsonRpcXyoRunner(transport)
-    const viewer = new JsonRpcXyoViewer(transport)
-    super({
-      signer, runner, viewer,
-    })
-  }
-}

package/src/provider/provider/confirmSubmittedTransaction.ts

@@ -1,55 +0,0 @@
-import { delay } from '@xylabs/delay'
-import type { Logger } from '@xylabs/logger'
-import { isDefined } from '@xylabs/typeof'
-import type { Signed } from '@xyo-network/boundwitness-model'
-import { PayloadBuilder } from '@xyo-network/payload-builder'
-import type {
-  HydratedTransaction, TransactionBoundWitness, XyoConnectionProvider,
-} from '@xyo-network/xl1-protocol'
-
-const DEFAULT_CONFIRMATION_ATTEMPTS = 20
-const DEFAULT_DELAY_BETWEEN_ATTEMPTS = 1000 // milliseconds
-
-export type ConfirmSubmittedTransactionOptions = {
-  /**
-   * Number of attempts to confirm the transaction.
-   * Defaults to 20.
-   */
-  attempts?: number
-  /**
-   * Delay in milliseconds between confirmation attempts.
-   * Defaults to 1000 (1 second).
-   */
-  delay?: number
-  /**
-   * Optional logger instance for logging progress.
-   */
-  logger?: Logger
-}
-
-export const confirmSubmittedTransaction = async (
-  provider: XyoConnectionProvider,
-  txBW: Signed<TransactionBoundWitness>,
-  options?: ConfirmSubmittedTransactionOptions,
-): Promise<HydratedTransaction> => {
-  const { attempts: maxAttempts = DEFAULT_CONFIRMATION_ATTEMPTS, delay: attemptDelay = DEFAULT_DELAY_BETWEEN_ATTEMPTS } = options || {}
-  const txBWHash = await PayloadBuilder.hash(txBW)
-  options?.logger?.log('✅ confirming transaction:', txBWHash, '\n')
-  let attempts = 0
-  while (true) {
-    const tx = await provider.viewer?.transactionByHash(txBWHash) ?? undefined
-    if (isDefined(tx)) {
-      options?.logger?.log('🍻 Transaction confirmed:', txBWHash, '\n')
-      return tx
-    } else {
-      attempts++
-      if (attempts > maxAttempts) {
-        options?.logger?.error(`⚠️ Transaction not confirmed after ${maxAttempts} attempts`)
-        throw new Error(`Transaction ${txBWHash} not confirmed after ${maxAttempts} attempts`)
-      } else {
-        options?.logger?.log(`🔄 Transaction not confirmed yet, attempt ${attempts}. Retrying...`, '\n')
-        await delay(attemptDelay)
-      }
-    }
-  }
-}

package/src/provider/provider/confirmTransaction.ts

@@ -1,37 +0,0 @@
-import { delay } from '@xylabs/delay'
-import type { Signed } from '@xyo-network/boundwitness-model'
-import { PayloadBuilder } from '@xyo-network/payload-builder'
-import type { TransactionBoundWitness, XyoConnectionProvider } from '@xyo-network/xl1-protocol'
-
-const CONFIRMATION_ATTEMPTS = 20
-const DELAY_BETWEEN_ATTEMPTS = 1000 // milliseconds
-
-export const confirmTransaction = async (
-  provider: XyoConnectionProvider,
-  txBW: Signed<TransactionBoundWitness>,
-  onConfirm?: (txBWHash: string) => void,
-  onTimeout?: () => void,
-) => {
-  const txBWHash = await PayloadBuilder.hash(txBW)
-  console.log('✅ confirming transaction:', txBWHash, '\n')
-  let confirmed = false
-  let attempts = 0
-  while (!confirmed) {
-    const tx = await provider.viewer?.transactionByHash(txBWHash)
-    if (tx) {
-      confirmed = true
-      console.log('🍻 Transaction confirmed:', txBWHash, '\n')
-      onConfirm?.(txBWHash)
-    } else {
-      attempts++
-      if (attempts > CONFIRMATION_ATTEMPTS) {
-        console.error(`⚠️ Transaction not confirmed after ${CONFIRMATION_ATTEMPTS} attempts`)
-        onTimeout?.()
-        return
-      } else {
-        console.log(`🔄 Transaction not confirmed yet, attempt ${attempts}. Retrying...`, '\n')
-        await delay(DELAY_BETWEEN_ATTEMPTS) // wait 1 second before retrying
-      }
-    }
-  }
-}