Skip to content
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

Update 04.md - optional PostMintQuoteBolt11Request keysetId #120

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Update 04.md - optional PostMintQuoteBolt11Request keysetId #120

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
7 changes: 4 additions & 3 deletions 04.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ NUT-04: Mint tokens

Minting tokens is a two-step process: requesting a mint quote and minting new tokens. Here, we describe both steps.

In the first request the wallet asks the mint for a quote for a specific `amount` and `unit` to mint, and the payment `method` to pay. The mint responds with a quote that includes a `quote` id and a payment `request`. The user pays the `request` and, if successful, requests minting of new tokens with the mint in a second request. The wallet includes the `quote` id and new `outputs` in the second request.
In the first request the wallet asks the mint for a quote for a specific `amount` and `unit` to mint, and the payment `method` to pay. The wallet can optionally ask for a quote from a specific `keysetId` allowing for amounts to be specified in a different unit from the keyset. The mint responds with a quote that includes a `quote` id and a payment `request`. The user pays the `request` and, if successful, requests minting of new tokens with the mint in a second request. The wallet includes the `quote` id and new `outputs` in the second request.

We limit this document to mint quotes of `unit="sat"` and `method="bolt11"` which requests a bolt11 Lightning invoice (typically generated by the mint to add Bitcoin to its reserves) to mint ecash denominated in Satoshis.

Expand All @@ -24,7 +24,8 @@ The wallet of `Alice` includes the following `PostMintQuoteBolt11Request` data i
```json
{
"amount": <int>,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1000

"unit": <str_enum["sat"]>
"unit": <str_enum["sat"]>,
"keysetId": <Optional<str>>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1212170660831297556

}
```
with the requested `amount` and the `unit`.
Expand All @@ -40,7 +41,7 @@ The wallet of `Alice` includes the following `PostMintQuoteBolt11Request` data i
}
```

Where `quote` is the quote ID and `request` is the payment request to fulfill. `paid` indicates whether the request as been paid and `expiry` is the Unix timestamp until which the mint quote is valid.
Where `quote` is the quote ID and `request` is the payment request to fulfill. `paid` indicates whether the request as been paid and `expiry` is the Unix timestamp until which the mint quote is valid. If a `keysetId` was provided in the `PostMintQuoteBolt11Request`, the mint should convert the provided `unit` to the requested keyset's unit, and if the specified unit is `sat`, then the mint should return an invoice for that exact sat amount.

Note: `quote` is a **unique and random** id generated by the mint to internally look up the payment state. `quote` **MUST** remain a secret between user and mint and **MUST NOT** be derivable from the payment request. A third party who knows the `quote` ID can front-run and steal the tokens that this operation mints.

Expand Down