@xyo-network/xl1-protocol 1.7.20 → 1.7.21

package/dist/neutral/provider/v1/PermissionsProvider.d.ts

@@ -0,0 +1,54 @@
+import type { JsonValue } from '@xylabs/object';
+import type { Promisable } from '@xylabs/promise';
+/**
+ * Modeled after EIP-2255
+ * See - https://eips.ethereum.org/EIPS/eip-2255#specification
+ */
+export interface PermissionRequest {
+    [capability: string]: {
+        [caveatName: string]: JsonValue;
+    };
+}
+/**
+ * Modeled after EIP-2255
+ * See - https://eips.ethereum.org/EIPS/eip-2255#specification
+ */
+export interface RequestedPermission {
+    /** Permission identifier (i.e. RPC method, action, etc.) */
+    capability: string;
+    /** Optional timestamp for when the permission was granted */
+    date?: number;
+}
+export type CaveatTypes = 'chain' | 'expiration' | 'filteredResponse' | 'rateLimit';
+/**
+ * Modeled after EIP-2255
+ * See - https://eips.ethereum.org/EIPS/eip-2255#specification
+ */
+export interface Caveats {
+    /** Type of caveat */
+    type: CaveatTypes;
+    /** Value for the caveat (i.e. chain id, subset of accounts, expiration, max request per minute, etc.) */
+    value: JsonValue;
+}
+/**
+ * Modeled after EIP-2255
+ * See - https://eips.ethereum.org/EIPS/eip-2255#specification
+ */
+export interface Permission {
+    /** Permission identifier (i.e. RPC method, action, etc.) */
+    capability: string;
+    /** Caveats for the permission, if applicable (i.e. allowed accounts, signing, etc.) */
+    caveats?: Caveats[];
+    /** Invoker for the given permission (URI, domain, webpage, address, etc.) */
+    invoker: string;
+}
+export interface InvokerPermission extends Permission {
+    /** Time at which the permission was granted */
+    date?: number;
+}
+export interface PermissionsProvider {
+    getPermissions(): Promisable<InvokerPermission[]>;
+    requestPermissions(permissions: Permission[]): Promisable<boolean>;
+    revokePermissions(permissions: Permission[]): Promisable<boolean>;
+}
+//# sourceMappingURL=PermissionsProvider.d.ts.map

package/dist/neutral/provider/v1/PermissionsProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PermissionsProvider.d.ts","sourceRoot":"","sources":["../../../../src/provider/v1/PermissionsProvider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,CAAC,UAAU,EAAE,MAAM,GAAG;QACpB,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;KAChC,CAAA;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,4DAA4D;IAC5D,UAAU,EAAE,MAAM,CAAA;IAClB,6DAA6D;IAC7D,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,YAAY,GAAG,kBAAkB,GAAG,WAAW,CAAA;AAEnF;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,qBAAqB;IACrB,IAAI,EAAE,WAAW,CAAA;IACjB,yGAAyG;IACzG,KAAK,EAAE,SAAS,CAAA;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,4DAA4D;IAC5D,UAAU,EAAE,MAAM,CAAA;IAClB,uFAAuF;IACvF,OAAO,CAAC,EAAE,OAAO,EAAE,CAAA;IACnB,6EAA6E;IAC7E,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,mBAAmB;IAClC,cAAc,IAAI,UAAU,CAAC,iBAAiB,EAAE,CAAC,CAAA;IACjD,kBAAkB,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;IAClE,iBAAiB,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;CAClE"}

package/dist/neutral/provider/v1/XyoClient.d.ts

@@ -0,0 +1,7 @@
+import type { PermissionsProvider } from './PermissionsProvider.ts';
+import type { XyoGatewayProvider } from './XyoGateway.ts';
+export interface XyoClient {
+    gateways: Readonly<Record<string, XyoGatewayProvider>>;
+    permissionsProvider: PermissionsProvider;
+}
+//# sourceMappingURL=XyoClient.d.ts.map

package/dist/neutral/provider/v1/XyoClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"XyoClient.d.ts","sourceRoot":"","sources":["../../../../src/provider/v1/XyoClient.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AACnE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAEzD,MAAM,WAAW,SAAS;IACxB,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC,CAAA;IACtD,mBAAmB,EAAE,mBAAmB,CAAA;CACzC"}

package/dist/neutral/provider/v1/XyoGateway.d.ts

@@ -1,59 +1,40 @@
-import type { JsonValue } from '@xylabs/object';
 import type { Promisable } from '@xylabs/promise';
+import type { InvokerPermission, Permission } from './PermissionsProvider.ts';
 import type { TransactionSubmitter } from './TransactionSubmitter.ts';
 import type { XyoConnectionProvider, XyoRpcConnectionConfig } from './XyoConnection.ts';
-/**
- * Modeled after EIP-2255
- * See - https://eips.ethereum.org/EIPS/eip-2255#specification
- */
-export interface PermissionRequest {
-    [capability: string]: {
-        [caveatName: string]: JsonValue;
-    };
-}
-/**
- * Modeled after EIP-2255
- * See - https://eips.ethereum.org/EIPS/eip-2255#specification
- */
-export interface RequestedPermission {
-    /** Permission identifier (i.e. RPC method, action, etc.) */
-    capability: string;
-    /** Optional timestamp for when the permission was granted */
-    date?: number;
-}
-export type CaveatTypes = 'chain' | 'expiration' | 'filteredResponse' | 'rateLimit';
-/**
- * Modeled after EIP-2255
- * See - https://eips.ethereum.org/EIPS/eip-2255#specification
- */
-export interface Caveats {
-    /** Type of caveat */
-    type: CaveatTypes;
-    /** Value for the caveat (i.e. chain id, subset of accounts, expiration, max request per minute, etc.) */
-    value: JsonValue;
-}
-/**
- * Modeled after EIP-2255
- * See - https://eips.ethereum.org/EIPS/eip-2255#specification
- */
-export interface Permission {
-    /** Permission identifier (i.e. RPC method, action, etc.) */
-    capability: string;
-    /** Caveats for the permission, if applicable (i.e. allowed accounts, signing, etc.) */
-    caveats?: Caveats[];
-    /** Invoker for the given permission (URI, domain, webpage, address, etc.) */
-    invoker: string;
-}
-export interface InvokerPermission extends Permission {
-    /** Time at which the permission was granted */
-    date?: number;
-}
+import type { XyoSigner } from './XyoSigner.ts';
 export interface XyoGatewayProvider extends TransactionSubmitter {
+    /**
+     * @deprecated use `connection()` instead
+     */
     activeConnection(): Promisable<XyoConnectionProvider | undefined>;
+    /**
+     * @deprecated use `connection()` instead
+     */
     addConnection(config: XyoRpcConnectionConfig): Promisable<XyoConnectionProvider>;
+    /**
+     * Returns the connection provider for this gateway.
+     */
+    connection(): Promisable<XyoConnectionProvider>;
+    /**
+     * @deprecated use `connection()` instead
+     */
     connections(): Promisable<Record<string, XyoConnectionProvider>>;
+    /**
+     * @deprecated Permissions now at Client level
+     */
     getPermissions(): Promisable<InvokerPermission[]>;
+    /**
+     * @deprecated Permissions now at Client level
+     */
     requestPermissions(permissions: Permission[]): Promisable<boolean>;
+    /**
+     * @deprecated Permissions now at Client level
+     */
     revokePermissions(permissions: Permission[]): Promisable<boolean>;
+    /**
+     * Returns the signer for this gateway.
+     */
+    signer(): Promisable<XyoSigner>;
 }
 //# sourceMappingURL=XyoGateway.d.ts.map

package/dist/neutral/provider/v1/XyoGateway.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"XyoGateway.d.ts","sourceRoot":"","sources":["../../../../src/provider/v1/XyoGateway.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AACrE,OAAO,KAAK,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAA;AAEvF;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,CAAC,UAAU,EAAE,MAAM,GAAG;QACpB,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAA;KAChC,CAAA;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,4DAA4D;IAC5D,UAAU,EAAE,MAAM,CAAA;IAClB,6DAA6D;IAC7D,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,YAAY,GAAG,kBAAkB,GAAG,WAAW,CAAA;AAEnF;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,qBAAqB;IACrB,IAAI,EAAE,WAAW,CAAA;IACjB,yGAAyG;IACzG,KAAK,EAAE,SAAS,CAAA;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,4DAA4D;IAC5D,UAAU,EAAE,MAAM,CAAA;IAClB,uFAAuF;IACvF,OAAO,CAAC,EAAE,OAAO,EAAE,CAAA;IACnB,6EAA6E;IAC7E,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;IAC9D,gBAAgB,IAAI,UAAU,CAAC,qBAAqB,GAAG,SAAS,CAAC,CAAA;IACjE,aAAa,CAAC,MAAM,EAAE,sBAAsB,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAA;IAChF,WAAW,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,CAAA;IAChE,cAAc,IAAI,UAAU,CAAC,iBAAiB,EAAE,CAAC,CAAA;IACjD,kBAAkB,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;IAClE,iBAAiB,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;CAClE"}
+{"version":3,"file":"XyoGateway.d.ts","sourceRoot":"","sources":["../../../../src/provider/v1/XyoGateway.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAA;AAC7E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AACrE,OAAO,KAAK,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAA;AACvF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;IAC9D;;OAEG;IACH,gBAAgB,IAAI,UAAU,CAAC,qBAAqB,GAAG,SAAS,CAAC,CAAA;IACjE;;OAEG;IACH,aAAa,CAAC,MAAM,EAAE,sBAAsB,GAAG,UAAU,CAAC,qBAAqB,CAAC,CAAA;IAChF;;OAEG;IACH,UAAU,IAAI,UAAU,CAAC,qBAAqB,CAAC,CAAA;IAC/C;;OAEG;IACH,WAAW,IAAI,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC,CAAA;IAChE;;OAEG;IACH,cAAc,IAAI,UAAU,CAAC,iBAAiB,EAAE,CAAC,CAAA;IACjD;;OAEG;IACH,kBAAkB,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;IAClE;;OAEG;IACH,iBAAiB,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;IACjE;;OAEG;IACH,MAAM,IAAI,UAAU,CAAC,SAAS,CAAC,CAAA;CAChC"}

package/dist/neutral/provider/v1/index.d.ts

@@ -1,4 +1,6 @@
+export * from './PermissionsProvider.ts';
 export * from './TransactionSubmitter.ts';
+export * from './XyoClient.ts';
 export * from './XyoConnection.ts';
 export * from './XyoDataLake.ts';
 export * from './XyoGateway.ts';

package/dist/neutral/provider/v1/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/provider/v1/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAA;AACzC,cAAc,oBAAoB,CAAA;AAClC,cAAc,kBAAkB,CAAA;AAChC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/provider/v1/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAA;AACxC,cAAc,2BAA2B,CAAA;AACzC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,oBAAoB,CAAA;AAClC,cAAc,kBAAkB,CAAA;AAChC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json.schemastore.org/package.json",
   "name": "@xyo-network/xl1-protocol",
-  "version": "1.7.20",
+  "version": "1.7.21",
   "description": "XYO Layer One Protocol",
   "homepage": "https://xylabs.com",
   "bugs": {

package/src/provider/v1/PermissionsProvider.ts

@@ -0,0 +1,60 @@
+import type { JsonValue } from '@xylabs/object'
+import type { Promisable } from '@xylabs/promise'
+
+/**
+ * Modeled after EIP-2255
+ * See - https://eips.ethereum.org/EIPS/eip-2255#specification
+ */
+export interface PermissionRequest {
+  [capability: string]: {
+    [caveatName: string]: JsonValue
+  }
+}
+
+/**
+ * Modeled after EIP-2255
+ * See - https://eips.ethereum.org/EIPS/eip-2255#specification
+ */
+export interface RequestedPermission {
+  /** Permission identifier (i.e. RPC method, action, etc.) */
+  capability: string
+  /** Optional timestamp for when the permission was granted */
+  date?: number
+}
+
+export type CaveatTypes = 'chain' | 'expiration' | 'filteredResponse' | 'rateLimit'
+
+/**
+ * Modeled after EIP-2255
+ * See - https://eips.ethereum.org/EIPS/eip-2255#specification
+ */
+export interface Caveats {
+  /** Type of caveat */
+  type: CaveatTypes
+  /** Value for the caveat (i.e. chain id, subset of accounts, expiration, max request per minute, etc.) */
+  value: JsonValue
+}
+
+/**
+ * Modeled after EIP-2255
+ * See - https://eips.ethereum.org/EIPS/eip-2255#specification
+ */
+export interface Permission {
+  /** Permission identifier (i.e. RPC method, action, etc.) */
+  capability: string
+  /** Caveats for the permission, if applicable (i.e. allowed accounts, signing, etc.) */
+  caveats?: Caveats[]
+  /** Invoker for the given permission (URI, domain, webpage, address, etc.) */
+  invoker: string
+}
+
+export interface InvokerPermission extends Permission {
+  /** Time at which the permission was granted */
+  date?: number
+}
+
+export interface PermissionsProvider {
+  getPermissions(): Promisable<InvokerPermission[]>
+  requestPermissions(permissions: Permission[]): Promisable<boolean>
+  revokePermissions(permissions: Permission[]): Promisable<boolean>
+}

package/src/provider/v1/XyoClient.ts

@@ -0,0 +1,7 @@
+import type { PermissionsProvider } from './PermissionsProvider.ts'
+import type { XyoGatewayProvider } from './XyoGateway.ts'
+
+export interface XyoClient {
+  gateways: Readonly<Record<string, XyoGatewayProvider>>
+  permissionsProvider: PermissionsProvider
+}

package/src/provider/v1/XyoGateway.ts

@@ -1,66 +1,41 @@
-import type { JsonValue } from '@xylabs/object'
 import type { Promisable } from '@xylabs/promise'
 
+import type { InvokerPermission, Permission } from './PermissionsProvider.ts'
 import type { TransactionSubmitter } from './TransactionSubmitter.ts'
 import type { XyoConnectionProvider, XyoRpcConnectionConfig } from './XyoConnection.ts'
-
-/**
- * Modeled after EIP-2255
- * See - https://eips.ethereum.org/EIPS/eip-2255#specification
- */
-export interface PermissionRequest {
-  [capability: string]: {
-    [caveatName: string]: JsonValue
-  }
-}
-
-/**
- * Modeled after EIP-2255
- * See - https://eips.ethereum.org/EIPS/eip-2255#specification
- */
-export interface RequestedPermission {
-  /** Permission identifier (i.e. RPC method, action, etc.) */
-  capability: string
-  /** Optional timestamp for when the permission was granted */
-  date?: number
-}
-
-export type CaveatTypes = 'chain' | 'expiration' | 'filteredResponse' | 'rateLimit'
-
-/**
- * Modeled after EIP-2255
- * See - https://eips.ethereum.org/EIPS/eip-2255#specification
- */
-export interface Caveats {
-  /** Type of caveat */
-  type: CaveatTypes
-  /** Value for the caveat (i.e. chain id, subset of accounts, expiration, max request per minute, etc.) */
-  value: JsonValue
-}
-
-/**
- * Modeled after EIP-2255
- * See - https://eips.ethereum.org/EIPS/eip-2255#specification
- */
-export interface Permission {
-  /** Permission identifier (i.e. RPC method, action, etc.) */
-  capability: string
-  /** Caveats for the permission, if applicable (i.e. allowed accounts, signing, etc.) */
-  caveats?: Caveats[]
-  /** Invoker for the given permission (URI, domain, webpage, address, etc.) */
-  invoker: string
-}
-
-export interface InvokerPermission extends Permission {
-  /** Time at which the permission was granted */
-  date?: number
-}
+import type { XyoSigner } from './XyoSigner.ts'
 
 export interface XyoGatewayProvider extends TransactionSubmitter {
+  /**
+   * @deprecated use `connection()` instead
+   */
   activeConnection(): Promisable<XyoConnectionProvider | undefined>
+  /**
+   * @deprecated use `connection()` instead
+   */
   addConnection(config: XyoRpcConnectionConfig): Promisable<XyoConnectionProvider>
+  /**
+   * Returns the connection provider for this gateway.
+   */
+  connection(): Promisable<XyoConnectionProvider>
+  /**
+   * @deprecated use `connection()` instead
+   */
   connections(): Promisable<Record<string, XyoConnectionProvider>>
+  /**
+   * @deprecated Permissions now at Client level
+   */
   getPermissions(): Promisable<InvokerPermission[]>
+  /**
+   * @deprecated Permissions now at Client level
+   */
   requestPermissions(permissions: Permission[]): Promisable<boolean>
+  /**
+   * @deprecated Permissions now at Client level
+   */
   revokePermissions(permissions: Permission[]): Promisable<boolean>
+  /**
+   * Returns the signer for this gateway.
+   */
+  signer(): Promisable<XyoSigner>
 }

package/src/provider/v1/index.ts

@@ -1,4 +1,6 @@
+export * from './PermissionsProvider.ts'
 export * from './TransactionSubmitter.ts'
+export * from './XyoClient.ts'
 export * from './XyoConnection.ts'
 export * from './XyoDataLake.ts'
 export * from './XyoGateway.ts'