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

Multi Token Standard Update #33

Merged
merged 4 commits into from
Jan 13, 2021
Merged

Multi Token Standard Update #33

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9d04c2e
Fix the parameter types to avoid deployment error
sink772 Dec 8, 2020
3687597
Improve the receiver interface for accepting tokens
sink772 Dec 9, 2020
69bd875
Add tokenURI interface for metadata retrieval
sink772 Dec 15, 2020
7d3c8eb
Add URI eventlog
sink772 Jan 13, 2021
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
69 changes: 52 additions & 17 deletions IIPS/iip-31.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,13 @@ def transferFrom(self, _from: Address, _to: Address, _id: int, _value: int, _dat
"""
Transfers `_value` amount of an token `_id` from one address to another address,
and must emit `TransferSingle` event to reflect the balance change.
When the transfer is complete, this method must invoke `tokenFallback(Address,Address,int,int,bytes)` in `_to`,
if `_to` is a contract. If the `tokenFallback` method is not implemented in `_to` (receiver contract),
When the transfer is complete, this method must invoke `onIRC31Received(Address,Address,int,int,bytes)` in `_to`,
if `_to` is a contract. If the `onIRC31Received` method is not implemented in `_to` (receiver contract),
then the transaction must fail and the transfer of tokens should not occur.
If `_to` is an externally owned address, then the transaction must be sent without trying to execute
`tokenFallback` in `_to`.
`onIRC31Received` in `_to`.
Additional `_data` can be attached to this token transaction, and it should be sent unaltered in call
to `tokenFallback` in `_to`. `_data` can be empty.
to `onIRC31Received` in `_to`. `_data` can be empty.
Throws unless the caller is the current token holder or the approved address for the token ID.
Throws if `_from` does not have enough amount to transfer for the token ID.
Throws if `_to` is the zero address.
Expand All @@ -90,14 +90,14 @@ def transferFromBatch(self, _from: Address, _to: Address, _ids: List[int], _valu
"""
Transfers `_values` amount(s) of token(s) `_ids` from one address to another address,
and must emit `TransferSingle` or `TransferBatch` event(s) to reflect all the balance changes.
When all the transfers are complete, this method must invoke `tokenFallback(Address,Address,int,int,bytes)` or
`tokenFallbackBatch(Address,Address,int[],int[],bytes)` in `_to`,
if `_to` is a contract. If the `tokenFallback` method is not implemented in `_to` (receiver contract),
When all the transfers are complete, this method must invoke `onIRC31Received(Address,Address,int,int,bytes)` or
`onIRC31BatchReceived(Address,Address,int[],int[],bytes)` in `_to`,
if `_to` is a contract. If the `onIRC31Received` method is not implemented in `_to` (receiver contract),
then the transaction must fail and the transfers of tokens should not occur.
If `_to` is an externally owned address, then the transaction must be sent without trying to execute
`tokenFallback` in `_to`.
`onIRC31Received` in `_to`.
Additional `_data` can be attached to this token transaction, and it should be sent unaltered in call
to `tokenFallback` in `_to`. `_data` can be empty.
to `onIRC31Received` in `_to`. `_data` can be empty.
Throws unless the caller is the current token holder or the approved address for the token IDs.
Throws if length of `_ids` is not the same as length of `_values`.
Throws if `_from` does not have enough amount to transfer for any of the token IDs.
Expand Down Expand Up @@ -159,7 +159,7 @@ def TransferSingle(self, _operator: Address, _from: Address, _to: Address, _id:
#### TransferBatch
```python
@eventlog(indexed=3)
def TransferBatch(self, _operator: Address, _from: Address, _to: Address, _ids: List[int], _values: List[int]):
def TransferBatch(self, _operator: Address, _from: Address, _to: Address, _ids: bytes, _values: bytes):
"""
Must trigger on any successful token transfers, including zero value transfers as well as minting or burning.
When minting/creating tokens, the `_from` must be set to zero address.
Expand All @@ -168,8 +168,10 @@ def TransferBatch(self, _operator: Address, _from: Address, _to: Address, _ids:
:param _operator: the address of an account/contract that is approved to make the transfer
:param _from: the address of the token holder whose balance is decreased
:param _to: the address of the recipient whose balance is increased
:param _ids: IDs of the tokens (order and length must match `_values` list)
:param _values: transfer amounts per token (order and length must match `_ids` list)
:param _ids: serialized bytes of list for token IDs (order and length must match `_values`)
:param _values: serialized bytes of list for transfer amounts per token (order and length must match `_ids`)

NOTE: RLP (Recursive Length Prefix) would be used for the serialized bytes to represent list type.
"""
```

Expand All @@ -187,12 +189,29 @@ def ApprovalForAll(self, _owner: Address, _operator: Address, _approved: bool):
"""
```

### Token Fallbacks
#### URI
```python
@eventlog(indexed=1)
def URI(self, _id: int, _value: str):
"""
Must trigger on any successful URI updates for a token ID.
URIs are defined in RFC 3986.
The URI MUST point to a JSON file that conforms to the "ERC-1155 Metadata URI JSON Schema".

:param _id: ID of the token
:param _value: the updated URI string
"""
```

### Token Receivers

Smart contracts that want to receive tokens from IRC31-compatible token contracts must implement
all of the following receiver methods to accept transfers.

#### tokenFallback
#### onIRC31Received
```python
@external
def tokenFallback(self, _operator: Address, _from: Address, _id: int, _value: int, _data: bytes):
def onIRC31Received(self, _operator: Address, _from: Address, _id: int, _value: int, _data: bytes):
"""
A method for handling a single token type transfer, which is called from the multi token contract.
It works by analogy with the fallback method of the normal transactions and returns nothing.
Expand All @@ -206,10 +225,10 @@ def tokenFallback(self, _operator: Address, _from: Address, _id: int, _value: in
"""
```

#### tokenFallbackBatch
#### onIRC31BatchReceived
```python
@external
def tokenFallbackBatch(self, _operator: Address, _from: Address, _ids: List[int], _values: List[int], _data: bytes):
def onIRC31BatchReceived(self, _operator: Address, _from: Address, _ids: List[int], _values: List[int], _data: bytes):
"""
A method for handling multiple token type transfers, which is called from the multi token contract.
It works by analogy with the fallback method of the normal transactions and returns nothing.
Expand All @@ -223,6 +242,22 @@ def tokenFallbackBatch(self, _operator: Address, _from: Address, _ids: List[int]
"""
```

### Metadata Extensions

To provide rich set of asset metadata for a given token, smarts contracts need to implement the following method
to return an URI that points to a JSON file.

```python
@external(readonly=True)
def tokenURI(self, _id: int) -> str:
"""
Returns an URI for a given token ID.

:param _id: ID of the token
:return: the URI string
"""
```

## Implementation
TBD

Expand Down