deploy: eddb64f

docs/main/enums/CheckStateEnum.html

@@ -19,7 +19,7 @@ <h1>Enumeration CheckStateEnum</h1></div>
 <div class="tsd-comment tsd-typography"><p>Enum for the state of a proof</p>
 </div></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/6c88848/src/model/types/index.ts#L341">src/model/types/index.ts:341</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/eddb64f/src/model/types/index.ts#L341">src/model/types/index.ts:341</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-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -37,17 +37,17 @@ <h2>Enumeration Members</h2>
 <h3 class="tsd-anchor-link"><span>PENDING</span><a href="#PENDING" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">PENDING</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;PENDING&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/6c88848/src/model/types/index.ts#L343">src/model/types/index.ts:343</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/eddb64f/src/model/types/index.ts#L343">src/model/types/index.ts:343</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="SPENT" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>SPENT</span><a href="#SPENT" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">SPENT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;SPENT&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/6c88848/src/model/types/index.ts#L344">src/model/types/index.ts:344</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/eddb64f/src/model/types/index.ts#L344">src/model/types/index.ts:344</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="UNSPENT" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>UNSPENT</span><a href="#UNSPENT" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">UNSPENT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;UNSPENT&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/6c88848/src/model/types/index.ts#L342">src/model/types/index.ts:342</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/eddb64f/src/model/types/index.ts#L342">src/model/types/index.ts:342</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/main/enums/MeltQuoteState.html

@@ -16,7 +16,7 @@
 <li><a href="MeltQuoteState.html">MeltQuoteState</a></li></ul>
 <h1>Enumeration MeltQuoteState</h1></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/6c88848/src/model/types/index.ts#L149">src/model/types/index.ts:149</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/eddb64f/src/model/types/index.ts#L149">src/model/types/index.ts:149</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-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -34,17 +34,17 @@ <h2>Enumeration Members</h2>
 <h3 class="tsd-anchor-link"><span>PAID</span><a href="#PAID" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">PAID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;PAID&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/6c88848/src/model/types/index.ts#L152">src/model/types/index.ts:152</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/eddb64f/src/model/types/index.ts#L152">src/model/types/index.ts:152</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="PENDING" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>PENDING</span><a href="#PENDING" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">PENDING</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;PENDING&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/6c88848/src/model/types/index.ts#L151">src/model/types/index.ts:151</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/eddb64f/src/model/types/index.ts#L151">src/model/types/index.ts:151</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="UNPAID" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>UNPAID</span><a href="#UNPAID" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">UNPAID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;UNPAID&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/6c88848/src/model/types/index.ts#L150">src/model/types/index.ts:150</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/eddb64f/src/model/types/index.ts#L150">src/model/types/index.ts:150</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/main/enums/MintQuoteState.html

@@ -16,7 +16,7 @@
 <li><a href="MintQuoteState.html">MintQuoteState</a></li></ul>
 <h1>Enumeration MintQuoteState</h1></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/6c88848/src/model/types/index.ts#L280">src/model/types/index.ts:280</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/eddb64f/src/model/types/index.ts#L280">src/model/types/index.ts:280</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-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -34,17 +34,17 @@ <h2>Enumeration Members</h2>
 <h3 class="tsd-anchor-link"><span>ISSUED</span><a href="#ISSUED" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">ISSUED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ISSUED&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/6c88848/src/model/types/index.ts#L283">src/model/types/index.ts:283</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/eddb64f/src/model/types/index.ts#L283">src/model/types/index.ts:283</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="PAID" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>PAID</span><a href="#PAID" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">PAID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;PAID&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/6c88848/src/model/types/index.ts#L282">src/model/types/index.ts:282</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/eddb64f/src/model/types/index.ts#L282">src/model/types/index.ts:282</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member"><a id="UNPAID" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>UNPAID</span><a href="#UNPAID" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-enum-member">UNPAID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;UNPAID&quot;</span></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/6c88848/src/model/types/index.ts#L281">src/model/types/index.ts:281</a></li></ul></aside></section></section></div>
+<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/eddb64f/src/model/types/index.ts#L281">src/model/types/index.ts:281</a></li></ul></aside></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/main/functions/deriveKeysetId.html

@@ -30,7 +30,7 @@ <h5><span class="tsd-kind-parameter">keys</span>: <a href="../types/Keys.html" c
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/6c88848/src/utils.ts#L121">src/utils.ts:121</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/eddb64f/src/utils.ts#L121">src/utils.ts:121</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/main/functions/getDecodedToken.html

@@ -31,7 +31,7 @@ <h5><span class="tsd-kind-parameter">token</span>: <span class="tsd-signature-ty
 <h4 class="tsd-returns-title">Returns <a href="../types/Token.html" class="tsd-signature-type tsd-kind-type-alias">Token</a></h4><p>cashu token object</p>
 <aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/6c88848/src/utils.ts#L84">src/utils.ts:84</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/eddb64f/src/utils.ts#L84">src/utils.ts:84</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/main/functions/getEncodedToken.html

@@ -28,7 +28,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
 <h5><span class="tsd-kind-parameter">token</span>: <a href="../types/Token.html" class="tsd-signature-type tsd-kind-type-alias">Token</a></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/6c88848/src/utils.ts#L75">src/utils.ts:75</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/eddb64f/src/utils.ts#L75">src/utils.ts:75</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/main/functions/setGlobalRequestOptions.html

@@ -30,7 +30,7 @@ <h5><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/6c88848/src/request.ts#L17">src/request.ts:17</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/eddb64f/src/request.ts#L17">src/request.ts:17</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">

docs/main/index.html

@@ -52,7 +52,7 @@ <h2>@cashu/cashu-ts</h2></div>
 <li><input checked="" disabled="" type="checkbox"> v2 read (deprecated)</li>
 <li><input checked="" disabled="" type="checkbox"> v3 read/write</li>
 </ul>
-<a id="md:usage" class="tsd-anchor"></a><h2><a href="#md:usage">Usage</a></h2><p>Go to the <a href="https://cashubtc.github.io/cashu-ts/docs">docs</a> for detailed usage, or have a look at the <a href="./test/integration.test.ts">integration tests</a> for examples on how to implement a wallet.</p>
+<a id="md:usage" class="tsd-anchor"></a><h2><a href="#md:usage">Usage</a></h2><p>Go to the <a href="https://cashubtc.github.io/cashu-ts/docs/main">docs</a> for detailed usage, or have a look at the <a href="./test/integration.test.ts">integration tests</a> for examples on how to implement a wallet.</p>
 <a id="md:install" class="tsd-anchor"></a><h3><a href="#md:install">Install</a></h3><pre><code class="language-shell"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">i</span><span class="hl-1"> </span><span class="hl-2">@cashu/cashu-ts</span>
 </code><button>Copy</button></pre>
 <a id="md:examples" class="tsd-anchor"></a><h3><a href="#md:examples">Examples</a></h3><a id="md:mint-tokens" class="tsd-anchor"></a><h4><a href="#md:mint-tokens">Mint tokens</a></h4><pre><code class="language-typescript"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">CashuMint</span><span class="hl-1">, </span><span class="hl-4">CashuWallet</span><span class="hl-1">, </span><span class="hl-4">MintQuoteState</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">&#39;@cashu/cashu-ts&#39;</span><span class="hl-1">;</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">mintUrl</span><span class="hl-1"> = </span><span class="hl-2">&#39;http://localhost:3338&#39;</span><span class="hl-1">; </span><span class="hl-7">// the mint URL</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">mint</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">CashuMint</span><span class="hl-1">(</span><span class="hl-4">mintUrl</span><span class="hl-1">);</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">wallet</span><span class="hl-1"> = </span><span class="hl-5">new</span><span class="hl-1"> </span><span class="hl-0">CashuWallet</span><span class="hl-1">(</span><span class="hl-4">mint</span><span class="hl-1">);</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">mintQuote</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">wallet</span><span class="hl-1">.</span><span class="hl-0">createMintQuote</span><span class="hl-1">(</span><span class="hl-8">64</span><span class="hl-1">);</span><br/><span class="hl-7">// pay the invoice here before you continue...</span><br/><span class="hl-5">const</span><span class="hl-1"> </span><span class="hl-6">mintQuoteChecked</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">wallet</span><span class="hl-1">.</span><span class="hl-0">checkMintQuote</span><span class="hl-1">(</span><span class="hl-4">mintQuote</span><span class="hl-1">.</span><span class="hl-4">quote</span><span class="hl-1">);</span><br/><span class="hl-3">if</span><span class="hl-1"> (</span><span class="hl-4">mintQuoteChecked</span><span class="hl-1">.</span><span class="hl-4">state</span><span class="hl-1"> == </span><span class="hl-4">MintQuoteState</span><span class="hl-1">.</span><span class="hl-6">PAID</span><span class="hl-1">) {</span><br/><span class="hl-1">    </span><span class="hl-5">const</span><span class="hl-1"> { </span><span class="hl-6">proofs</span><span class="hl-1"> } = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">wallet</span><span class="hl-1">.</span><span class="hl-0">mintTokens</span><span class="hl-1">(</span><span class="hl-8">64</span><span class="hl-1">, </span><span class="hl-4">mintQuote</span><span class="hl-1">.</span><span class="hl-4">quote</span><span class="hl-1">);</span><br/><span class="hl-1">}</span>

docs/main/types/AmountPreference.html

@@ -24,7 +24,7 @@ <h5><span class="tsd-kind-property">amount</span><span class="tsd-signature-symb
 <li class="tsd-parameter">
 <h5><span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/6c88848/src/model/types/index.ts#L554">src/model/types/index.ts:554</a></li></ul></aside></div>
+<li>Defined in <a href="https://github.com/cashubtc/cashu-ts/blob/eddb64f/src/model/types/index.ts#L554">src/model/types/index.ts:554</a></li></ul></aside></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">