Skip to content

feat: add amount to nut05 #173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thesimplekid merged 1 commit into from
Apr 9, 2025
Merged

feat: add amount to nut05 #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions 05.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,15 @@ The wallet `Alice` includes the following `PostMeltQuoteBolt11Request` data in i
{
"request": <str>,
"unit": <str_enum[UNIT]>
"options": { // Optional
"amountless": {
"amount_msat": <int>
}
}
}
```

Here, `request` is the bolt11 Lightning invoice to be paid and `unit` is the unit the wallet would like to pay with.
Here, `request` is the bolt11 Lightning invoice to be paid and `unit` is the unit the wallet would like to pay with. `amount` **MAY** be passed to pay amountless bolt11 invoices. The `amount` **MUST** be in msat and if the bolt11 invoice has an amount, the `amount` field **MUST** be equal to the amount of the bolt11 invoice. The request **MAY** be an amountless invoice only if support for amountless invoices is signaled in the `MeltMethodSettings`.

The mint `Bob` then responds with a `PostMeltQuoteBolt11Response`:

Expand Down Expand Up @@ -188,11 +193,12 @@ The mint's settings for this nut indicate the supported method-unit pairs for me
"method": <str>,
"unit": <str>,
"min_amount": <int|null>,
"max_amount": <int|null>
"max_amount": <int|null>,
"amountless": <bool|null>
}
```

`min_amount` and `max_amount` indicate the minimum and maximum amount for an operation of this method-unit pair.
`min_amount` and `max_amount` indicate the minimum and maximum amount for an operation of this method-unit pair. `amountless` signals if the backed supports paying an amountless invoice.

Example `MeltMethodSetting`:

Expand All @@ -201,7 +207,8 @@ Example `MeltMethodSetting`:
"method": "bolt11",
"unit": "sat",
"min_amount": 100,
"max_amount": 10000
"max_amount": 10000,
"amountless": true
}
```

Expand Down
2 changes: 2 additions & 0 deletions error_codes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
| 11008 | Duplicate outputs provided | [NUT-03][03], [NUT-04][04], [NUT-05][05] |
| 11009 | Inputs/Outputs of multiple units | [NUT-03][03], [NUT-04][04], [NUT-05][05] |
| 11010 | Inputs and outputs not of same unit | [NUT-03][03], [NUT-04][04], [NUT-05][05] |
| 11011 | Amountless invoice is not supported | [NUT-05][05] |
| 11012 | Amount in request does not equal invoice | [NUT-05][05] |
| 12001 | Keyset is not known | [NUT-02][02], [NUT-04][04] |
| 12002 | Keyset is inactive, cannot sign messages | [NUT-02][02], [NUT-03][03], [NUT-04][04] |
| 20001 | Quote request is not paid | [NUT-04][04] |
Expand Down