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.

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

NUT06: Add Mint TOS to mint info #205

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

Conversation

thesimplekid
Copy link
Collaborator

No description provided.

Copy link
Collaborator

@prusnak prusnak left a comment

Choose a reason for hiding this comment

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

ToS is usually a veeery long document. I think it would be better to replace the tos field with tos_url and provide link to the document instead so the info response is not so big.

As a bonus the document can be easily formatted - let's say in HTML or PDF format.

@@ -44,6 +44,7 @@ With the mint's response being of the form `GetInfoResponse`:
"http://mint8gv0sq5ul602uxt2fe0t80e3c2bi9fy0cxedp69v1vat6ruj81wv.onion"
],
"time": 1725304480,
"tos": "Terms of Service of the mint.",
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
"tos": "Terms of Service of the mint.",
"tos_url": "https://mint.host/tos.pdf",

@@ -96,6 +97,7 @@ With the mint's response being of the form `GetInfoResponse`:
- (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) `tos` is the Terms of Service of the mint.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- (optional) `tos` is the Terms of Service of the mint.
- (optional) `tos_url` is the URL pointing to the Terms of Service of the mint.

@thesimplekid
Copy link
Collaborator Author

ToS is usually a veeery long document. I think it would be better to replace the tos field with tos_url and provide link to the document instead so the info response is not so big.

As a bonus the document can be easily formatted - let's say in HTML or PDF format.

You bring up a good point that including it directly in the info response would increase its size and as this is something that a wallet should fetch often we should avoid this. However, linking to a document without defining a structure or file type would make it very difficult for a client to render and show to an end user. I think the TOS should be just a text string to avoid making it difficult for a wallet to show when the mint is added.

@prusnak
Copy link
Collaborator

prusnak commented Dec 24, 2024

difficult for a wallet to show when the mint is added.

Maybe we should strongly recommend that ToS are in a format easily rendered by a browser/app such as plain-text, Markdown, PDF or HTML?

document without defining a structure

I don't think we can come up with any reasonable structure. Laws in different countries are different.

Btw, I just checked and the current cashu.me (i know that's a wallet not a mint) ToS are currently around 11 KB and they are pretty minimal.

@prusnak
Copy link
Collaborator

prusnak commented Dec 24, 2024

as plain-text, Markdown, PDF or HTML?

Thinking more about this and HTML is probably too dangerous because it can contain some code to deanonymize user when opened :-(

@callebtc
Copy link
Contributor

I would vote for URL. Wallets can render it as a web page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants