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

Create stacks caip19.md #68

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Create stacks caip19.md #68

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
94b6ebf
Create stacks caip19.md
friedger May 21, 2023
abf829c
Merge branch 'main' into patch-1
bumblefudge Jun 4, 2024
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
60 changes: 60 additions & 0 deletions stacks/caip19.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
namespace-identifier: stacks-caip19
title: Stacks Namespace - Asset
author: Friedger (@friedger)
discussions-to:
status: Draft
type: Standard
created: 2023-05-21
updated: 2023-05-21
requires: ["CAIP-2", "CAIP-10", "CAIP-19"]
---

# CAIP-19

*For context, see the [CAIP-19][] specification.*

## Rationale

On Stacks, there are three types of native assets: STX, fungible tokens and non-fungible tokens. STX tokens are exposed to the users,
the two others are only internal to smart contracts defined by the programming language Clarity. A Stacks smart contract can define
more than one native fungible or non-fungible token to allow detailed control over assets.

Smart contracts that contain only one fungible token, resp. one non-fungible token defines a Stacks fungible token (FT),
resp. a Stacks non-fungible token (NFT). There are corresponding standards (SIP) exposing token functions to the user.


## Syntax

After the [CAIP-2][] (namespace+chainID), a slash defines an `asset_namespace` and an `asset_reference`.
The `asset_namespace` is defined via the SIP or
Copy link
Collaborator

Choose a reason for hiding this comment

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

sentence fragment? perhaps a commit get left off the PR?


| Reference | Equivalent to | See also |
| :--- | :---- | :--- |
| sip9 | ERC20 Token | |
| sip10 | ERC721 | |
| sip13 | ERC1155 | |
| nft | | SC defining one native non-fungible token but not following sip9 standard |
| ft | | SC defining one native fungible token but not following sip10 standard |


## Examples

```
# Stacks Mainnet NFT：
stacks:1/sip9:SP3D6PV2ACBPEKYJTCMH7HEN02KP87QSP8KTEH335.megapont-space-agency/4
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm sorry but I don't see any explanation of the .megapont-space-agency segment in ## Syntax section, nor would it be allowed by Stacks/caip10 or by caip19 itself... is it really necessary or should that information/disambiguation mechanism live elsewhere, for example, in a query or matrix parameter at the end of the URI?


# Stacks Mainnet xBTC
stacks:1/sip10:SP3DX3H4FEYZJZ586MFBS25ZW3HZDMEW92260R2PR.Wrapped-Bitcoin
Copy link
Collaborator

Choose a reason for hiding this comment

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

The stacks/caip10 syntax is case-insensitive (or all-caps, to be more precise) which I assume is carried over from the Stacks native addressing system. Would it make sense or simplify things for this naming convention to match, to reduce the phishing/impersonation vector of i/I/l/L ambiguities, etc etc?

```

## Links

[CAIP-2]: https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-2.md
[CAIP-10]: https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-10.md
[CAIP-19]: https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-19.md


## Copyright

Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).