@xyo-network/xl1-rpc 1.10.0 → 1.10.1

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

@@ -0,0 +1 @@
+{"version":3,"file":"resolveData.d.ts","sourceRoot":"","sources":["../../../../src/transport/post-message/resolveData.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AAEH,KAAK,iBAAiB,GAAG;IACvB,SAAS,CAAC,EAAE,GAAG,CAAA;IACf,eAAe,CAAC,EAAE,GAAG,CAAA;CACtB,CAAA;AAcD,eAAO,MAAM,aAAa,GAAI,OAAO,YAAY,EAAE,UAAU,MAAM,KAAG,KAAK,GAAG,iBAG7E,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json.schemastore.org/package.json",
   "name": "@xyo-network/xl1-rpc",
-  "version": "1.10.0",
+  "version": "1.10.1",
   "description": "XYO Layer One API",
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -59,26 +59,26 @@
   "dependencies": {
     "@metamask/json-rpc-engine": "~10.0.3",
     "@metamask/utils": "~11.4.2",
-    "@xylabs/assert": "~5.0.2",
-    "@xylabs/axios": "~5.0.2",
-    "@xylabs/exists": "~5.0.2",
-    "@xylabs/hex": "~5.0.2",
-    "@xylabs/object": "~5.0.2",
-    "@xylabs/promise": "~5.0.2",
-    "@xylabs/typeof": "~5.0.2",
-    "@xyo-network/account-model": "~5.0.0",
-    "@xyo-network/archivist-memory": "~5.0.0",
-    "@xyo-network/archivist-model": "~5.0.0",
-    "@xyo-network/boundwitness-model": "~5.0.0",
-    "@xyo-network/hash": "~5.0.0",
-    "@xyo-network/module-model": "~5.0.0",
-    "@xyo-network/node-model": "~5.0.0",
-    "@xyo-network/payload-builder": "~5.0.0",
-    "@xyo-network/payload-model": "~5.0.0",
-    "@xyo-network/payload-wrapper": "~5.0.0",
+    "@xylabs/assert": "~5.0.3",
+    "@xylabs/axios": "~5.0.3",
+    "@xylabs/exists": "~5.0.3",
+    "@xylabs/hex": "~5.0.3",
+    "@xylabs/object": "~5.0.3",
+    "@xylabs/promise": "~5.0.3",
+    "@xylabs/typeof": "~5.0.3",
+    "@xyo-network/account-model": "~5.0.1",
+    "@xyo-network/archivist-memory": "~5.0.1",
+    "@xyo-network/archivist-model": "~5.0.1",
+    "@xyo-network/boundwitness-model": "~5.0.1",
+    "@xyo-network/hash": "~5.0.1",
+    "@xyo-network/module-model": "~5.0.1",
+    "@xyo-network/node-model": "~5.0.1",
+    "@xyo-network/payload-builder": "~5.0.1",
+    "@xyo-network/payload-model": "~5.0.1",
+    "@xyo-network/payload-wrapper": "~5.0.1",
     "@xyo-network/xl1-protocol": "~1.9.3",
-    "@xyo-network/xl1-protocol-sdk": "~1.10.0",
-    "@xyo-network/xl1-wrappers": "~1.10.0",
+    "@xyo-network/xl1-protocol-sdk": "~1.10.1",
+    "@xyo-network/xl1-wrappers": "~1.10.1",
     "axios": "~1.11.0",
     "uuid": "~11.1.0",
     "zod": "~3.25.76"
@@ -86,12 +86,12 @@
   "devDependencies": {
     "@metamask/utils": "~11.4.2",
     "@types/node": "~24.2.0",
-    "@xylabs/logger": "~5.0.2",
-    "@xylabs/ts-scripts-yarn3": "~7.0.3",
-    "@xylabs/tsconfig": "~7.0.3",
-    "@xylabs/vitest-extended": "~5.0.2",
-    "@xyo-network/account": "~5.0.0",
-    "@xyo-network/wallet": "~5.0.0",
+    "@xylabs/logger": "~5.0.3",
+    "@xylabs/ts-scripts-yarn3": "~7.1.0",
+    "@xylabs/tsconfig": "~7.1.0",
+    "@xylabs/vitest-extended": "~5.0.3",
+    "@xyo-network/account": "~5.0.1",
+    "@xyo-network/wallet": "~5.0.1",
     "dotenv": "~17.2.1",
     "typescript": "~5.9.2",
     "vitest": "~3.2.4"

package/src/provider/client/PermissionsStore/getPermissionsStoreFromTransport.ts

@@ -2,7 +2,7 @@ import { type RpcTransport } from '../../../transport/index.ts'
 import type { XyoGatewayRpcSchemas } from '../../../types/index.ts'
 import type { PermissionsStore } from './PermissionsStore.ts'
 
-export const getPermissionsStoreFromTransport = (transport: RpcTransport<typeof XyoGatewayRpcSchemas>): PermissionsStore => {
+export const getPermissionsStoreFromTransport = (_transport: RpcTransport<typeof XyoGatewayRpcSchemas>): PermissionsStore => {
   throw new Error('Not implemented')
   // return {
   //   getPermissions: () => transport.sendRequest('xyoGateway_getPermissions'),

package/src/provider/connection/XyoConnection.ts

@@ -7,7 +7,7 @@ import type {
   AllowedBlockPayload,
   HydratedTransaction,
   TransactionBoundWitness, TransactionFeesBigInt,
-  TransactionSubmitterOptions, XyoConnectionProvider, XyoDataLakeProvider, XyoDataLakeViewer, XyoNetwork, XyoRunner, XyoSigner, XyoViewer,
+  TransactionOptions, XyoConnectionProvider, XyoDataLakeProvider, XyoDataLakeViewer, XyoNetwork, XyoRunner, XyoSigner, XyoViewer,
 } from '@xyo-network/xl1-protocol'
 import { defaultTransactionFees, isDataLakeProvider } from '@xyo-network/xl1-protocol'
 import { HydratedTransactionWrapper } from '@xyo-network/xl1-wrappers'
@@ -64,6 +64,7 @@ export class XyoConnection implements XyoConnectionProvider {
     from?: Address,
     fees?: TransactionFeesBigInt,
   ): Promise<Signed<TransactionBoundWitness>> {
+    // eslint-disable-next-line sonarjs/deprecation
     return (await this.submitTransaction(elevatedPayloads, additionalPayloads, {
       chain, nbf, exp, from, fees,
     }))[0]
@@ -75,9 +76,10 @@ export class XyoConnection implements XyoConnectionProvider {
     additionalPayloads: Payload[],
     {
       chain, exp, fees, from, nbf,
-    }: TransactionSubmitterOptions = {},
+    }: TransactionOptions = {},
   ): Promise<HydratedTransaction> {
     const viewer = assertEx(this.viewer, () => 'No viewer available')
+    // eslint-disable-next-line sonarjs/deprecation
     const signer = assertEx(this.signer, () => 'No signer available')
     const runner = assertEx(this.runner, () => 'No runner available')
     const storage = this.storage
@@ -88,6 +90,7 @@ export class XyoConnection implements XyoConnectionProvider {
     const feesResolved = fees ?? defaultTransactionFees
     const fromResolved = from ?? await signer.address()
     if (fromResolved === undefined) throw new Error('Failed to determine from address')
+    // eslint-disable-next-line sonarjs/deprecation
     const signedTransaction = assertEx(await signer.createSignedTransaction(
       chainResolved,
       elevatedPayloads,

package/src/provider/connection/spec/XyoConnection.ts

@@ -19,6 +19,7 @@ describe('RpcEngine - XyoProvider', () => {
     sut = new XyoConnection({ runner, signer })
   })
   it('should submit transaction', async () => {
+    // eslint-disable-next-line sonarjs/deprecation
     const result = await sut.send?.([], [], chain, 0, Number.MAX_VALUE)
     expect(result).toBeDefined()
   })

package/src/provider/signer/spec/RpcEngineXyoSigner.spec.ts

@@ -32,6 +32,7 @@ describe('RpcEngine - XyoSigner', () => {
   })
   describe('createSignedTransaction', () => {
     it('should return signed transaction', async () => {
+      // eslint-disable-next-line sonarjs/deprecation
       const signedTransaction = await sut.createSignedTransaction(
         chain,
         [],

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

@@ -0,0 +1,117 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { JsonRpcRequest } from '@metamask/utils'
+import {
+  isJsonRpcError,
+  isJsonRpcSuccess,
+} from '@metamask/utils'
+import { isDefined } from '@xylabs/typeof'
+import { v4 } from 'uuid'
+import type { z } from 'zod'
+
+import type { RpcSchemaMap } from '../../types/index.ts'
+import { jsonrpc, XyoGatewayRpcSchemas } from '../../types/index.ts'
+import type { RpcTransport } from '../RpcTransport.ts'
+import { isRpcError } from './helpers.ts'
+import { resolvedEvent } from './resolveData.ts'
+
+const isValidBaseRpcEvent = (data: any) => {
+  return !!(data && typeof data === 'object'
+    && 'jsonrpc' in data && data.jsonrpc === '2.0'
+    && 'method' in data && typeof data.method === 'string'
+    && 'id' in data && typeof data.id === 'string')
+}
+
+const isRpcResponse = (data: any, targetId: string) => {
+  return isValidBaseRpcEvent(data) && (isDefined(targetId) ? data.id === targetId : true) && 'result' in data && Array.isArray(data.result)
+}
+
+/** @deprecated - now part of a client gateway */
+export class LegacyPostMessageRpcTransport<T extends RpcSchemaMap = RpcSchemaMap> implements RpcTransport<T> {
+  protected readonly destination?: string
+  protected readonly schemas: T
+  protected readonly sessionId?: string
+
+  constructor(defaultDestination?: string, schemas: T = XyoGatewayRpcSchemas as T, sessionId?: string) {
+    this.schemas = schemas
+    this.destination = defaultDestination
+    this.sessionId = sessionId
+  }
+
+  async sendRequest<
+    TMethod extends keyof T & string,
+  >(
+    method: TMethod,
+    params?: z.infer<T[TMethod]['params']['to']>,
+  ): Promise<z.infer<T[TMethod]['result']['from']>> {
+    const id = v4()
+    return await this.callRpc(this.schemas, method, id, params)
+  }
+
+  private async callRpc<
+    TSchemas extends RpcSchemaMap,
+    TMethod extends keyof TSchemas,
+  >(
+    schemas: TSchemas,
+    method: TMethod,
+    id: string,
+    params?: z.infer<TSchemas[TMethod]['params']['to']>,
+  ): Promise<z.infer<TSchemas[TMethod]['result']['from']>> {
+    const body: JsonRpcRequest = {
+      jsonrpc,
+      id,
+      method: method as string,
+    }
+
+    body.params = (isDefined(params) && isDefined(schemas[method])) ? schemas[method].params.to.parse(params) : params
+
+    return await new Promise((resolve, reject) => {
+      const id = body.id
+
+      const handler = (event: MessageEvent) => {
+        if (event.origin !== globalThis.window.origin) return
+        if (!isRpcResponse(event.data, id as string)) return
+        const data = resolvedEvent(event, id as string)
+        if (data === false) return
+
+        globalThis.removeEventListener('message', handler)
+
+        if (data.legacyEventData) {
+          // Handle legacy event data
+          if (data.legacyEventData.result.some(isRpcError)) {
+            reject(data.legacyEventData.result[0])
+          } else {
+            resolve(data.legacyEventData.result[0])
+          }
+          return
+        }
+
+        if (data.eventData) {
+          // Handle new event data
+          if (isJsonRpcError(data.eventData)) {
+            reject(data.eventData)
+            return
+          }
+          if (isJsonRpcSuccess(data.eventData)) {
+            resolve(data.eventData)
+            return
+          }
+          reject(new Error('Unexpected response format'))
+        }
+      }
+
+      globalThis.addEventListener('message', handler)
+
+      globalThis.postMessage(
+        {
+          data: body,
+          destination: this.destination,
+          sessionId: this.sessionId,
+        },
+        globalThis.location.origin,
+      )
+    })
+  }
+}
+
+/** @deprecated - use LegacyPostMessageRpcTransport but rely on wallet release > 1.17.1 to handle the postMessage flow */
+export const PostMessageRpcTransport = LegacyPostMessageRpcTransport

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

@@ -13,7 +13,7 @@ export const buildSessionMessageRequest = <T extends JsonRpcRequest>(data: T, de
   const request: SessionMessageEnvelope<T> = {
     data,
     destination,
-    sessionId: globalThis.xyoWalletExtensionId ?? '',
+    sessionId: globalThis.xyo.walletExtensionId() ?? '',
   }
 
   return request

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

@@ -13,7 +13,7 @@ export interface RpcError extends JsonObject {
 }
 
 /** @deprecated - no longer part of the public rpc implementation */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
+// eslint-disable-next-line @typescript-eslint/no-explicit-any, sonarjs/deprecation
 export const isRpcError = (data: any): data is RpcError => {
   return (
     data

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

@@ -1,2 +1,2 @@
-export * from './PostMessageRpcTransport.ts'
+export * from './LegacyPostMessageRpcTransport.ts'
 export * from './SessionEnvelope.ts'

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

@@ -0,0 +1,30 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+/**
+ * NOTE: This file is to help resolve the data from a postMessage event in the transport
+ * layer.  Older implementations require the id to be at the top level, while newer
+ * implementations nest the id inside a data object.  Once the wallet extension is updated
+ * to always use the nested structure, this file can be removed.
+ */
+
+type ResolvedEventData = {
+  eventData?: any
+  legacyEventData?: any
+}
+
+// If the id is present in the eventData and matches the targetId, return the eventData
+// and mark it as legacyEventData since newer implementations nest the id inside a data object
+const hasMatchingId = (eventData: any, targetId: string): false | ResolvedEventData => {
+  return eventData?.id === targetId ? { legacyEventData: eventData } : false
+}
+
+// If the id is present in the data object of the eventData and matches the targetId,
+// return the eventData as eventData so its clear that this is a newer implementation
+const hasMatchingNestedId = (eventData: any, targetId: string): false | ResolvedEventData => {
+  return eventData?.data?.id === targetId ? { eventData: eventData.data } : false
+}
+
+export const resolvedEvent = (event: MessageEvent, targetId: string): false | ResolvedEventData => {
+  // eslint-disable-next-line @typescript-eslint/strict-boolean-expressions
+  return hasMatchingId(event.data, targetId) || hasMatchingNestedId(event.data, targetId)
+}

package/src/types/global.d.ts

@@ -1,4 +1,3 @@
-// TODO - add optional send method of type Transport
 export interface XyoGlobal {
   _debug: () => void
   provider?: XyoProvider
@@ -11,5 +10,6 @@ export declare global {
   }
 
   var xyo: XyoGlobal
+  /** @deprecated - use globalThis.xyo.walletExtensionId() instead */
   var xyoWalletExtensionId: string
 }

package/dist/neutral/transport/post-message/PostMessageRpcTransport.d.ts

@@ -1,12 +0,0 @@
-import type { z } from 'zod';
-import type { RpcSchemaMap } from '../../types/index.ts';
-import type { RpcTransport } from '../RpcTransport.ts';
-/** @deprecated - now part of a client gateway */
-export declare class PostMessageRpcTransport<T extends RpcSchemaMap = RpcSchemaMap> implements RpcTransport<T> {
-    protected readonly destination?: string;
-    protected readonly schemas: T;
-    constructor(defaultDestination?: string, schemas?: T);
-    sendRequest<TMethod extends keyof T & string>(method: TMethod, params?: z.infer<T[TMethod]['params']['to']>): Promise<z.infer<T[TMethod]['result']['from']>>;
-    private callRpc;
-}
-//# sourceMappingURL=PostMessageRpcTransport.d.ts.map

package/dist/neutral/transport/post-message/PostMessageRpcTransport.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PostMessageRpcTransport.d.ts","sourceRoot":"","sources":["../../../../src/transport/post-message/PostMessageRpcTransport.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAE5B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAExD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAKtD,iDAAiD;AACjD,qBAAa,uBAAuB,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY,CAAE,YAAW,YAAY,CAAC,CAAC,CAAC;IACpG,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IACvC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;gBAEjB,kBAAkB,CAAC,EAAE,MAAM,EAAE,OAAO,GAAE,CAA6B;IAKzE,WAAW,CACf,OAAO,SAAS,MAAM,CAAC,GAAG,MAAM,EAEhC,MAAM,EAAE,OAAO,EACf,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,GAC3C,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;YAKnC,OAAO;CAwCtB"}

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

@@ -1,12 +0,0 @@
-import type { z } from 'zod';
-import type { RpcSchemaMap } from '../../types/index.ts';
-import type { RpcTransport } from '../RpcTransport.ts';
-/** @deprecated - now part of a client gateway */
-export declare class PostMessageRpcTransport<T extends RpcSchemaMap = RpcSchemaMap> implements RpcTransport<T> {
-    protected readonly destination?: string;
-    protected readonly schemas: T;
-    constructor(defaultDestination?: string, schemas?: T);
-    sendRequest<TMethod extends keyof T & string>(method: TMethod, params?: z.infer<T[TMethod]['params']['to']>): Promise<z.infer<T[TMethod]['result']['from']>>;
-    private callRpc;
-}
-//# sourceMappingURL=PostMessageRpcTransport.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"PostMessageRpcTransport.d.ts","sourceRoot":"","sources":["../../../../src/transport/post-message/PostMessageRpcTransport.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAE5B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAExD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAKtD,iDAAiD;AACjD,qBAAa,uBAAuB,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY,CAAE,YAAW,YAAY,CAAC,CAAC,CAAC;IACpG,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAA;IACvC,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAA;gBAEjB,kBAAkB,CAAC,EAAE,MAAM,EAAE,OAAO,GAAE,CAA6B;IAKzE,WAAW,CACf,OAAO,SAAS,MAAM,CAAC,GAAG,MAAM,EAEhC,MAAM,EAAE,OAAO,EACf,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,GAC3C,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;YAKnC,OAAO;CAwCtB"}

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

@@ -1,73 +0,0 @@
-import type { JsonRpcRequest } from '@metamask/utils'
-import { isDefined } from '@xylabs/typeof'
-import { v4 } from 'uuid'
-import type { z } from 'zod'
-
-import type { RpcSchemaMap } from '../../types/index.ts'
-import { jsonrpc, XyoGatewayRpcSchemas } from '../../types/index.ts'
-import type { RpcTransport } from '../RpcTransport.ts'
-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
-
-  constructor(defaultDestination?: string, schemas: T = XyoGatewayRpcSchemas as T) {
-    this.schemas = schemas
-    this.destination = defaultDestination
-  }
-
-  async sendRequest<
-    TMethod extends keyof T & string,
-  >(
-    method: TMethod,
-    params?: z.infer<T[TMethod]['params']['to']>,
-  ): Promise<z.infer<T[TMethod]['result']['from']>> {
-    const id = v4()
-    return await this.callRpc(this.schemas, method, id, params)
-  }
-
-  private async callRpc<
-    TSchemas extends RpcSchemaMap,
-    TMethod extends keyof TSchemas,
-  >(
-    schemas: TSchemas,
-    method: TMethod,
-    id: string,
-    params?: z.infer<TSchemas[TMethod]['params']['to']>,
-  ): Promise<z.infer<TSchemas[TMethod]['result']['from']>> {
-    const body: JsonRpcRequest = {
-      jsonrpc,
-      id,
-      method: method as string,
-    }
-
-    body.params = (isDefined(params) && isDefined(schemas[method])) ? schemas[method].params.to.parse(params) : params
-
-    return await new Promise((resolve, reject) => {
-      const id = body.id
-
-      const handler = (event: MessageEvent) => {
-        if (event.origin !== globalThis.window.origin) return
-        if ((event.data as JsonRpcRequestWithId).id !== id) return
-
-        globalThis.removeEventListener('message', handler)
-        if (event.data.result.some(isRpcError)) {
-          reject(event.data.result[0])
-        } else {
-          resolve(event.data.result[0])
-        }
-      }
-
-      globalThis.addEventListener('message', handler)
-
-      globalThis.postMessage(
-        buildSessionMessageRequest(body, this.destination),
-        globalThis.location.origin,
-      )
-    })
-  }
-}