diff --git a/sidekick/src/sidekick.ts b/sidekick/src/sidekick.ts index d6c7fa9..e0391ec 100644 --- a/sidekick/src/sidekick.ts +++ b/sidekick/src/sidekick.ts @@ -854,6 +854,24 @@ address //----------------------------------------------------------------------------- // API: message sign //----------------------------------------------------------------------------- + + +/** + * Sign the given message, return the message signature + * + * @example + * This function is triggered when a "sign message" button is pressed. A text + * input with `id="message-text"` contains the message to be signed. + * ```ts + * async function sign_msg (logger: sk.Logger) : Promise { + * let acc_pubkey : string = pv_address; + * // @ts-ignore value property exists because i say so + * let msg_text : string = document.getElementById('message-text').value; + * let signed_msg = await sk.msg_sign('sk-msg-sign-1', acc_pubkey, msg_text, sk.TIMEOUT_DEF_MSG_SIGN_MS, 'message signing took too long', logger); + * console.log('signed message:', signed_msg); + * } + * ``` + */ async function msg_sign (id : number | string, diff --git a/utils/jex/src/jex.erl b/utils/jex/src/jex.erl index 998d3b7..380a445 100644 --- a/utils/jex/src/jex.erl +++ b/utils/jex/src/jex.erl @@ -195,14 +195,14 @@ cfg() -> -spec cfg(MaybeSafe) -> Result - when MaybeSafe :: safe | unsafe - Result :: {ok, Cfg :: proplist()} + when MaybeSafe :: safe | unsafe, + Result :: {ok, Cfg :: proplists:proplist()} | {error, Reason :: term()}. % @doc "safe" means it checks to make sure the cfg(unsafe) -> - {ok, Terms} = file:consult("jex.eterms"); - Terms; + {ok, Terms} = file:consult("jex.eterms"), + {ok, Terms}; cfg(safe) -> case file:consult("jex.eterms") of {ok, Terms} -> cfg2(Terms);