coracle/welshman
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
f7baa54724c1cb21218f1c0355d84ad1f71f8ed4
welshman/docs/interfaces/_welshman_signer.ISigner.html
T
Jon Staab f7baa54724 Add documentation
2024-12-13 14:16:38 -08:00

6 lines
13 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ISigner | Welshman Docs</title><meta name="description" content="Documentation for Welshman Docs"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Welshman Docs</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Welshman Docs</a></li><li><a href="../modules/_welshman_signer.html">@welshman/signer</a></li><li><a href="_welshman_signer.ISigner.html">ISigner</a></li></ul><h1>Interface ISigner</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ISigner</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="_welshman_signer.ISigner.html#getpubkey">getPubkey</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="_welshman_signer.ISigner.html#nip04">nip04</a><span class="tsd-signature-symbol">:</span> <a href="../types/_welshman_signer.EncryptionImplementation.html" class="tsd-signature-type tsd-kind-type-alias">EncryptionImplementation</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="_welshman_signer.ISigner.html#nip44">nip44</a><span class="tsd-signature-symbol">:</span> <a href="../types/_welshman_signer.EncryptionImplementation.html" class="tsd-signature-type tsd-kind-type-alias">EncryptionImplementation</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="_welshman_signer.ISigner.html#sign">sign</a><span class="tsd-signature-symbol">:</span> <a href="../types/_welshman_signer.Sign.html" class="tsd-signature-type tsd-kind-type-alias">Sign</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/_welshman_signer.Nip01Signer.html" class="tsd-signature-type tsd-kind-class">Nip01Signer</a></li><li><a href="../classes/_welshman_signer.Nip07Signer.html" class="tsd-signature-type tsd-kind-class">Nip07Signer</a></li><li><a href="../classes/_welshman_signer.Nip46Signer.html" class="tsd-signature-type tsd-kind-class">Nip46Signer</a></li><li><a href="../classes/_welshman_signer.Nip55Signer.html" class="tsd-signature-type tsd-kind-class">Nip55Signer</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/signer/src/util.ts#L51">packages/signer/src/util.ts:51</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_welshman_signer.ISigner.html#getpubkey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Pubkey</span></a>
<a href="_welshman_signer.ISigner.html#nip04" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>nip04</span></a>
<a href="_welshman_signer.ISigner.html#nip44" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>nip44</span></a>
<a href="_welshman_signer.ISigner.html#sign" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sign</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="getpubkey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Pubkey</span><a href="#getpubkey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getPubkey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/signer/src/util.ts#L55">packages/signer/src/util.ts:55</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="nip04" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>nip04</span><a href="#nip04" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">nip04</span><span class="tsd-signature-symbol">:</span> <a href="../types/_welshman_signer.EncryptionImplementation.html" class="tsd-signature-type tsd-kind-type-alias">EncryptionImplementation</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/signer/src/util.ts#L53">packages/signer/src/util.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="nip44" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>nip44</span><a href="#nip44" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">nip44</span><span class="tsd-signature-symbol">:</span> <a href="../types/_welshman_signer.EncryptionImplementation.html" class="tsd-signature-type tsd-kind-type-alias">EncryptionImplementation</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/signer/src/util.ts#L54">packages/signer/src/util.ts:54</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="sign" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sign</span><a href="#sign" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">sign</span><span class="tsd-signature-symbol">:</span> <a href="../types/_welshman_signer.Sign.html" class="tsd-signature-type tsd-kind-type-alias">Sign</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/coracle-social/welshman/blob/627eb1e36d8b3dd92a6191985ade86148497c331/packages/signer/src/util.ts#L52">packages/signer/src/util.ts:52</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#getpubkey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Pubkey</span></a><a href="#nip04" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>nip04</span></a><a href="#nip44" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>nip44</span></a><a href="#sign" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sign</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Welshman Docs</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
Reference in New Issue View Git Blame Copy Permalink