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

Jump to bottom

Remove Receiver-like traits with before_received from PSPs #59

Merged
merged 1 commit into from
Jun 23, 2023
Merged

Remove Receiver-like traits with before_received from PSPs #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
122 changes: 0 additions & 122 deletions PSPs/psp-22.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ Due to the different nature of WebAssembly smart contracts and the difference be
therefore PSP-22 differs from ERC-20 in its implementation.

Also, this standard proposal defines an extensive method list in the interface. Unlike ERC-20, it includes `increase_allowance` and `decrease_allowance`, and defines metadata fields as part of a separate interface.
Another difference is that it has the `PSP22Receiver` interface, and the `before_received` method is called at the end of transfer if the recipient is a contract.

# This standard is at ABI level

Expand Down Expand Up @@ -521,76 +520,6 @@ Selector: `0x7271b782` - first 4 bytes of `blake2b_256("PSP22Metadata::token_dec
}
```

#### PSP22Receiver
`PSP22Receiver` is an interface for any contract that wants to support safe transfers from a PSP-22 token smart contract to avoid unexpected tokens in the balance of contract.
This method is called before a transfer to ensure the recipient of the tokens acknowledges the receipt.

##### **before_received**(&mut self, operator: AccountId, from: AccountId, value: Balance, data: [u8]) ➔ Result<(), PSP22ReceiverError>
Selector: `0xfda6f1a9` - first 4 bytes of `blake2b_256("PSP22Receiver::before_received")`
```json
{
"args": [
{
"name": "operator",
"type": {
"displayName": [
"AccountId"
],
"type": "AccountId"
}
},
{
"name": "from",
"type": {
"displayName": [
"AccountId"
],
"type": "AccountId"
}
},
{
"name": "value",
"type": {
"displayName": [
"Balance"
],
"type": "Balance"
}
},
{
"name": "data",
"type": {
"displayName": [
"[u8]"
],
"type": "[u8]"
}
}
],
"docs": [
"Ensures that the smart contract allows reception of PSP22 token(s).",
"Returns `Ok(())` if the contract allows the reception of the token(s) and Error `TransferRejected(String))` otherwise.",
"",
"This method will get called on every transfer to check whether the recipient in `transfer` is a contract, and if it is,",
"does it accept tokens. This is done to prevent contracts from locking tokens forever.",
"",
"This method does not throw. Returns `PSP22ReceiverError` if the contract does not accept the tokens."
],
"mutates": true,
"name": [
"PSP22Receiver",
"before_received"
],
"returnType": {
"displayName": [
"Result"
],
"type": 2
},
"selector": "0xfda6f1a9"
}
```

### Events

#### Transfer
Expand Down Expand Up @@ -764,52 +693,6 @@ type Balance = u128;
]
}
}
},
"2": {
"def": {
"variant": {
"variants": [
{
"fields": [
{
"type": {
"def": {
"tuple": []
}
}
}
],
"name": "Ok"
},
{
"fields": [
{
"type": {
"def": {
"variant": {
"variants": [
{
"fields": [
{
"type": "string"
}
],
"name": "TransferRejected"
}
]
}
},
"path": [
"PSP22ReceiverError"
]
}
}
],
"name": "Err"
}
]
}
}
}
}
}
Expand All @@ -833,11 +716,6 @@ enum PSP22Error {
/// Returned if a safe transfer check fails (e.g. if the receiving contract does not accept tokens).
SafeTransferCheckFailed(String),
}

enum PSP22ReceiverError {
/// Returned if a transfer is rejected.
TransferRejected(String),
}
```

## Copyright
Expand Down
120 changes: 0 additions & 120 deletions PSPs/psp-34.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,75 +319,6 @@ Selector: `0x628413fe` - first 4 bytes of `blake2b_256("PSP34::total_supply")`
}
```

#### PSP34Receiver
`PSP34Receiver` is an interface for any contract that wants to support safe transfers from a PSP-34 token smart contract to avoid unexpected tokens in the balance of contract.
This method is called before a transfer to ensure the recipient of the tokens acknowledges the receipt.

##### **before_received**(operator: AccountId, from: AccountId, id: Id, data: [u8]) ➔ Result<(), PSP34ReceiverError>
Selector: `0xbb7df780` - first 4 bytes of `blake2b_256("PSP34Receiver::before_received")`
```json
{
"args": [
{
"label": "operator",
"type": {
"displayName": [
"AccountId"
],
"type": "AccountId"
}
},
{
"label": "from",
"type": {
"displayName": [
"AccountId"
],
"type": "AccountId"
}
},
{
"label": "id",
"type": {
"displayName": [
"Id"
],
"type": "Id"
}
},
{
"label": "data",
"type": {
"displayName": [
"[u8]"
],
"type": "[u8]"
}
}
],
"docs": [
"Ensures that the smart contract allows reception of PSP34 token(s).",
"Returns `Ok(())` if the contract allows the reception of the token(s) and Error `TransferRejected(String)` otherwise.",
"",
"This method will get called on every transfer to check whether the recipient in `transfer`",
"or `transfer_from` is a contract, and if it is, does it accept tokens.",
"This is done to prevent contracts from locking tokens forever.",
"",
"Returns `PSP34ReceiverError` if the contract does not accept the tokens."
],
"mutates": true,
"label": "PSP34Receiver::before_received",
"payable": false,
"returnType": {
"displayName": [
"Result"
],
"type": 2
},
"selector": "0xbb7df780"
}
```

### Extension

#### PSP34Metadata
Expand Down Expand Up @@ -759,52 +690,6 @@ type AccountId = [u8; 32];
]
}
}
},
"2": {
"def": {
"variant": {
"variants": [
{
"fields": [
{
"type": {
"def": {
"tuple": []
}
}
}
],
"name": "Ok"
},
{
"fields": [
{
"type": {
"def": {
"variant": {
"variants": [
{
"fields": [
{
"type": "string"
}
],
"name": "TransferRejected"
}
]
}
},
"path": [
"PSP34ReceiverError"
]
}
}
],
"name": "Err"
}
]
}
}
}
}
}
Expand All @@ -828,11 +713,6 @@ enum PSP34Error {
/// Returned if safe transfer check fails
SafeTransferCheckFailed(String),
}

enum PSP34ReceiverError {
/// Returned if transfer is rejected.
TransferRejected(String),
}
```

## Copyright
Expand Down
Loading