@xyo-network/xl1-protocol 1.5.18 → 1.6.0

package/dist/types/provider/v1/XyoHost.d.ts

@@ -1,25 +1,64 @@
-import type { Address, Hex } from '@xylabs/hex';
+import type { Hex } from '@xylabs/hex';
+import type { JsonValue } from '@xylabs/object';
 import type { Promisable } from '@xylabs/promise';
 export interface ChainConnection {
+    /** Chain Identifier - can be a hex (eth contract address) or a string */
     chainId?: string | Hex;
+    /** Name of the chain */
     name: string;
     /** Url for accessing the network */
     url: string;
 }
+/**
+ * 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;
-    chain: Address;
-    expiration?: number;
-    grantee?: string;
-    id: string;
-    issuedAt?: number;
-    status?: 'granted' | 'revoked';
-    value?: 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 XyoHost {
     addChain(chainConnectionInfo: ChainConnection): Promisable<boolean>;
     chains(): Promisable<ChainConnection[]>;
-    getPermissions(): Promisable<Permission[]>;
+    getPermissions(): Promisable<InvokerPermission[]>;
     requestPermissions(permissions: Permission[]): Promisable<boolean>;
     revokePermissions(permissions: Permission[]): Promisable<boolean>;
 }

package/dist/types/provider/v1/XyoHost.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"XyoHost.d.ts","sourceRoot":"","sources":["../../../../src/provider/v1/XyoHost.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,MAAM,WAAW,eAAe;IAE9B,OAAO,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;IAEtB,IAAI,EAAE,MAAM,CAAA;IACZ,oCAAoC;IACpC,GAAG,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,UAAU;IAEzB,UAAU,EAAE,MAAM,CAAA;IAElB,KAAK,EAAE,OAAO,CAAA;IAEd,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB,EAAE,EAAE,MAAM,CAAA;IAEV,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB,MAAM,CAAC,EAAE,SAAS,GAAG,SAAS,CAAA;IAE9B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAA;CACjB;AAED,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,mBAAmB,EAAE,eAAe,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;IACnE,MAAM,IAAI,UAAU,CAAC,eAAe,EAAE,CAAC,CAAA;IACvC,cAAc,IAAI,UAAU,CAAC,UAAU,EAAE,CAAC,CAAA;IAC1C,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":"XyoHost.d.ts","sourceRoot":"","sources":["../../../../src/provider/v1/XyoHost.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,aAAa,CAAA;AACtC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,MAAM,WAAW,eAAe;IAC9B,yEAAyE;IACzE,OAAO,CAAC,EAAE,MAAM,GAAG,GAAG,CAAA;IACtB,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAA;IACZ,oCAAoC;IACpC,GAAG,EAAE,MAAM,CAAA;CACZ;AAED;;;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,OAAO;IACtB,QAAQ,CAAC,mBAAmB,EAAE,eAAe,GAAG,UAAU,CAAC,OAAO,CAAC,CAAA;IACnE,MAAM,IAAI,UAAU,CAAC,eAAe,EAAE,CAAC,CAAA;IACvC,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"}