diff --git a/18.md b/18.md new file mode 100644 index 00000000..b8542ff9 --- /dev/null +++ b/18.md @@ -0,0 +1,208 @@ +NUT-18: Mint tokens Bitcoin On-Chain +========================== + +`optional` + +--- + +This NUT describes the process of minting tokens on Bitcoin On-Chain analog to NUT-04 for Bitcoin Lightning. + +# Mint quote + +To request a mint quote, the wallet of `Alice` makes a `POST /v1/mint/quote/{method}` request where `method` is the payment method requested (here `btconchain`). + +```http +POST https://mint.host:3338/v1/mint/quote/btconchain +``` + +The wallet of `Alice` includes the following `PostMintQuoteBtcOnchainRequest` data in its request: + +```json +{ + "amount": , + "unit": +} +``` + with the requested `amount` and the `unit`. + + The mint `Bob` then responds with a `PostMintQuoteBtcOnchainResponse`: + +```json +{ + "quote": , + "address": , + "state": , + "expiry": +} +``` + +Where `quote` is the quote ID and `address` is the payment request to fulfill. + +`state` is an enum string field with possible values `"UNPAID"`, `"PAID"`, `"PENDING"`, `"ISSUED"`: +- `"UNPAID"` means that the quote's request has not been paid yet. +- `"PAID"` means that the request has been paid. +- `"PENDING"` means that the quote is currently being issued. +- `"ISSUED"` means that the quote has already been issued. + +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. + +## Example + +Request of `Alice` with curl: + +```bash +curl -X POST https://mint.host:3338/v1/mint/quote/btconchain -d '{"amount": 10, "unit": "sat"}' -H "Content-Type: application/json" +``` + +Response of `Bob`: + +```json +{ + "quote": "DSGLX9kevM...", + "address": "bc1qkyfgd7mus7ykfd7qkwakq75qsf7rtm...", + "state": "UNPAID", + "expiry": 1701704757 +} +``` + +The wallet **MUST** store the `amount` in the request and the `quote` id in the response in its database so it can later request the tokens after paying the request. After payment, the wallet continues with the next section. + +## Check mint quote state + +To check whether a mint quote has been paid, `Alice` makes a `GET /v1/mint/quote/btconchain/{quote_id}`. + +```http +GET https://mint.host:3338/v1/mint/quote/btconchain/{quote_id} +``` + +Like before, the mint `Bob` responds with a `PostMintQuoteBtcOnchainResponse`. + +Example request of `Alice` with curl: + +```bash +curl -X GET https://mint.host:3338/v1/mint/quote/btconchain/DSGLX9kevM... +``` + +# Minting tokens + +After requesting a mint quote and paying the request, the wallet proceeds with minting new tokens by calling the `POST /v1/mint/{method}` endpoint where `method` is the payment method requested (here `btconchain`). + +```http +POST https://mint.host:3338/v1/mint/btconchain +``` + +The wallet `Alice` includes the following `PostMintBtcOnchainRequest` data in its request + +```json +{ + "quote": , + "outputs": +} +``` + with the `quote` being the quote ID from the previous step and `outputs` being `BlindedMessages` (see [NUT-00][00]) that the wallet requests signatures on whose sum is `amount` as requested in the quote. + + The mint `Bob` then responds with a `PostMintBtcOnchainResponse`: + +```json +{ + "signatures": +} +``` + +where `signatures` is an array of blind signatures on the outputs. + +## Example + +Request of `Alice` with curl: + +```bash +curl -X POST https://mint.host:3338/v1/mint/btconchain -H "Content-Type: application/json" -d \ +'{ + "quote": "DSGLX9kevM...", + "outputs": [ + { + "amount": 8, + "id": "009a1f293253e41e", + "B_": "035015e6d7ade60ba8426cefaf1832bbd27257636e44a76b922d78e79b47cb689d" + }, + { + "amount": 2, + "id": "009a1f293253e41e", + "B_": "0288d7649652d0a83fc9c966c969fb217f15904431e61a44b14999fabc1b5d9ac6" + } + ] +}' +``` + +Response of `Bob`: + +```json +{ + "signatures": [ + { + "id": "009a1f293253e41e", + "amount": 2, + "C_": "0224f1c4c564230ad3d96c5033efdc425582397a5a7691d600202732edc6d4b1ec" + }, + { + "id": "009a1f293253e41e", + "amount": 8, + "C_": "0277d1de806ed177007e5b94a8139343b6382e472c752a74e99949d511f7194f6c" + } + ] +} +``` + +## Unblinding signatures + +Upon receiving the `BlindSignatures` from the mint `Bob`, the wallet of `Alice` unblinds them to generate `Proofs` (using the blinding factor `r` and the mint's public key `K`, see BDHKE [NUT-00][00]). The wallet then stores these `Proofs` in its database: + +```json +[ + { + "id": "009a1f293253e41e", + "amount": 2, + "secret": "407915bc212be61a77e3e6d2aeb4c727980bda51cd06a6afc29e2861768a7837", + "C": "02bc9097997d81afb2cc7346b5e4345a9346bd2a506eb7958598a72f0cf85163ea" + }, + { + "id": "009a1f293253e41e", + "amount": 8, + "secret": "fe15109314e61d7756b0f8ee0f23a624acaa3f4e042f61433c728c7057b931be", + "C": "029e8e5050b890a7d6c0968db16bc1d5d5fa040ea1de284f6ec69d61299f671059" + } +] +``` + +## Settings +The settings for this nut indicate the supported method-unit pairs for minting and whether minting is supported or not. They are part of the info response of the mint ([NUT-06][06]) which in this case reads +```json +{ + "18": { + "supported": true, + "methods": [ + { + "method": "btconchain", + "unit": "sat", + "min_amount": 10000, + "max_amount": 1000000, + "min_confirmations": 3 + } + ] + } +} +``` + +[00]: 00.md +[01]: 01.md +[02]: 02.md +[03]: 03.md +[04]: 04.md +[05]: 05.md +[06]: 06.md +[07]: 07.md +[08]: 08.md +[09]: 09.md +[10]: 10.md +[11]: 11.md +[12]: 12.md diff --git a/19.md b/19.md new file mode 100644 index 00000000..c4340dd0 --- /dev/null +++ b/19.md @@ -0,0 +1,200 @@ +NUT-19: Melt tokens Bitcoin On-Chain +========================== + +`optional` + +--- + +This NUT describes the process of melting tokens on Bitcoin On-Chain analog to NUT-05 for Bitcoin Lightning. + +# Melt quote + +To request a melt quote, the wallet of `Alice` makes a `POST /v1/melt/quote/{method}` request where `method` is the payment method requested (here `btconchain`). + +```http +POST https://mint.host:3338/v1/melt/quote/btconchain +``` + +The wallet `Alice` includes the following `PostMeltQuoteBtcOnchainRequest` data in its request: + +```json +{ + "amount": , + "address": , + "unit": +} +``` + +Here, `address` is the Bitcoin on chain address to be paid and `unit` is the unit the wallet would like to pay with. + +The mint `Bob` then responds with an array of `PostMeltQuoteBtcOnchainResponse`: + + +```json +[ + { + "quote": , + "description": , + "amount": , + "fee": , + "state": , + "expiry": + } +] +``` +The mint can return multiple `PostMeltQuoteBtcOnchainResponse` with different `fees` and `expiry` dates. The wallet can choose which one to pay and the other ones will expire. Where `quote` is the quote ID, `amount` the amount that needs to be provided, and `fee` the additional fee that is required. The mint expects `Alice` to include `Proofs` of *at least* `total_amount = amount + fee`. `paid` indicates whether the request as been paid and `expiry` is the Unix timestamp until which the melt quote is valid. + +## Example + +Request of `Alice` with curl: + +```bash +curl -X POST https://mint.host:3338/v1/melt/quote/btconchain -d \ +{ + "address": "bc1qkyfgd7mus7ykfd7qkwakq75qsf7rtm...", + "unit": "sat" +} +``` + +Response of `Bob`: + +```json +[ + { + "quote": "TRmjduhIsPxd...", + "description": "1 sat per vbyte", + "amount": 10, + "fee": 2, + "state": "UNPAID", + "expiry": 1701704757 + }, + { + "quote": "OewtRaqe...", + "description": "5 sat per vbyte", + "amount": 10, + "fee": 10, + "state": "UNPAID", + "expiry": 1701704757 + } +] +``` + +## Check melt quote state + +To check whether a melt quote has been paid, `Alice` makes a `GET /v1/melt/quote/btconchain/{quote_id}`. + +```http +GET https://mint.host:3338/v1/melt/quote/btconchain/{quote_id} +``` + +Like before, the mint `Bob` responds with a `PostMeltQuoteBtcOnchainResponse`. + +Example request of `Alice` with curl: + +```bash +curl -X GET https://mint.host:3338/v1/melt/quote/btconchain/TRmjduhIsPxd... +``` + +# Melting tokens + +Now that `Alice` knows what the total amount is (`amount + fee`) in her requested `unit`, she can proceed for melting tokens for which a payment will be executed by the mint. She calls the `POST /v1/melt/{method}` endpoint where `method` is the payment method requested (here `btconchain`). + +```http +POST https://mint.host:3338/v1/melt/btconchain +``` + +The wallet of `Alice` includes the following `PostMeltBtcOnchainRequest` data in its request + +```json +{ + "quote": , + "inputs": +} +``` + +Here, `quote` is the melt quote ID to be paid and `inputs` are the proofs with a total amount of at least `amount + fee` (see previous melt quote response). + +The mint `Bob` then responds with a `PostMeltBtcOnchainResponse`: + +```json +{ + "state": , + "txid": +} +``` + +`txid` is the Bitcoin on chain transaction id of the transmitted transaction. + +`state` is an enum string field with possible values `"UNPAID"`, `"PENDING"`, `"PAID"`: +- `"UNPAID"` means that the request has not been paid yet. +- `"PENDING"` means that the request is currently being paid. +- `"PAID"` means that the request has been paid successfully. + +If `state==PAID`, `Alice`'s wallet can delete the `inputs` from her database (or move them to a history). If `paid==PENDING`, `Alice` can repeat the same request again until the payment is successful. + +## Example + +Request of `Alice` with curl: + +```bash +curl -X POST https://mint.host:3338/v1/melt/btconchain -d \ +'{ + "quote": "od4CN5smMMS3K3QVHkbGGNCTxfcAIyIXeq8IrfhP", + "inputs": [ + { + "amount": 4, + "id": "009a1f293253e41e", + "secret": "429700b812a58436be2629af8731a31a37fce54dbf8cbbe90b3f8553179d23f5", + "C": "03b01869f528337e161a6768b480fcf9f75fd248b649c382f5e352489fd84fd011", + }, + { + "amount": 8, + "id": "009a1f293253e41e", + "secret": "4f3155acef6481108fcf354f6d06e504ce8b441e617d30c88924991298cdbcad", + "C": "0278ab1c1af35487a5ea903b693e96447b2034d0fd6bac529e753097743bf73ca9", + } + ] +}' +``` + +Response of `Bob`: + +```json +{ + "state": "PENDING", + "txid": "61470d1816e107165e08eb12a8526e7f6da9f6432fbb9da9f50fd0feb290a584" +} +``` + + +# Settings +The settings for this nut indicate the supported method-unit pairs for melting. They are part of the info response of the mint ([NUT-06][06]) which in this case reads +```json +{ + "19": { + "supported": true, + "methods": [ + { + "method": "btconchain", + "unit": "sat", + "min_amount": 1000, + "max_amount": 1000000 + } + ] + } +} +``` + +[00]: 00.md +[01]: 01.md +[02]: 02.md +[03]: 03.md +[04]: 04.md +[05]: 05.md +[06]: 06.md +[07]: 07.md +[08]: 08.md +[09]: 09.md +[10]: 10.md +[11]: 11.md +[12]: 12.md diff --git a/README.md b/README.md index 910b52a4..beb7b5ac 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,8 @@ Wallets and mints `MUST` implement all mandatory specs and `CAN` implement optio | [15][15] | Partial multi-path payments (MPP) | [Nutshell][py] | [Nutshell][py] | | [16][16] | Animated QR codes | [Cashu.me][cashume] | - | | [17][17] | WebSocket subscriptions | [Nutshell][py] | [Nutshell][py] | +| [18][18] | Mint tokens Bitcoin On-Chain | [Moksha][moksha] | [Moksha][moksha] | +| [19][19] | Melt tokens Bitcoin On-Chain | [Moksha][moksha] | [Moksha][moksha] | #### Wallets: @@ -85,3 +87,5 @@ Wallets and mints `MUST` implement all mandatory specs and `CAN` implement optio [15]: 15.md [16]: 16.md [17]: 17.md +[18]: 18.md +[19]: 19.md