@arcblock/did-connect-js 1.30.0 → 4.0.0-beta.10

package/dist/authenticator/wallet.d.ts

@@ -0,0 +1,252 @@
+import BaseAuthenticator from './base.js';
+export interface ApplicationInfo {
+    name: string;
+    description: string;
+    icon: string;
+    link?: string;
+    path?: string;
+    publisher?: string;
+}
+export interface ChainInfo {
+    id: string;
+    type: string;
+    host: string;
+}
+/**
+ * Encodes an on-chain transaction into a signed buffer.
+ *
+ * Inject this to support `signature` / `prepareTx` claims that reference
+ * concrete transaction types (e.g. `TransferV2Tx`).  When omitted, those
+ * code paths throw a clear error — lightweight runtimes (Cloudflare Workers,
+ * Edge) can skip the ~2.5 MB `@ocap/client` dependency entirely.
+ *
+ * A typical implementation using `@ocap/client`:
+ * ```ts
+ * import Client from '@ocap/client';
+ * const txEncoder: TxEncoder = async ({ type, data, wallet, chainHost }) => {
+ *   const client = new Client(chainHost);
+ *   const { buffer } = await client[`encode${type}`]({ tx: data, wallet });
+ *   return buffer;
+ * };
+ * ```
+ */
+export type TxEncoder = (params: {
+    /** Transaction type name, e.g. `"TransferV2Tx"` */
+    type: string;
+    /** Transaction data object */
+    data: any;
+    /** Wallet used for encoding */
+    wallet: any;
+    /** Chain RPC endpoint */
+    chainHost: string;
+}) => Promise<Buffer>;
+export interface WalletAuthenticatorConfig {
+    wallet: any;
+    appInfo: ApplicationInfo | ((params: any) => ApplicationInfo | Promise<ApplicationInfo>);
+    memberAppInfo?: ApplicationInfo | ((params: any) => ApplicationInfo | Promise<ApplicationInfo>) | null;
+    delegator?: any;
+    delegation?: string | ((params: any) => string | Promise<string>);
+    timeout?: number;
+    chainInfo?: ChainInfo | ((params: any) => ChainInfo | Promise<ChainInfo>);
+    baseUrl?: string;
+    tokenKey?: string;
+    /** Optional transaction encoder — required only when using on-chain Tx signature claims. */
+    txEncoder?: TxEncoder;
+}
+declare class WalletAuthenticator extends BaseAuthenticator {
+    wallet: any;
+    appInfo: any;
+    memberAppInfo: any;
+    chainInfo: any;
+    delegator: any;
+    delegation: any;
+    baseUrl: string;
+    tokenKey: string;
+    timeout: number;
+    txEncoder?: TxEncoder;
+    static formatDisplay(display: any): string;
+    /**
+     * Creates an instance of DID Authenticator.
+     *
+     * @class
+     * @param {object} config
+     * @param {WalletObject|Function} config.wallet - wallet instance {@see @ocap/wallet} or a function that returns wallet instance
+     * @param {WalletObject|Function} [config.delegator] - the party that authorizes `wallet` to perform actions on behalf of `wallet`
+     * @param {string|Function} [config.delegation] - the jwt token that proves delegation relationship
+     * @param {ApplicationInfo|Function} config.appInfo - application basic info or a function that returns application info
+     * @param {ChainInfo|Function} config.chainInfo - application chain info or a function that returns chain info
+     * @param {Number} [config.timeout=8000] - timeout in milliseconds when generating claim
+     * @param {object} [config.baseUrl] - url to assemble wallet request uri, can be inferred from request object
+     * @param {string} [config.tokenKey='_t_'] - query param key for `token`
+     */
+    constructor({ wallet, appInfo, memberAppInfo, delegator, delegation, timeout, chainInfo, baseUrl, tokenKey, txEncoder, }: WalletAuthenticatorConfig);
+    /**
+     * Generate a deep link url that can be displayed as QRCode for DID Wallet to consume
+     *
+     * @method
+     * @param {object} params
+     * @param {string} params.baseUrl - baseUrl inferred from request object
+     * @param {string} params.pathname - wallet callback pathname
+     * @param {string} params.token - action token
+     * @param {object} params.query - params that should be persisted in wallet callback url
+     * @returns {string}
+     */
+    uri({ baseUrl, pathname, token, query, }?: {
+        baseUrl?: string;
+        pathname?: string;
+        token?: string;
+        query?: Record<string, any>;
+    }): string;
+    /**
+     * Compute public url to return to wallet
+     *
+     * @method
+     * @param {string} pathname
+     * @param {object} params
+     * @returns {string}
+     */
+    getPublicUrl(pathname: string, params?: Record<string, any>, baseUrl?: string): string;
+    /**
+     * Sign a plain response, usually on auth success or error
+     *
+     * @method
+     * @param {object} params
+     * @param {object} params.response - response
+     * @param {string} params.errorMessage - error message, default to empty
+     * @param {string} params.successMessage - success message, default to empty
+     * @param {string} params.nextWorkflow - https://github.com/ArcBlock/ABT-DID-Protocol#concatenate-multiple-workflow
+     * @param {string} params.nextUrl - tell wallet do open this url in webview
+     * @param {object} params.cookies - key-value pairs to be set as cookie before open nextUrl
+     * @param {object} params.storages - key-value pairs to be set as localStorage before open nextUrl
+     * @param {string} baseUrl
+     * @param {object} request
+     * @returns {Promise<object>} { appPk, agentPk, authInfo }
+     */
+    signResponse({ response, errorMessage, successMessage, nextWorkflow, nextUrl, cookies, storages, }: {
+        response?: any;
+        errorMessage?: string;
+        successMessage?: string;
+        nextWorkflow?: string;
+        nextUrl?: string;
+        cookies?: Record<string, any>;
+        storages?: any;
+    }, baseUrl: string, request: any, extraParams?: Record<string, any>): Promise<any>;
+    /**
+     * Sign a auth response that returned to wallet: tell the wallet the appInfo/chainInfo
+     *
+     * @method
+     * @param {object} params
+     * @param {object} params.claims - info required by application to complete the auth
+     * @param {string} params.pathname - pathname to assemble callback url
+     * @param {string} params.baseUrl - baseUrl
+     * @param {object} params.challenge - random challenge to be included in the body
+     * @param {object} params.extraParams - extra query params and locale
+     * @param {object} params.request
+     * @param {object} params.context
+     * @param {string} params.context.token - action token
+     * @param {number} params.context.currentStep - current step
+     * @param {string} [params.context.sharedKey] - shared key between app and wallet
+     * @param {string} [params.context.encryptionKey] - encryption key from wallet
+     * @param {Function} [params.context.mfaCode] - function used to generate mfa code
+     * @param {string} params.context.userDid - decoded from req.query, base58
+     * @param {string} params.context.userPk - decoded from req.query, base58
+     * @param {string} params.context.didwallet - DID Wallet os and version
+     * @returns {Promise<object>} { appPk, agentPk, sharedKey, authInfo }
+     */
+    sign({ context, request, claims, pathname, baseUrl, challenge, extraParams, }: {
+        context: any;
+        request: any;
+        claims: any;
+        pathname?: string;
+        baseUrl?: string;
+        challenge?: string;
+        extraParams?: Record<string, any>;
+    }): Promise<any>;
+    /**
+     * Determine chainInfo on the fly
+     *
+     * @param {object} params - contains the context of this request
+     * @param {object|undefined} [info=undefined] - chain info object or function
+     * @returns {Promise<ChainInfo>}
+     * @memberof WalletAuthenticator
+     */
+    getChainInfo(params: any, info?: any): Promise<ChainInfo>;
+    /**
+     * Determine appInfo/memberAppInfo on the fly
+     *
+     * @param {object} params - contains the context of this request
+     * @param {string} key - appInfo | memberAppInfo
+     * @returns {Promise<ApplicationInfo>}
+     * @memberof WalletAuthenticator
+     */
+    getAppInfo(params: any, key?: 'appInfo' | 'memberAppInfo'): Promise<any>;
+    getWalletInfo(params: any): Promise<any>;
+    getDelegator(params: any): Promise<any>;
+    getDelegation(params: any): Promise<any>;
+    /**
+     * Verify a DID auth response sent from DID Wallet
+     *
+     * @method
+     * @param {object} data
+     * @param {string} [locale=en]
+     * @param {boolean} [enforceTimestamp=true]
+     * @returns Promise<boolean>
+     */
+    verify(data: any, locale?: string, enforceTimestamp?: boolean): Promise<{
+        token: any;
+        userDid: string;
+        userPk: any;
+        claims: any;
+        action: any;
+        challenge: any;
+        timestamp: string;
+    }>;
+    genRequestedClaims({ claims, context, extraParams, }: {
+        claims: any;
+        context: any;
+        extraParams: Record<string, any>;
+    }): Promise<any[]>;
+    getClaimInfo({ claim, context, extraParams, }: {
+        claim: any;
+        context: any;
+        extraParams: Record<string, any>;
+    }): Promise<any>;
+    signature({ claim, context, extraParams, }: {
+        claim: any;
+        context: any;
+        extraParams: Record<string, any>;
+    }): Promise<{
+        type: string;
+        description: any;
+        origin: string;
+        typeUrl: any;
+        display: string;
+        method: any;
+        digest: any;
+        chainInfo: any;
+        meta: any;
+        mfa: any;
+        nonce: any;
+        requirement: any;
+    }>;
+    prepareTx({ claim, context, extraParams, }: {
+        claim: any;
+        context: any;
+        extraParams: Record<string, any>;
+    }): Promise<{
+        type: string;
+        description: any;
+        partialTx: string;
+        display: string;
+        requirement: any;
+        chainInfo: any;
+        meta: any;
+        mfa: any;
+        nonce: any;
+    }>;
+    _validateAppInfo(info: any, allowEmpty?: boolean): any;
+    _isValidChainInfo(x: any): boolean;
+    tryWithTimeout<T>(asyncFn: () => Promise<T>, label?: string): Promise<T>;
+}
+export default WalletAuthenticator;
+//# sourceMappingURL=wallet.d.ts.map

package/dist/authenticator/wallet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wallet.d.ts","sourceRoot":"","sources":["../../src/authenticator/wallet.ts"],"names":[],"mappings":"AAOA,OAAO,iBAAyC,MAAM,WAAW,CAAC;AASlE,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,MAAM,EAAE;IAC/B,mDAAmD;IACnD,IAAI,EAAE,MAAM,CAAC;IACb,8BAA8B;IAC9B,IAAI,EAAE,GAAG,CAAC;IACV,+BAA+B;IAC/B,MAAM,EAAE,GAAG,CAAC;IACZ,yBAAyB;IACzB,SAAS,EAAE,MAAM,CAAC;CACnB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AAEtB,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,GAAG,CAAC;IACZ,OAAO,EAAE,eAAe,GAAG,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC;IACzF,aAAa,CAAC,EAAE,eAAe,GAAG,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC,GAAG,IAAI,CAAC;IACvG,SAAS,CAAC,EAAE,GAAG,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAClE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,SAAS,GAAG,CAAC,CAAC,MAAM,EAAE,GAAG,KAAK,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;IAC1E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4FAA4F;IAC5F,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB;AAED,cAAM,mBAAoB,SAAQ,iBAAiB;IACjD,MAAM,EAAE,GAAG,CAAC;IACZ,OAAO,EAAE,GAAG,CAAC;IACb,aAAa,EAAE,GAAG,CAAC;IACnB,SAAS,EAAE,GAAG,CAAC;IACf,SAAS,EAAE,GAAG,CAAC;IACf,UAAU,EAAE,GAAG,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,MAAM,CAAC,aAAa,CAAC,OAAO,EAAE,GAAG,GAAG,MAAM;IAuB1C;;;;;;;;;;;;;OAaG;gBACS,EACV,MAAM,EACN,OAAO,EACP,aAAa,EACb,SAAS,EACT,UAAU,EACV,OAAyB,EACzB,SAA8B,EAC9B,OAAY,EACZ,QAAgB,EAChB,SAAS,GACV,EAAE,yBAAyB;IAqB5B;;;;;;;;;;OAUG;IACH,GAAG,CAAC,EACF,OAAO,EACP,QAAa,EACb,KAAU,EACV,KAAU,GACX,GAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAO;IAY5F;;;;;;;OAOG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM,EAAE,OAAO,SAAK;IAI7E;;;;;;;;;;;;;;;OAeG;IACG,YAAY,CAChB,EACE,QAAa,EACb,YAAiB,EACjB,cAAmB,EACnB,YAAiB,EACjB,OAAY,EACZ,OAAY,EACZ,QAAa,GACd,EAAE;QACD,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC9B,QAAQ,CAAC,EAAE,GAAG,CAAC;KAChB,EACD,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,GAAG,EACZ,WAAW,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM;IAgDvC;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,IAAI,CAAC,EACT,OAAO,EACP,OAAO,EACP,MAAM,EACN,QAAa,EACb,OAAY,EACZ,SAAc,EACd,WAAgB,GACjB,EAAE;QACD,OAAO,EAAE,GAAG,CAAC;QACb,OAAO,EAAE,GAAG,CAAC;QACb,MAAM,EAAE,GAAG,CAAC;QACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACnC;IA8ED;;;;;;;OAOG;IACG,YAAY,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,SAAS,CAAC;IAmB/D;;;;;;;OAOG;IACG,UAAU,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,GAAE,SAAS,GAAG,eAA2B;IAsBpE,aAAa,CAAC,MAAM,EAAE,GAAG;IAWzB,YAAY,CAAC,MAAM,EAAE,GAAG;IASxB,aAAa,CAAC,MAAM,EAAE,GAAG;IAS/B;;;;;;;;OAQG;IACG,MAAM,CAAC,IAAI,EAAE,GAAG,EAAE,MAAM,SAAO,EAAE,gBAAgB,UAAO;;;;;;;;;IAyB9D,kBAAkB,CAAC,EACjB,MAAM,EACN,OAAO,EACP,WAAW,GACZ,EAAE;QACD,MAAM,EAAE,GAAG,CAAC;QACZ,OAAO,EAAE,GAAG,CAAC;QACb,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAClC;IAsCK,YAAY,CAAC,EACjB,KAAK,EACL,OAAO,EACP,WAAW,GACZ,EAAE;QACD,KAAK,EAAE,GAAG,CAAC;QACX,OAAO,EAAE,GAAG,CAAC;QACb,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAClC;IAsBK,SAAS,CAAC,EACd,KAAK,EACL,OAAO,EACP,WAAW,GACZ,EAAE;QACD,KAAK,EAAE,GAAG,CAAC;QACX,OAAO,EAAE,GAAG,CAAC;QACb,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAClC;;;;;;;;;;;;;;IAiHK,SAAS,CAAC,EACd,KAAK,EACL,OAAO,EACP,WAAW,GACZ,EAAE;QACD,KAAK,EAAE,GAAG,CAAC;QACX,OAAO,EAAE,GAAG,CAAC;QACb,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAClC;;;;;;;;;;;IAiFD,gBAAgB,CAAC,IAAI,EAAE,GAAG,EAAE,UAAU,UAAQ;IAoB9C,iBAAiB,CAAC,CAAC,EAAE,GAAG,GAAG,OAAO;IAKlC,cAAc,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,SAAK,GAAG,OAAO,CAAC,CAAC,CAAC;CA4BrE;AAED,eAAe,mBAAmB,CAAC"}