@nucypher/taco-auth 0.1.0

package/dist/cjs/auth-provider.d.ts

@@ -0,0 +1,12 @@
+import { AuthSignature } from './auth-sig';
+import { EIP4361AuthProvider } from './providers';
+export declare const EIP4361_AUTH_METHOD = "EIP4361";
+export interface AuthProvider {
+    getOrCreateAuthSignature(): Promise<AuthSignature>;
+}
+export type AuthProviders = {
+    [EIP4361_AUTH_METHOD]?: EIP4361AuthProvider;
+    [key: string]: AuthProvider | undefined;
+};
+export declare const USER_ADDRESS_PARAM_DEFAULT = ":userAddress";
+export declare const AUTH_METHOD_FOR_PARAM: Record<string, string>;

package/dist/cjs/auth-provider.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AUTH_METHOD_FOR_PARAM = exports.USER_ADDRESS_PARAM_DEFAULT = exports.EIP4361_AUTH_METHOD = void 0;
+exports.EIP4361_AUTH_METHOD = 'EIP4361';
+exports.USER_ADDRESS_PARAM_DEFAULT = ':userAddress';
+exports.AUTH_METHOD_FOR_PARAM = {
+    [exports.USER_ADDRESS_PARAM_DEFAULT]: exports.EIP4361_AUTH_METHOD,
+};
+//# sourceMappingURL=auth-provider.js.map

package/dist/cjs/auth-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-provider.js","sourceRoot":"","sources":["../../src/auth-provider.ts"],"names":[],"mappings":";;;AAGa,QAAA,mBAAmB,GAAG,SAAS,CAAC;AAYhC,QAAA,0BAA0B,GAAG,cAAc,CAAC;AAE5C,QAAA,qBAAqB,GAA2B;IAC3D,CAAC,kCAA0B,CAAC,EAAE,2BAAmB;CAClD,CAAC"}

package/dist/cjs/auth-sig.d.ts

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+export declare const authSignatureSchema: z.ZodObject<{
+    signature: z.ZodString;
+    address: z.ZodEffects<z.ZodString, string, string>;
+    scheme: z.ZodEnum<["EIP4361"]>;
+    typedData: z.ZodEffects<z.ZodString, string, string>;
+}, "strip", z.ZodTypeAny, {
+    signature: string;
+    address: string;
+    scheme: "EIP4361";
+    typedData: string;
+}, {
+    signature: string;
+    address: string;
+    scheme: "EIP4361";
+    typedData: string;
+}>;
+export type AuthSignature = z.infer<typeof authSignatureSchema>;

package/dist/cjs/auth-sig.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.authSignatureSchema = void 0;
+const shared_1 = require("@nucypher/shared");
+const zod_1 = require("zod");
+const auth_provider_1 = require("./auth-provider");
+const providers_1 = require("./providers");
+exports.authSignatureSchema = zod_1.z.object({
+    signature: zod_1.z.string(),
+    address: shared_1.EthAddressSchema,
+    scheme: zod_1.z.enum([auth_provider_1.EIP4361_AUTH_METHOD]),
+    typedData: providers_1.EIP4361TypedDataSchema,
+});
+//# sourceMappingURL=auth-sig.js.map

package/dist/cjs/auth-sig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-sig.js","sourceRoot":"","sources":["../../src/auth-sig.ts"],"names":[],"mappings":";;;AAAA,6CAAoD;AACpD,6BAAwB;AAExB,mDAAsD;AACtD,2CAAqD;AAExC,QAAA,mBAAmB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC1C,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;IACrB,OAAO,EAAE,yBAAgB;IACzB,MAAM,EAAE,OAAC,CAAC,IAAI,CAAC,CAAC,mCAAmB,CAAC,CAAC;IACrC,SAAS,EAAE,kCAAsB;CAClC,CAAC,CAAC"}

package/dist/cjs/index.d.ts

@@ -0,0 +1,3 @@
+export * from './auth-provider';
+export * from './auth-sig';
+export * from './providers';

package/dist/cjs/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./auth-provider"), exports);
+__exportStar(require("./auth-sig"), exports);
+__exportStar(require("./providers"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,6CAA2B;AAC3B,8CAA4B"}

package/dist/cjs/providers/eip4361.d.ts

@@ -0,0 +1,18 @@
+import { ethers } from 'ethers';
+import { z } from 'zod';
+import { AuthSignature } from '../auth-sig';
+export declare const EIP4361TypedDataSchema: z.ZodEffects<z.ZodString, string, string>;
+export type EIP4361AuthProviderParams = {
+    domain: string;
+    uri: string;
+};
+export declare class EIP4361AuthProvider {
+    private readonly provider;
+    private readonly signer;
+    private readonly storage;
+    private readonly providerParams;
+    constructor(provider: ethers.providers.Provider, signer: ethers.Signer, providerParams?: EIP4361AuthProviderParams);
+    private getDefaultParameters;
+    getOrCreateAuthSignature(): Promise<AuthSignature>;
+    private createSIWEAuthMessage;
+}

package/dist/cjs/providers/eip4361.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EIP4361AuthProvider = exports.EIP4361TypedDataSchema = void 0;
+const siwe_1 = require("siwe");
+const zod_1 = require("zod");
+const auth_provider_1 = require("../auth-provider");
+const storage_1 = require("../storage");
+const isSiweMessage = (message) => {
+    try {
+        new siwe_1.SiweMessage(message);
+        return true;
+    }
+    catch {
+        return false;
+    }
+};
+exports.EIP4361TypedDataSchema = zod_1.z
+    .string()
+    .refine(isSiweMessage, { message: 'Invalid SIWE message' });
+const ERR_MISSING_SIWE_PARAMETERS = 'Missing default SIWE parameters';
+class EIP4361AuthProvider {
+    provider;
+    signer;
+    storage;
+    providerParams;
+    constructor(
+    // TODO: We only need the provider to fetch the chainId, consider removing it
+    provider, signer, providerParams) {
+        this.provider = provider;
+        this.signer = signer;
+        this.storage = new storage_1.LocalStorage();
+        if (providerParams) {
+            this.providerParams = providerParams;
+        }
+        else {
+            this.providerParams = this.getDefaultParameters();
+        }
+    }
+    getDefaultParameters() {
+        if (typeof window !== 'undefined') {
+            // If we are in a browser environment, we can get the domain and uri from the window object
+            return {
+                domain: window.location?.host,
+                uri: window.location?.origin,
+            };
+        }
+        // If not, we have no choice but to throw an error
+        throw new Error(ERR_MISSING_SIWE_PARAMETERS);
+    }
+    async getOrCreateAuthSignature() {
+        const address = await this.signer.getAddress();
+        const storageKey = `eth-${auth_provider_1.EIP4361_AUTH_METHOD}-message-${address}`;
+        // If we have a signature in localStorage, return it
+        const maybeSignature = this.storage.getAuthSignature(storageKey);
+        if (maybeSignature) {
+            return maybeSignature;
+        }
+        // If at this point we didn't return, we need to create a new message
+        const authMessage = await this.createSIWEAuthMessage();
+        this.storage.setAuthSignature(storageKey, authMessage);
+        return authMessage;
+    }
+    async createSIWEAuthMessage() {
+        const address = await this.signer.getAddress();
+        const { domain, uri } = this.providerParams;
+        const version = '1';
+        const nonce = (0, siwe_1.generateNonce)();
+        const chainId = (await this.provider.getNetwork()).chainId;
+        const siweMessage = new siwe_1.SiweMessage({
+            domain,
+            address,
+            statement: `${domain} wants you to sign in with your Ethereum account: ${address}`,
+            uri,
+            version,
+            nonce,
+            chainId,
+        });
+        const scheme = auth_provider_1.EIP4361_AUTH_METHOD;
+        const message = siweMessage.prepareMessage();
+        const signature = await this.signer.signMessage(message);
+        return { signature, address, scheme, typedData: message };
+    }
+}
+exports.EIP4361AuthProvider = EIP4361AuthProvider;
+//# sourceMappingURL=eip4361.js.map

package/dist/cjs/providers/eip4361.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eip4361.js","sourceRoot":"","sources":["../../../src/providers/eip4361.ts"],"names":[],"mappings":";;;AACA,+BAAkD;AAClD,6BAAwB;AAExB,oDAAuD;AAEvD,wCAA0C;AAE1C,MAAM,aAAa,GAAG,CAAC,OAAe,EAAW,EAAE;IACjD,IAAI,CAAC;QACH,IAAI,kBAAW,CAAC,OAAO,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,CAAC;AAEW,QAAA,sBAAsB,GAAG,OAAC;KACpC,MAAM,EAAE;KACR,MAAM,CAAC,aAAa,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE,CAAC,CAAC;AAO9D,MAAM,2BAA2B,GAAG,iCAAiC,CAAC;AAEtE,MAAa,mBAAmB;IAMX;IACA;IANF,OAAO,CAAe;IACtB,cAAc,CAA4B;IAE3D;IACE,6EAA6E;IAC5D,QAAmC,EACnC,MAAqB,EACtC,cAA0C;QAFzB,aAAQ,GAAR,QAAQ,CAA2B;QACnC,WAAM,GAAN,MAAM,CAAe;QAGtC,IAAI,CAAC,OAAO,GAAG,IAAI,sBAAY,EAAE,CAAC;QAClC,IAAI,cAAc,EAAE,CAAC;YACnB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACvC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QACpD,CAAC;IACH,CAAC;IAEO,oBAAoB;QAC1B,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;YAClC,2FAA2F;YAC3F,OAAO;gBACL,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,IAAI;gBAC7B,GAAG,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM;aAC7B,CAAC;QACJ,CAAC;QACD,kDAAkD;QAClD,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAEM,KAAK,CAAC,wBAAwB;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;QAC/C,MAAM,UAAU,GAAG,OAAO,mCAAmB,YAAY,OAAO,EAAE,CAAC;QAEnE,oDAAoD;QACpD,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QACjE,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,cAAc,CAAC;QACxB,CAAC;QAED,qEAAqE;QACrE,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACvD,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QACvD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEO,KAAK,CAAC,qBAAqB;QACjC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;QAC/C,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC;QAC5C,MAAM,OAAO,GAAG,GAAG,CAAC;QACpB,MAAM,KAAK,GAAG,IAAA,oBAAa,GAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC;QAC3D,MAAM,WAAW,GAAG,IAAI,kBAAW,CAAC;YAClC,MAAM;YACN,OAAO;YACP,SAAS,EAAE,GAAG,MAAM,qDAAqD,OAAO,EAAE;YAClF,GAAG;YACH,OAAO;YACP,KAAK;YACL,OAAO;SACR,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,mCAAmB,CAAC;QACnC,MAAM,OAAO,GAAG,WAAW,CAAC,cAAc,EAAE,CAAC;QAC7C,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACzD,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC;IAC5D,CAAC;CACF;AAlED,kDAkEC"}

package/dist/cjs/providers/external-eip4361.d.ts

@@ -0,0 +1,9 @@
+import { AuthSignature } from '../auth-sig';
+export declare class SingleSignOnEIP4361AuthProvider {
+    private readonly existingSiweMessage;
+    private readonly address;
+    private readonly signature;
+    static fromExistingSiweInfo(existingSiweMessage: string, signature: string): Promise<SingleSignOnEIP4361AuthProvider>;
+    private constructor();
+    getOrCreateAuthSignature(): Promise<AuthSignature>;
+}

package/dist/cjs/providers/external-eip4361.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SingleSignOnEIP4361AuthProvider = void 0;
+const siwe_1 = require("siwe");
+const auth_provider_1 = require("../auth-provider");
+class SingleSignOnEIP4361AuthProvider {
+    existingSiweMessage;
+    address;
+    signature;
+    static async fromExistingSiweInfo(existingSiweMessage, signature) {
+        // validation
+        const siweMessage = new siwe_1.SiweMessage(existingSiweMessage);
+        await siweMessage.verify({ signature });
+        // create provider
+        const authProvider = new SingleSignOnEIP4361AuthProvider(siweMessage.prepareMessage(), siweMessage.address, signature);
+        return authProvider;
+    }
+    constructor(existingSiweMessage, address, signature) {
+        this.existingSiweMessage = existingSiweMessage;
+        this.address = address;
+        this.signature = signature;
+    }
+    async getOrCreateAuthSignature() {
+        const scheme = auth_provider_1.EIP4361_AUTH_METHOD;
+        return {
+            signature: this.signature,
+            address: this.address,
+            scheme,
+            typedData: this.existingSiweMessage,
+        };
+    }
+}
+exports.SingleSignOnEIP4361AuthProvider = SingleSignOnEIP4361AuthProvider;
+//# sourceMappingURL=external-eip4361.js.map

package/dist/cjs/providers/external-eip4361.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"external-eip4361.js","sourceRoot":"","sources":["../../../src/providers/external-eip4361.ts"],"names":[],"mappings":";;;AAAA,+BAAmC;AAEnC,oDAAuD;AAGvD,MAAa,+BAA+B;IAkBvB;IACA;IACA;IAnBZ,MAAM,CAAC,KAAK,CAAC,oBAAoB,CACtC,mBAA2B,EAC3B,SAAiB;QAEjB,aAAa;QACb,MAAM,WAAW,GAAG,IAAI,kBAAW,CAAC,mBAAmB,CAAC,CAAC;QACzD,MAAM,WAAW,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QACxC,kBAAkB;QAClB,MAAM,YAAY,GAAG,IAAI,+BAA+B,CACtD,WAAW,CAAC,cAAc,EAAE,EAC5B,WAAW,CAAC,OAAO,EACnB,SAAS,CACV,CAAC;QACF,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,YACmB,mBAA2B,EAC3B,OAAe,EACf,SAAiB;QAFjB,wBAAmB,GAAnB,mBAAmB,CAAQ;QAC3B,YAAO,GAAP,OAAO,CAAQ;QACf,cAAS,GAAT,SAAS,CAAQ;IACjC,CAAC;IAEG,KAAK,CAAC,wBAAwB;QACnC,MAAM,MAAM,GAAG,mCAAmB,CAAC;QACnC,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM;YACN,SAAS,EAAE,IAAI,CAAC,mBAAmB;SACpC,CAAC;IACJ,CAAC;CACF;AAhCD,0EAgCC"}

package/dist/cjs/providers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './eip4361';
+export * from './external-eip4361';

package/dist/cjs/providers/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./eip4361"), exports);
+__exportStar(require("./external-eip4361"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/providers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/providers/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,qDAAmC"}

package/dist/cjs/storage.d.ts

@@ -0,0 +1,7 @@
+import { AuthSignature } from './index';
+export declare class LocalStorage {
+    private storage;
+    constructor();
+    getAuthSignature(key: string): AuthSignature | null;
+    setAuthSignature(key: string, authSignature: AuthSignature): void;
+}

package/dist/cjs/storage.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocalStorage = void 0;
+const index_1 = require("./index");
+class BrowserStorage {
+    getItem(key) {
+        return localStorage.getItem(key);
+    }
+    setItem(key, value) {
+        localStorage.setItem(key, value);
+    }
+}
+class NodeStorage {
+    storage = {};
+    getItem(key) {
+        return this.storage[key] || null;
+    }
+    setItem(key, value) {
+        this.storage[key] = value;
+    }
+}
+class LocalStorage {
+    storage;
+    constructor() {
+        this.storage =
+            typeof localStorage === 'undefined'
+                ? new NodeStorage()
+                : new BrowserStorage();
+    }
+    getAuthSignature(key) {
+        const asJson = this.storage.getItem(key);
+        if (!asJson) {
+            return null;
+        }
+        return index_1.authSignatureSchema.parse(JSON.parse(asJson));
+    }
+    setAuthSignature(key, authSignature) {
+        const asJson = JSON.stringify(authSignature);
+        this.storage.setItem(key, asJson);
+    }
+}
+exports.LocalStorage = LocalStorage;
+//# sourceMappingURL=storage.js.map

package/dist/cjs/storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../src/storage.ts"],"names":[],"mappings":";;;AAAA,mCAA6D;AAQ7D,MAAM,cAAc;IACX,OAAO,CAAC,GAAW;QACxB,OAAO,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC;IAEM,OAAO,CAAC,GAAW,EAAE,KAAa;QACvC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACnC,CAAC;CACF;AAED,MAAM,WAAW;IACP,OAAO,GAA2B,EAAE,CAAC;IAEtC,OAAO,CAAC,GAAW;QACxB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC;IACnC,CAAC;IAEM,OAAO,CAAC,GAAW,EAAE,KAAa;QACvC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IAC5B,CAAC;CACF;AAED,MAAa,YAAY;IACf,OAAO,CAAW;IAE1B;QACE,IAAI,CAAC,OAAO;YACV,OAAO,YAAY,KAAK,WAAW;gBACjC,CAAC,CAAC,IAAI,WAAW,EAAE;gBACnB,CAAC,CAAC,IAAI,cAAc,EAAE,CAAC;IAC7B,CAAC;IAEM,gBAAgB,CAAC,GAAW;QACjC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,2BAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACvD,CAAC;IAEM,gBAAgB,CAAC,GAAW,EAAE,aAA4B;QAC/D,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACpC,CAAC;CACF;AAtBD,oCAsBC"}

package/dist/es/auth-provider.d.ts

@@ -0,0 +1,12 @@
+import { AuthSignature } from './auth-sig';
+import { EIP4361AuthProvider } from './providers';
+export declare const EIP4361_AUTH_METHOD = "EIP4361";
+export interface AuthProvider {
+    getOrCreateAuthSignature(): Promise<AuthSignature>;
+}
+export type AuthProviders = {
+    [EIP4361_AUTH_METHOD]?: EIP4361AuthProvider;
+    [key: string]: AuthProvider | undefined;
+};
+export declare const USER_ADDRESS_PARAM_DEFAULT = ":userAddress";
+export declare const AUTH_METHOD_FOR_PARAM: Record<string, string>;

package/dist/es/auth-provider.js

@@ -0,0 +1,6 @@
+export const EIP4361_AUTH_METHOD = 'EIP4361';
+export const USER_ADDRESS_PARAM_DEFAULT = ':userAddress';
+export const AUTH_METHOD_FOR_PARAM = {
+    [USER_ADDRESS_PARAM_DEFAULT]: EIP4361_AUTH_METHOD,
+};
+//# sourceMappingURL=auth-provider.js.map

package/dist/es/auth-provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-provider.js","sourceRoot":"","sources":["../../src/auth-provider.ts"],"names":[],"mappings":"AAGA,MAAM,CAAC,MAAM,mBAAmB,GAAG,SAAS,CAAC;AAY7C,MAAM,CAAC,MAAM,0BAA0B,GAAG,cAAc,CAAC;AAEzD,MAAM,CAAC,MAAM,qBAAqB,GAA2B;IAC3D,CAAC,0BAA0B,CAAC,EAAE,mBAAmB;CAClD,CAAC"}

package/dist/es/auth-sig.d.ts

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+export declare const authSignatureSchema: z.ZodObject<{
+    signature: z.ZodString;
+    address: z.ZodEffects<z.ZodString, string, string>;
+    scheme: z.ZodEnum<["EIP4361"]>;
+    typedData: z.ZodEffects<z.ZodString, string, string>;
+}, "strip", z.ZodTypeAny, {
+    signature: string;
+    address: string;
+    scheme: "EIP4361";
+    typedData: string;
+}, {
+    signature: string;
+    address: string;
+    scheme: "EIP4361";
+    typedData: string;
+}>;
+export type AuthSignature = z.infer<typeof authSignatureSchema>;

package/dist/es/auth-sig.js

@@ -0,0 +1,11 @@
+import { EthAddressSchema } from '@nucypher/shared';
+import { z } from 'zod';
+import { EIP4361_AUTH_METHOD } from './auth-provider';
+import { EIP4361TypedDataSchema } from './providers';
+export const authSignatureSchema = z.object({
+    signature: z.string(),
+    address: EthAddressSchema,
+    scheme: z.enum([EIP4361_AUTH_METHOD]),
+    typedData: EIP4361TypedDataSchema,
+});
+//# sourceMappingURL=auth-sig.js.map

package/dist/es/auth-sig.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auth-sig.js","sourceRoot":"","sources":["../../src/auth-sig.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAErD,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1C,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE;IACrB,OAAO,EAAE,gBAAgB;IACzB,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,mBAAmB,CAAC,CAAC;IACrC,SAAS,EAAE,sBAAsB;CAClC,CAAC,CAAC"}

package/dist/es/index.d.ts

@@ -0,0 +1,3 @@
+export * from './auth-provider';
+export * from './auth-sig';
+export * from './providers';

package/dist/es/index.js

@@ -0,0 +1,4 @@
+export * from './auth-provider';
+export * from './auth-sig';
+export * from './providers';
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC"}

package/dist/es/providers/eip4361.d.ts

@@ -0,0 +1,18 @@
+import { ethers } from 'ethers';
+import { z } from 'zod';
+import { AuthSignature } from '../auth-sig';
+export declare const EIP4361TypedDataSchema: z.ZodEffects<z.ZodString, string, string>;
+export type EIP4361AuthProviderParams = {
+    domain: string;
+    uri: string;
+};
+export declare class EIP4361AuthProvider {
+    private readonly provider;
+    private readonly signer;
+    private readonly storage;
+    private readonly providerParams;
+    constructor(provider: ethers.providers.Provider, signer: ethers.Signer, providerParams?: EIP4361AuthProviderParams);
+    private getDefaultParameters;
+    getOrCreateAuthSignature(): Promise<AuthSignature>;
+    private createSIWEAuthMessage;
+}

package/dist/es/providers/eip4361.js

@@ -0,0 +1,81 @@
+import { generateNonce, SiweMessage } from 'siwe';
+import { z } from 'zod';
+import { EIP4361_AUTH_METHOD } from '../auth-provider';
+import { LocalStorage } from '../storage';
+const isSiweMessage = (message) => {
+    try {
+        new SiweMessage(message);
+        return true;
+    }
+    catch {
+        return false;
+    }
+};
+export const EIP4361TypedDataSchema = z
+    .string()
+    .refine(isSiweMessage, { message: 'Invalid SIWE message' });
+const ERR_MISSING_SIWE_PARAMETERS = 'Missing default SIWE parameters';
+export class EIP4361AuthProvider {
+    provider;
+    signer;
+    storage;
+    providerParams;
+    constructor(
+    // TODO: We only need the provider to fetch the chainId, consider removing it
+    provider, signer, providerParams) {
+        this.provider = provider;
+        this.signer = signer;
+        this.storage = new LocalStorage();
+        if (providerParams) {
+            this.providerParams = providerParams;
+        }
+        else {
+            this.providerParams = this.getDefaultParameters();
+        }
+    }
+    getDefaultParameters() {
+        if (typeof window !== 'undefined') {
+            // If we are in a browser environment, we can get the domain and uri from the window object
+            return {
+                domain: window.location?.host,
+                uri: window.location?.origin,
+            };
+        }
+        // If not, we have no choice but to throw an error
+        throw new Error(ERR_MISSING_SIWE_PARAMETERS);
+    }
+    async getOrCreateAuthSignature() {
+        const address = await this.signer.getAddress();
+        const storageKey = `eth-${EIP4361_AUTH_METHOD}-message-${address}`;
+        // If we have a signature in localStorage, return it
+        const maybeSignature = this.storage.getAuthSignature(storageKey);
+        if (maybeSignature) {
+            return maybeSignature;
+        }
+        // If at this point we didn't return, we need to create a new message
+        const authMessage = await this.createSIWEAuthMessage();
+        this.storage.setAuthSignature(storageKey, authMessage);
+        return authMessage;
+    }
+    async createSIWEAuthMessage() {
+        const address = await this.signer.getAddress();
+        const { domain, uri } = this.providerParams;
+        const version = '1';
+        const nonce = generateNonce();
+        const chainId = (await this.provider.getNetwork()).chainId;
+        const siweMessage = new SiweMessage({
+            domain,
+            address,
+            statement: `${domain} wants you to sign in with your Ethereum account: ${address}`,
+            uri,
+            version,
+            nonce,
+            chainId,
+        });
+        const scheme = EIP4361_AUTH_METHOD;
+        const message = siweMessage.prepareMessage();
+        const signature = await this.signer.signMessage(message);
+        return { signature, address, scheme, typedData: message };
+    }
+}
+//# sourceMappingURL=eip4361.js.map

package/dist/es/providers/eip4361.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eip4361.js","sourceRoot":"","sources":["../../../src/providers/eip4361.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AAClD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAEvD,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE1C,MAAM,aAAa,GAAG,CAAC,OAAe,EAAW,EAAE;IACjD,IAAI,CAAC;QACH,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC;KACpC,MAAM,EAAE;KACR,MAAM,CAAC,aAAa,EAAE,EAAE,OAAO,EAAE,sBAAsB,EAAE,CAAC,CAAC;AAO9D,MAAM,2BAA2B,GAAG,iCAAiC,CAAC;AAEtE,MAAM,OAAO,mBAAmB;IAMX;IACA;IANF,OAAO,CAAe;IACtB,cAAc,CAA4B;IAE3D;IACE,6EAA6E;IAC5D,QAAmC,EACnC,MAAqB,EACtC,cAA0C;QAFzB,aAAQ,GAAR,QAAQ,CAA2B;QACnC,WAAM,GAAN,MAAM,CAAe;QAGtC,IAAI,CAAC,OAAO,GAAG,IAAI,YAAY,EAAE,CAAC;QAClC,IAAI,cAAc,EAAE,CAAC;YACnB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACvC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,oBAAoB,EAAE,CAAC;QACpD,CAAC;IACH,CAAC;IAEO,oBAAoB;QAC1B,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;YAClC,2FAA2F;YAC3F,OAAO;gBACL,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,IAAI;gBAC7B,GAAG,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM;aAC7B,CAAC;QACJ,CAAC;QACD,kDAAkD;QAClD,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IAEM,KAAK,CAAC,wBAAwB;QACnC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;QAC/C,MAAM,UAAU,GAAG,OAAO,mBAAmB,YAAY,OAAO,EAAE,CAAC;QAEnE,oDAAoD;QACpD,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;QACjE,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,cAAc,CAAC;QACxB,CAAC;QAED,qEAAqE;QACrE,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACvD,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QACvD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEO,KAAK,CAAC,qBAAqB;QACjC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;QAC/C,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC;QAC5C,MAAM,OAAO,GAAG,GAAG,CAAC;QACpB,MAAM,KAAK,GAAG,aAAa,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC;QAC3D,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC;YAClC,MAAM;YACN,OAAO;YACP,SAAS,EAAE,GAAG,MAAM,qDAAqD,OAAO,EAAE;YAClF,GAAG;YACH,OAAO;YACP,KAAK;YACL,OAAO;SACR,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,mBAAmB,CAAC;QACnC,MAAM,OAAO,GAAG,WAAW,CAAC,cAAc,EAAE,CAAC;QAC7C,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QACzD,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC;IAC5D,CAAC;CACF"}

package/dist/es/providers/external-eip4361.d.ts

@@ -0,0 +1,9 @@
+import { AuthSignature } from '../auth-sig';
+export declare class SingleSignOnEIP4361AuthProvider {
+    private readonly existingSiweMessage;
+    private readonly address;
+    private readonly signature;
+    static fromExistingSiweInfo(existingSiweMessage: string, signature: string): Promise<SingleSignOnEIP4361AuthProvider>;
+    private constructor();
+    getOrCreateAuthSignature(): Promise<AuthSignature>;
+}

package/dist/es/providers/external-eip4361.js

@@ -0,0 +1,30 @@
+import { SiweMessage } from 'siwe';
+import { EIP4361_AUTH_METHOD } from '../auth-provider';
+export class SingleSignOnEIP4361AuthProvider {
+    existingSiweMessage;
+    address;
+    signature;
+    static async fromExistingSiweInfo(existingSiweMessage, signature) {
+        // validation
+        const siweMessage = new SiweMessage(existingSiweMessage);
+        await siweMessage.verify({ signature });
+        // create provider
+        const authProvider = new SingleSignOnEIP4361AuthProvider(siweMessage.prepareMessage(), siweMessage.address, signature);
+        return authProvider;
+    }
+    constructor(existingSiweMessage, address, signature) {
+        this.existingSiweMessage = existingSiweMessage;
+        this.address = address;
+        this.signature = signature;
+    }
+    async getOrCreateAuthSignature() {
+        const scheme = EIP4361_AUTH_METHOD;
+        return {
+            signature: this.signature,
+            address: this.address,
+            scheme,
+            typedData: this.existingSiweMessage,
+        };
+    }
+}
+//# sourceMappingURL=external-eip4361.js.map

package/dist/es/providers/external-eip4361.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"external-eip4361.js","sourceRoot":"","sources":["../../../src/providers/external-eip4361.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,MAAM,CAAC;AAEnC,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAGvD,MAAM,OAAO,+BAA+B;IAkBvB;IACA;IACA;IAnBZ,MAAM,CAAC,KAAK,CAAC,oBAAoB,CACtC,mBAA2B,EAC3B,SAAiB;QAEjB,aAAa;QACb,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,mBAAmB,CAAC,CAAC;QACzD,MAAM,WAAW,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;QACxC,kBAAkB;QAClB,MAAM,YAAY,GAAG,IAAI,+BAA+B,CACtD,WAAW,CAAC,cAAc,EAAE,EAC5B,WAAW,CAAC,OAAO,EACnB,SAAS,CACV,CAAC;QACF,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,YACmB,mBAA2B,EAC3B,OAAe,EACf,SAAiB;QAFjB,wBAAmB,GAAnB,mBAAmB,CAAQ;QAC3B,YAAO,GAAP,OAAO,CAAQ;QACf,cAAS,GAAT,SAAS,CAAQ;IACjC,CAAC;IAEG,KAAK,CAAC,wBAAwB;QACnC,MAAM,MAAM,GAAG,mBAAmB,CAAC;QACnC,OAAO;YACL,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM;YACN,SAAS,EAAE,IAAI,CAAC,mBAAmB;SACpC,CAAC;IACJ,CAAC;CACF"}

package/dist/es/providers/index.d.ts

@@ -0,0 +1,2 @@
+export * from './eip4361';
+export * from './external-eip4361';

package/dist/es/providers/index.js

@@ -0,0 +1,3 @@
+export * from './eip4361';
+export * from './external-eip4361';
+//# sourceMappingURL=index.js.map

package/dist/es/providers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/providers/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC"}

package/dist/es/storage.d.ts

@@ -0,0 +1,7 @@
+import { AuthSignature } from './index';
+export declare class LocalStorage {
+    private storage;
+    constructor();
+    getAuthSignature(key: string): AuthSignature | null;
+    setAuthSignature(key: string, authSignature: AuthSignature): void;
+}

package/dist/es/storage.js

@@ -0,0 +1,39 @@
+import { authSignatureSchema } from './index';
+class BrowserStorage {
+    getItem(key) {
+        return localStorage.getItem(key);
+    }
+    setItem(key, value) {
+        localStorage.setItem(key, value);
+    }
+}
+class NodeStorage {
+    storage = {};
+    getItem(key) {
+        return this.storage[key] || null;
+    }
+    setItem(key, value) {
+        this.storage[key] = value;
+    }
+}
+export class LocalStorage {
+    storage;
+    constructor() {
+        this.storage =
+            typeof localStorage === 'undefined'
+                ? new NodeStorage()
+                : new BrowserStorage();
+    }
+    getAuthSignature(key) {
+        const asJson = this.storage.getItem(key);
+        if (!asJson) {
+            return null;
+        }
+        return authSignatureSchema.parse(JSON.parse(asJson));
+    }
+    setAuthSignature(key, authSignature) {
+        const asJson = JSON.stringify(authSignature);
+        this.storage.setItem(key, asJson);
+    }
+}
+//# sourceMappingURL=storage.js.map

package/dist/es/storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../src/storage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiB,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAQ7D,MAAM,cAAc;IACX,OAAO,CAAC,GAAW;QACxB,OAAO,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC;IAEM,OAAO,CAAC,GAAW,EAAE,KAAa;QACvC,YAAY,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACnC,CAAC;CACF;AAED,MAAM,WAAW;IACP,OAAO,GAA2B,EAAE,CAAC;IAEtC,OAAO,CAAC,GAAW;QACxB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC;IACnC,CAAC;IAEM,OAAO,CAAC,GAAW,EAAE,KAAa;QACvC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IAC5B,CAAC;CACF;AAED,MAAM,OAAO,YAAY;IACf,OAAO,CAAW;IAE1B;QACE,IAAI,CAAC,OAAO;YACV,OAAO,YAAY,KAAK,WAAW;gBACjC,CAAC,CAAC,IAAI,WAAW,EAAE;gBACnB,CAAC,CAAC,IAAI,cAAc,EAAE,CAAC;IAC7B,CAAC;IAEM,gBAAgB,CAAC,GAAW;QACjC,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IACvD,CAAC;IAEM,gBAAgB,CAAC,GAAW,EAAE,aAA4B;QAC/D,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAC7C,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACpC,CAAC;CACF"}