ssi.nostr.sign()

Pass message and return the signature by Nostr secret key. You should always read the public key without using cache just before sign/encrypt/decrypt, as the user may change their primary key without notifying you. During the execution process, an internal authorization check is performed similar to browser.ssi.askConsent.

This is an asynchronous function that returns a Promise.

Syntax

const stringValue = await browser.ssi.nostr.sign(
	tabId, // integer
	message, // string
	option, // object
	dialogOption, // optional object
)

Parameters

tabId

integer. This is tabs.Tab.id. See also https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/tabs/Tab#id

message

string. The message to sign. If it’s not a string it must be stringified.

option

object. Direction about sign detail

type

string. The signature spec. e.g., ‘signEvent’

dialogOption (optional)

ssi.DialogInfo. Parameters to build Auth dialog

Return value

A Promise that will be fulfilled with a string of resulting signature. Returns Promise<null> if error.

Examples

Signing event in NIP-07

See also the spec.

const event = {
  kind: 1,
  content: "learning curve proceeds, API and DB schema changed largely. It's time to write document! \nDon't do it before developing except for spec summary and sequence :)",
  created_at: 1737375898,
  pubkey: "3589b793b977c4f025175afd792e7c51d26ef683b45cbc66c56c4d14ad53847e",
  tags: [],
}
const eventHash = bytesToHex(
  sha256(new TextEncoder().encode(JSON.stringify([
    0,
    event.pubkey,
    event.created_at,
    event.kind,
    event.tags,
    event.content,
  ])))
);
const signature = await browser.ssi.nostr.sign(
  1,
  eventHash,
  {
    type: "signEvent",
  },
)
if (!signature) {
  throw new Error("Failed to sign");
}

console.log(signature)
// "4034db40469721e4a5b95722a695bf943131cfab466f1a7f5a6aa70a3f8237dbacf08e06cc6a3f8dbe314313359450b64d75806dfd2e0bb7573ea6e68f43aa86"