Skip to content

Latest commit

 

History

History
119 lines (107 loc) · 3.21 KB

06.md

File metadata and controls

119 lines (107 loc) · 3.21 KB
Raw

NUT-06: Mint information

mandatory

This endpoint returns information about the mint that a wallet can show to the user and use to make decisions on how to interact with the mint.

Example

Request of Alice:

GET https://mint.host:3338/v1/info

With the mint's response being of the form GetInfoResponse:

{
  "name": "Bob's Cashu mint",
  "pubkey": "0283bf290884eed3a7ca2663fc0260de2e2064d6b355ea13f98dec004b7a7ead99",
  "version": "Nutshell/0.15.0",
  "description": "The short mint description",
  "description_long": "A description that can be a long piece of text.",
  "contact": [
    {
      "method": "email",
      "info": "contact@me.com"
    },
    {
      "method": "twitter",
      "info": "@me"
    },
    {
      "method": "nostr",
      "info": "npub..."
    }
  ],
  "motd": "Message to display to users.",
  "icon_url": "https://mint.host/icon.jpg",
  "urls": [
    "https://mint.host",
    "http://mint8gv0sq5ul602uxt2fe0t80e3c2bi9fy0cxedp69v1vat6ruj81wv.onion"
  ],
  "time": 1725304480,
  "nuts": {
    "4": {
      "methods": [
        {
          "method": "bolt11",
          "unit": "sat",
          "min_amount": 0,
          "max_amount": 10000
        }
      ],
      "disabled": false
    },
    "5": {
      "methods": [
        {
          "method": "bolt11",
          "unit": "sat",
          "min_amount": 100,
          "max_amount": 10000
        }
      ],
      "disabled": false
    },
    "7": {
      "supported": true
    },
    "8": {
      "supported": true
    },
    "9": {
      "supported": true
    },
    "10": {
      "supported": true
    },
    "12": {
      "supported": true
    }
  }
}
  • (optional) name is the name of the mint and should be recognizable.
  • (optional) pubkey is the hex pubkey of the mint.
  • (optional) version is the implementation name and the version of the software running on this mint separated with a slash "/".
  • (optional) description is a short description of the mint that can be shown in the wallet next to the mint's name.
  • (optional) description_long is a long description that can be shown in an additional field.
  • (optional) contact is an array of contact objects to reach the mint operator. A contact object consists of two fields. The method field denotes the contact method (like "email"), the info field denotes the identifier (like "contact@me.com").
  • (optional) motd is the message of the day that the wallet must display to the user. It should only be used to display important announcements to users, such as scheduled maintenances.
  • (optional) icon_url is the URL pointing to an image to be used as an icon for the mint. Recommended to be squared in shape.
  • (optional) urls is the list of endpoint URLs where the mint is reachable from.
  • (optional) time is the current time set on the server. The value is passed as a Unix timestamp integer.
  • (optional) nuts indicates each NUT specification that the mint supports and its settings. The settings are defined in each NUT separately.

With curl:

curl -X GET https://mint.host:3338/v1/info