/****************************************************************************** * * (C) 2022 AhnLab Blockchain Company, Inc. All rights reserved. * Any part of this source code can not be copied with any method without * prior written permission from the author or authorized person. * ******************************************************************************/ /// import EventEmitter from 'events'; import { MpcService } from '../../usecase/mpc'; import { Account } from '../../schema/model'; /** * Represents, and contains data about, an 'eth_signTypedData' type signature request. These are created when a * signature for an eth_signTypedData call is requested. * * @typedef {Object} TypedMessage * @property {number} id An id to track and identify the message object * @property {Object} msgParams The parameters to pass to the eth_signTypedData method once the signature request is * approved. * @property {Object} msgParams.metamaskId Added to msgParams for tracking and identification within MetaMask. * @property {Object} msgParams.from The address that is making the signature request. * @property {string} msgParams.data A hex string conversion of the raw buffer data of the signature request * @property {number} time The epoch time at which the this message was created * @property {string} status Indicates whether the signature request is 'unapproved', 'approved', 'signed', 'rejected', or 'errored' * @property {string} type The json-prc signing method for which a signature request has been made. A 'Message' will * always have a 'eth_signTypedData' type. * */ declare class TypedMessageManager extends EventEmitter { private mpcService; /** * Controller in charge of managing - storing, adding, removing, updating - TypedMessage. */ messages: any; _getCurrentChainId: any; constructor(mpcService: MpcService); /** * A getter for the number of 'unapproved' TypedMessages in this.messages * * @returns {number} The number of 'unapproved' TypedMessages in this.messages * */ get unapprovedTypedMessagesCount(): number; /** * A getter for the 'unapproved' TypedMessages in this.messages * * @returns {Object} An index of TypedMessage ids to TypedMessages, for all 'unapproved' TypedMessages in * this.messages * */ personalSign(dto: any): Promise; getUnapprovedMsgs(): any; /** * Creates a new TypedMessage with an 'unapproved' status using the passed msgParams. this.addMsg is called to add * the new TypedMessage to this.messages, and to save the unapproved TypedMessages from that list to * this.memStore. Before any of this is done, msgParams are validated * * @param {Object} msgParams - The params for the eth_sign call to be made after the message is approved. * @param {Object} [req] - The original request object possibly containing the origin * @returns {promise} When the message has been signed or rejected * */ addUnapprovedMessageAsync(req: any, version: any): Promise; /** * Creates a new TypedMessage with an 'unapproved' status using the passed msgParams. this.addMsg is called to add * the new TypedMessage to this.messages, and to save the unapproved TypedMessages from that list to * this.memStore. Before any of this is done, msgParams are validated * * @param {Object} msgParams - The params for the eth_sign call to be made after the message is approved. * @param {Object} [req] - The original request object possibly containing the origin * @returns {number} The id of the newly created TypedMessage. * */ addUnapprovedMessage(req: any, version: any): Promise; getMsgParams(req: any, version: any): Promise; /** * Helper method for this.addUnapprovedMessage. Validates that the passed params have the required properties. * * @param {Object} params - The params to validate * */ validateParams(params: any): void; /** * Adds a passed TypedMessage to this.messages, and calls this._saveMsgList() to save the unapproved TypedMessages from that * list to this.memStore. * * @param {Message} msg - The TypedMessage to add to this.messages * */ addMsg(msg: any): Promise; /** * Returns a specified TypedMessage. * * @param {number} msgId - The id of the TypedMessage to get * @returns {TypedMessage|undefined} The TypedMessage with the id that matches the passed msgId, or undefined * if no TypedMessage has that id. * */ getMsg(msgId: any): any; /** * Approves a TypedMessage. Sets the message status via a call to this.setMsgStatusApproved, and returns a promise * with any the message params modified for proper signing. * * @param {Object} msgParams - The msgParams to be used when eth_sign is called, plus data added by MetaMask. * @param {Object} msgParams.metamaskId Added to msgParams for tracking and identification within MetaMask. * @returns {Promise} Promises the msgParams object with metamaskId removed. * */ approveMessage(msgParams: any): Promise; /** * Sets a TypedMessage status to 'approved' via a call to this._setMsgStatus. * * @param {number} msgId - The id of the TypedMessage to approve. * */ setMsgStatusApproved(msgId: any): void; /** * Sets a TypedMessage status to 'signed' via a call to this._setMsgStatus and updates that TypedMessage in * this.messages by adding the raw signature data of the signature request to the TypedMessage * * @param {number} msgId - The id of the TypedMessage to sign. * @param {buffer} rawSig - The raw data of the signature request * */ setMsgStatusSigned(msgId: any, rawSig: any): void; /** * Removes the metamaskId property from passed msgParams and returns a promise which resolves the updated msgParams * * @param {Object} msgParams - The msgParams to modify * @returns {Promise} Promises the msgParams with the metamaskId property removed * */ prepMsgForSigning(msgParams: any): Promise; /** * Sets a TypedMessage status to 'rejected' via a call to this._setMsgStatus. * * @param {number} msgId - The id of the TypedMessage to reject. * */ rejectMsg(msgId: any): void; /** * Sets a TypedMessage status to 'errored' via a call to this._setMsgStatus. * * @param {number} msgId - The id of the TypedMessage to error * */ errorMessage(msgId: any, error: any): void; signTypedMessage(msgParams: any, abcAccount: Account): Promise; signTypedMessageV4(message: any, account: Account): Promise; /** * Updates the status of a TypedMessage in this.messages via a call to this._updateMsg * * @private * @param {number} msgId - The id of the TypedMessage to update. * @param {string} status - The new status of the TypedMessage. * @throws A 'TypedMessageManager - TypedMessage not found for id: "${msgId}".' if there is no TypedMessage * in this.messages with an id equal to the passed msgId * @fires An event with a name equal to `${msgId}:${status}`. The TypedMessage is also fired. * @fires If status is 'rejected' or 'signed', an event with a name equal to `${msgId}:finished` is fired along * with the TypedMessage * */ _setMsgStatus(msgId: any, status: any): void; /** * Sets a TypedMessage in this.messages to the passed TypedMessage if the ids are equal. Then saves the * unapprovedTypedMsgs index to storage via this._saveMsgList * * @private * @param {msg} TypedMessage - A TypedMessage that will replace an existing TypedMessage (with the same * id) in this.messages * */ _updateMsg(msg: any): void; /** * Saves the unapproved TypedMessages, and their count, to this.memStore * * @private * @fires 'updateBadge' * */ _saveMsgList(): Promise; } export default TypedMessageManager;