Add EIP-5994: Token Balance Update Hooks (Pods) #6000

k06a · 2022-11-18T11:49:01Z

This EIP introduces Token Pods, enabling external smart contract based Pods to track token balances of those users who opted-in to these Pods. Pods can implement different logic, for example permissionless and risk-free farms.

Discussion:

https://ethereum-magicians.org/t/eip-6000-token-pods-extensions-erc20-erc721/11782

Example implementation:

https://github.com/1inch/erc20-pods

Examples of Pods:

eth-bot · 2022-11-18T11:49:54Z

Hi! I'm a bot, and I wanted to automerge your PR, but couldn't because of the following issue(s):

(fail) eip-5994.md

classification
`newEIPFile`

File with name EIPS/eip-5994.md is new and new files must be reviewed
This PR requires review from one of [@axic, @SamWilsn, @Pandapip1]

EIPS/eip-6000.md

Co-authored-by: Pandapip1 <[email protected]>

EIPS/eip-5994.md

Pandapip1 · 2022-11-19T16:04:59Z

EIPS/eip-5994.md

+```solidity
+interface IPod {
+    function updateBalances(address from, address to, uint256 amount) external;
+}
+
+interface IERC20Pods is IERC20 {
+    function hasPod(address account, address pod) external view returns(bool);
+    function podsCount(address account) external view returns(uint256);
+    function podAt(address account, uint256 index) external view returns(address);
+    function pods(address account) external view returns(address[] memory);
+    function podBalanceOf(address pod, address account) external view returns(uint256);
+
+    function addPod(address pod) external;
+    function removePod(address pod) external;
+    function removeAllPods() external;
+}
+
+interface IERC721Pods is IERC721 {
+    function hasPod(address account, address pod) external view returns(bool);
+    function podsCount(address account) external view returns(uint256);
+    function podAt(address account, uint256 index) external view returns(address);
+    function pods(address account) external view returns(address[] memory);
+    function podBalanceOf(address pod, address account) external view returns(uint256);
+
+    function addPod(address pod) external;
+    function removePod(address pod) external;
+    function removeAllPods() external;
+}


This should be ideally be split into three sections, each with NatSpec. In addition, I think that pods, in order to be versatile enough for the use cases mentioned in the rationale, should:

Have a hook for addPod that allows the pod the chance to revert and update tracking variables

Have a hook for removePod that allows the pod the chance to revert and update tracking variables

Have separate hooks and hook names for EIP-20, EIP-721, and EIP-1155. EIP-20 and EIP-1155 pods should take an amount, EIP-721 pods shouldn't. And EIP-721 and EIP-1155 should take a tokenId, and EIP-20 shouldn't.

For EIP-721 and EIP-1155, pods should be able to be added per token ID or for the token as a whole.

(This is a big one for me) EIP-165 should be supported.

Also, where is the EIP-1155 interface?

EIPS/eip-5994.md

Pandapip1 · 2022-11-19T16:09:24Z

EIPS/eip-5994.md

+
+## Security Considerations
+
+Pods implementations will never block balance update, but can eat upto 200,000 gas. Number of added Pods per account is limited to some immutable value (reasonable amount taking into account max transaction gas limit).


ERCs MUST NOT depend on gas costs. They change from one hard fork to the next. EIP-165 is the one exception to this as it was finalized before that rule was put in place. It's well-recognized that the 30,000 gas limit is not a "real" rule, however.

This isn't in the spec!

I see no way to avoid this constant. This number should be specified. Moreover we have restriction of number of pods added to one account. N*200k should be less than max transaction gas limit. So I expect devs to use 200k constant and 10-20 pods limit per account.

Core concept is permissionless pods and risk-free participation. So Pods cant block transfers/mint/burns of designated assets.

It's okay to have the gas limit as a should. But it is not okay to have it as a must.

xinbenlv · 2022-11-22T04:42:43Z

EIPS/eip-5994.md

+
+### Pod specification
+
+- Pod MUST implement interface `IPod` and fit execution of `updateBalances` method in 200,000 gas and never revert.


Suggested change

- Pod MUST implement interface `IPod` and fit execution of `updateBalances` method in 200,000 gas and never revert.

- Pod MUST implement interface `IPod` and fit execution of `updateBalances` method within 200,000 gas and never revert.

For in, do you mean within?

Could you provide rationale about how the number 200,000 was picked??

@xinbenlv number is relatively big for any possible logic, but small enough to have limitation 5-10 pods per account to fit into more sophisticated transaction as part of token transfer. We expect in practice users will have up to 2-3 pods with 30-50k gas consumption max for each, in average nearly 10-20k each.

xinbenlv · 2022-11-22T04:43:55Z

EIPS/eip-5994.md

+
+## Security Considerations
+
+Pods implementations will never block balance update, but can eat upto 200,000 gas. Number of added Pods per account is limited to some immutable value (reasonable amount taking into account max transaction gas limit).


I am a little worry about the introduction of Pods and its hooks will massively increase the chance of renetry attack, could you provide your considerations about this?

Co-authored-by: Pandapip1 <[email protected]>

Pandapip1 · 2022-11-24T16:41:29Z

EIPS/eip-5994.md

+---
+eip: 5994
+title: Token Balance Update Hooks (Pods)
+description: Extends EIP-20, EIP-721, EIP-1155 token standards to enable opt-in balance tracking by external contracts (Pods)


Suggested change

description: Extends EIP-20, EIP-721, EIP-1155 token standards to enable opt-in balance tracking by external contracts (Pods)

description: Extends EIP-20, EIP-721, and EIP-1155 to enable opt-in balance tracking by external contracts (Pods)

Co-authored-by: Pandapip1 <[email protected]>

github-actions · 2023-02-12T00:20:11Z

There has been no activity on this pull request for 2 weeks. It will be closed after 3 months of inactivity. If you would like to move this PR forward, please respond to any outstanding feedback or add a comment indicating that you have addressed all required feedback and are ready for a review.

github-actions · 2023-03-27T00:18:04Z

This pull request was closed due to inactivity. If you are still pursuing it, feel free to reopen it and respond to any feedback or request a review in a comment.

k06a requested a review from eth-bot as a code owner November 18, 2022 11:49

github-actions bot added c-new Creates a brand new proposal s-draft This EIP is a Draft t-erc labels Nov 18, 2022

k06a changed the title ~~Add EIP-6000~~ Add EIP-6000: Token Pods extensions (ERC20/ERC721/ERC1155) Nov 18, 2022

Add EIP-6000: Token Pods extensions (ERC20/ERC721/ERC1155)

36b54ec

k06a changed the title ~~Add EIP-6000: Token Pods extensions (ERC20/ERC721/ERC1155)~~ Add EIP-6000: Token Pods extensions (ERC20/ERC721) Nov 18, 2022

Remove ERC1155 from description

df285ae

Pandapip1 reviewed Nov 18, 2022

View reviewed changes

EIPS/eip-6000.md Outdated Show resolved Hide resolved

Pandapip1 changed the title ~~Add EIP-6000: Token Pods extensions (ERC20/ERC721)~~ Add EIP-5994: Token Pods extensions (ERC20/ERC721) Nov 18, 2022

k06a changed the title ~~Add EIP-5994: Token Pods extensions (ERC20/ERC721)~~ Add EIP-6000: Token Pods extensions (ERC20/ERC721) Nov 18, 2022

Pandapip1 changed the title ~~Add EIP-6000: Token Pods extensions (ERC20/ERC721)~~ Add EIP-5994: Token Pods extensions (ERC20/ERC721) Nov 18, 2022

k06a and others added 2 commits November 18, 2022 20:58

Update EIPS/eip-6000.md

564eec3

Co-authored-by: Pandapip1 <[email protected]>

Rename file

6641006

Pandapip1 suggested changes Nov 19, 2022

View reviewed changes

xinbenlv reviewed Nov 22, 2022

View reviewed changes

Update title

2a3fb05

Co-authored-by: Pandapip1 <[email protected]>

k06a changed the title ~~Add EIP-5994: Token Pods extensions (ERC20/ERC721)~~ Add EIP-5994: Token Balance Update Hooks (Pods) Nov 24, 2022

k06a and others added 4 commits November 24, 2022 11:02

Update description

b017d64

Add EIP-1155 dependency and update link to discussion

d790a82

Update abstract session

da9a6f5

Co-authored-by: Pandapip1 <[email protected]>

Remove external links

301ce2b

Co-authored-by: Pandapip1 <[email protected]>

Pandapip1 suggested changes Nov 24, 2022

View reviewed changes

k06a and others added 5 commits November 25, 2022 14:17

Update motivation

e07fe33

Update specification section

a407308

Co-authored-by: Pandapip1 <[email protected]>

Update specification

2800264

Update EIPS/eip-5994.md

efea514

Co-authored-by: Pandapip1 <[email protected]>

Update EIPS/eip-5994.md

8928e3d

Co-authored-by: Pandapip1 <[email protected]>

DONALDSULLENDER approved these changes Nov 27, 2022

View reviewed changes

poojaranjan mentioned this pull request Nov 29, 2022

EIP Editing Office Hour Meeting 7 ethcatherders/EIPIP#194

Closed

poojaranjan mentioned this pull request Dec 12, 2022

EIP Editing Office Hour Meeting 8 ethcatherders/EIPIP#197

Closed

poojaranjan mentioned this pull request Jan 9, 2023

EIP Editing Office Hour Meeting 10 ethcatherders/EIPIP#204

Closed

25 tasks

poojaranjan mentioned this pull request Feb 7, 2023

EIP Editing Office Hour Meeting 11 ethcatherders/EIPIP#207

Closed

27 tasks

github-actions bot added the w-stale Waiting on activity label Feb 12, 2023

github-actions bot closed this Mar 27, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add EIP-5994: Token Balance Update Hooks (Pods) #6000

Add EIP-5994: Token Balance Update Hooks (Pods) #6000

k06a commented Nov 18, 2022 •

edited

Loading

eth-bot commented Nov 18, 2022 •

edited

Loading

Pandapip1 Nov 19, 2022

Pandapip1 Nov 19, 2022

k06a Nov 19, 2022

k06a Nov 19, 2022

Pandapip1 Nov 22, 2022

xinbenlv Nov 22, 2022

k06a Nov 22, 2022

xinbenlv Nov 22, 2022

Pandapip1 Nov 24, 2022

github-actions bot commented Feb 12, 2023

github-actions bot commented Mar 27, 2023


		## Security Considerations

		Pods implementations will never block balance update, but can eat upto 200,000 gas. Number of added Pods per account is limited to some immutable value (reasonable amount taking into account max transaction gas limit).


		### Pod specification

		- Pod MUST implement interface `IPod` and fit execution of `updateBalances` method in 200,000 gas and never revert.

	description: Extends EIP-20, EIP-721, EIP-1155 token standards to enable opt-in balance tracking by external contracts (Pods)
	description: Extends EIP-20, EIP-721, and EIP-1155 to enable opt-in balance tracking by external contracts (Pods)

Add EIP-5994: Token Balance Update Hooks (Pods) #6000

Add EIP-5994: Token Balance Update Hooks (Pods) #6000

Conversation

k06a commented Nov 18, 2022 • edited Loading

eth-bot commented Nov 18, 2022 • edited Loading

(fail) eip-5994.md

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Feb 12, 2023

github-actions bot commented Mar 27, 2023

k06a commented Nov 18, 2022 •

edited

Loading

eth-bot commented Nov 18, 2022 •

edited

Loading