UseSignMessageResult
Defined in: packages/react/src/hooks/useSignMessage.ts:14
Properties
Section titled “Properties”data: {
encoding?:"base64"|"hex";format?:"concat"|"der";publicKey?:string;signature:string;signedBy?:string;signingAlgorithmSpec?:"ed25519"|"ecdsa-sha256"; } |undefined
Defined in: packages/react/src/hooks/useSignMessage.ts:26
Result from the last successful signing request
error:
ParsedError|null
Defined in: packages/react/src/hooks/useSignMessage.ts:24
Error from the last signing request
isError
Section titled “isError”isError:
boolean
Defined in: packages/react/src/hooks/useSignMessage.ts:22
Whether the last signing request failed
isPending
Section titled “isPending”isPending:
boolean
Defined in: packages/react/src/hooks/useSignMessage.ts:20
Whether a signing request is in progress
reset()
Section titled “reset()”reset: () =>
void
Defined in: packages/react/src/hooks/useSignMessage.ts:28
Reset the mutation state
Returns
Section titled “Returns”void
signMessage()
Section titled “signMessage()”signMessage: (
params) =>void
Defined in: packages/react/src/hooks/useSignMessage.ts:16
Request a signature from the wallet
Parameters
Section titled “Parameters”params
Section titled “params”message
Section titled “message”string
Returns
Section titled “Returns”void
signMessageAsync()
Section titled “signMessageAsync()”signMessageAsync: (
params) =>Promise<{encoding?:"base64"|"hex";format?:"concat"|"der";publicKey?:string;signature:string;signedBy?:string;signingAlgorithmSpec?:"ed25519"|"ecdsa-sha256"; }>
Defined in: packages/react/src/hooks/useSignMessage.ts:18
Request a signature with promise return
Parameters
Section titled “Parameters”params
Section titled “params”message
Section titled “message”string
Returns
Section titled “Returns”Promise<{ encoding?: "base64" | "hex"; format?: "concat" | "der"; publicKey?: string; signature: string; signedBy?: string; signingAlgorithmSpec?: "ed25519" | "ecdsa-sha256"; }>