-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor: revamp
starkNet_signMessage (#321)
* chore: revamp sign message * chore: add comment
- Loading branch information
1 parent
22524fb
commit 1922348
Showing
6 changed files
with
144 additions
and
190 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export * from './signMessage'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| import type { Component } from '@metamask/snaps-sdk'; | ||
| import { | ||
| heading, | ||
| row, | ||
| text, | ||
| UserRejectedRequestError, | ||
| } from '@metamask/snaps-sdk'; | ||
| import type { Infer } from 'superstruct'; | ||
| import { array, object, string, assign } from 'superstruct'; | ||
|
|
||
| import { | ||
| confirmDialog, | ||
| AddressStruct, | ||
| toJson, | ||
| TypeDataStruct, | ||
| AuthorizableStruct, | ||
| BaseRequestStruct, | ||
| AccountRpcController, | ||
| } from '../utils'; | ||
| import { signMessage as signMessageUtil } from '../utils/starknetUtils'; | ||
|
|
||
| export const SignMessageRequestStruct = assign( | ||
| object({ | ||
| address: AddressStruct, | ||
| typedDataMessage: TypeDataStruct, | ||
| }), | ||
| AuthorizableStruct, | ||
| BaseRequestStruct, | ||
| ); | ||
|
|
||
| export const SignMessageResponseStruct = array(string()); | ||
|
|
||
| export type SignMessageParams = Infer<typeof SignMessageRequestStruct>; | ||
|
|
||
| export type SignMessageResponse = Infer<typeof SignMessageResponseStruct>; | ||
|
|
||
| /** | ||
| * The RPC handler to sign a message. | ||
| */ | ||
| export class SignMessageRpc extends AccountRpcController< | ||
| SignMessageParams, | ||
| SignMessageResponse | ||
| > { | ||
| protected requestStruct = SignMessageRequestStruct; | ||
|
|
||
| protected responseStruct = SignMessageResponseStruct; | ||
|
|
||
| /** | ||
| * Execute the sign message request handler. | ||
| * It will show a confirmation dialog to the user before signing the message. | ||
| * | ||
| * @param params - The parameters of the request. | ||
| * @param params.address - The address of the signer. | ||
| * @param params.typedDataMessage - The Starknet type data message to sign. | ||
| * @param [params.enableAuthorize] - Optional, a flag to enable or display the confirmation dialog to the user. | ||
| * @param params.chainId - The chain id of the network. | ||
| * @returns the signature of the message in string array. | ||
| */ | ||
| async execute(params: SignMessageParams): Promise<SignMessageResponse> { | ||
| return super.execute(params); | ||
| } | ||
|
|
||
| protected async handleRequest( | ||
| params: SignMessageParams, | ||
| ): Promise<SignMessageResponse> { | ||
| const { enableAuthorize, typedDataMessage, address } = params; | ||
| if ( | ||
| // Get Starknet expected not to show the confirm dialog, therefore, `enableAuthorize` will set to false to bypass the confirmation | ||
| // TODO: enableAuthorize should set default to true | ||
| enableAuthorize && | ||
| !(await this.getSignMessageConsensus(typedDataMessage, address)) | ||
| ) { | ||
| throw new UserRejectedRequestError() as unknown as Error; | ||
| } | ||
|
|
||
| return await signMessageUtil( | ||
| this.account.privateKey, | ||
| typedDataMessage, | ||
| address, | ||
| ); | ||
| } | ||
|
|
||
| protected async getSignMessageConsensus( | ||
| typedDataMessage: Infer<typeof TypeDataStruct>, | ||
| address: string, | ||
| ) { | ||
| const components: Component[] = []; | ||
| components.push(heading('Do you want to sign this message?')); | ||
| components.push( | ||
| row( | ||
| 'Message', | ||
| text({ | ||
| value: toJson(typedDataMessage), | ||
| markdown: false, | ||
| }), | ||
| ), | ||
| ); | ||
| components.push( | ||
| row( | ||
| 'Signer Address', | ||
| text({ | ||
| value: address, | ||
| markdown: false, | ||
| }), | ||
| ), | ||
| ); | ||
|
|
||
| return await confirmDialog(components); | ||
| } | ||
| } | ||
|
|
||
| export const signMessage = new SignMessageRpc(); |
Oops, something went wrong.