docs: add spendNotes

fedimint · Dec 5, 2024 · 66bbbab · 66bbbab
1 parent c7d09ee
commit 66bbbab
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 10 deletions.
diff --git a/docs/.vitepress/sidebar.ts b/docs/.vitepress/sidebar.ts
@@ -94,7 +94,10 @@ const FedimintWalletSidebar = [
       {
         text: 'MintService',
         base: '/core/FedimintWallet/MintService/',
-        items: [{ text: 'redeemEcash()', link: 'redeemEcash' }],
+        items: [
+          { text: 'redeemEcash()', link: 'redeemEcash' },
+          { text: 'spendNotes()', link: 'spendNotes' },
+        ],
       },
       {
         text: 'FederationService',

diff --git a/docs/core/FedimintWallet/MintService/redeemEcash.md b/docs/core/FedimintWallet/MintService/redeemEcash.md
@@ -7,7 +7,6 @@ Redeem a set of ecash notes.
 ```ts twoslash
 // @esModuleInterop
 import { FedimintWallet } from '@fedimint/core-web'
-import type { LnReceiveState } from '@fedimint/core-web'
 
 const wallet = new FedimintWallet()
 wallet.open()

diff --git a/docs/core/FedimintWallet/MintService/spendNotes.md b/docs/core/FedimintWallet/MintService/spendNotes.md
@@ -1,8 +1,8 @@
-# Redeem Ecash
+# Spend Ecash
 
-### `mint.redeemEcash(notes: string)`
+### `mint.spendNotes(amountMsats: number)`
 
-Redeem a set of ecash notes.
+Generates ecash notes for spending.
 
 ```ts twoslash
 // @esModuleInterop
@@ -12,9 +12,9 @@ import type { LnReceiveState } from '@fedimint/core-web'
 const wallet = new FedimintWallet()
 wallet.open()
 
-try {
-  await wallet.mint.redeemEcash('01...') // [!code focus]
-} catch (error) {
-  console.error('Failed to redeem ecash', error)
-}
+const amountMsats = 10_000 // [!code focus]
+const result = await wallet.mint.spendNotes(amountMsats) // [!code focus]
+
+console.log(result.notes)
+console.log(result.operation_id)
 ```