Add ERC: Store, Table-Based Introspectable Storage by alvrs · Pull Request #711 · ethereum/ERCs

alvrs · 2024-11-08T16:22:27Z

This standard introduces a flexible on-chain storage pattern that organizes data into structured tables with schemas, similar to a traditional database. This approach allows new tables to be added at runtime without impacting existing contracts, thereby simplifying upgrades and extensions. By providing a unified interface for data access, the standard enables any contract or off-chain service to read stored data without the need for custom getter functions. Additionally, by standardizing event emissions for state changes it enables automatic, schema-aware indexing.

eip-review-bot · 2024-11-08T16:22:56Z

✅ All reviewers have approved.

abcoathup · 2024-11-08T22:43:35Z

@@ -0,0 +1,499 @@
+---
+eip: <to be assigned>
+title: Store, Table-Based Introspectable Storage


Suggested change

title: Store, Table-Based Introspectable Storage

title: Table-Based Introspectable Storage

Maybe simplify the title

We would like to keep the name for now. Thanks for the feedback!

For context - we feel it's important to keep the term "Store" in the title since it's the name of the pattern, ie all events are prefixed with Store

github-actions · 2024-11-18T14:40:47Z

The commit d60529d (as a parent of 571b06e) contains errors.
Please inspect the Run Summary for details.

Co-authored-by: Andrew B Coathup <28278242+abcoathup@users.noreply.github.com>

alvrs · 2024-12-04T23:15:39Z

@abcoathup please let us know if there are any other requested changes before we can get this merged as draft!

SamWilsn · 2024-12-09T20:18:21Z

+
+## Abstract
+
+This standard introduces a flexible on-chain storage pattern that organizes data into structured tables with schemas, similar to a traditional database. This approach allows new tables to be added at runtime without impacting existing contracts, thereby simplifying upgrades and extensions. By providing a unified interface for data access, the standard enables any contract or off-chain service to read stored data without the need for custom getter functions. Additionally, by standardizing event emissions for state changes it enables automatic, schema-aware indexing.


Your abstract is missing some technical meat. After reading this section, your audience should have a high level (but still technical) overview of how your proposal accomplishes its goals.

SamWilsn · 2024-12-09T20:19:37Z

+
+A piece of data stored in a **Table**, addressed by one or more keys.
+
+#### ResourceId


If these headings are literals from your code (and it looks like they might be), you should enclose them in backticks (`). That goes for any code snippets in the text as well.

SamWilsn · 2024-12-09T20:22:44Z

+| tableId  | ResourceId | The ID of the table where the record is deleted        |
+| keyTuple | bytes32[]  | An array representing the composite key for the record |
+
+#### Example


This should probably be moved to your Reference Implementation section. You can link to it from here though.

Co-authored-by: Sam Wilson <57262657+SamWilsn@users.noreply.github.com>

Store feedback

alvrs · 2025-01-10T11:06:39Z

@SamWilsn we updated the PR with your feedback, could we get another look?

alvrs · 2025-01-27T11:45:03Z

@abcoathup @SamWilsn please let us know if there is anything else you'd like us to change before we can get this merged as draft!

SamWilsn

Looks good, just some tiny formatting changes.

SamWilsn · 2025-03-20T16:05:50Z

+| encodedLengths | EncodedLengths | The encoded lengths of the dynamic data of the record                                        |
+| dynamicData    | bytes          | The dynamic data of the record, using [custom packed encoding](#packed-data-encoding)        |
+
+#### Store_SpliceStaticData


Suggested change

#### Store_SpliceStaticData

#### `Store_SpliceStaticData`

SamWilsn · 2025-03-20T16:06:04Z

+| start    | uint48     | The start position in bytes for the splice operation          |
+| data     | bytes      | Packed ABI encoding of a tuple with the value's static fields |
+
+#### Store_SpliceDynamicData


Suggested change

#### Store_SpliceDynamicData

#### `Store_SpliceDynamicData`

SamWilsn · 2025-03-20T16:06:20Z

+| encodedLengths    | EncodedLengths | The resulting encoded lengths of the dynamic data of the record                                                                                          |
+| data              | bytes          | The data to insert into the dynamic data of the record at the start byte                                                                                 |
+
+#### Store_DeleteRecord


Suggested change

#### Store_DeleteRecord

#### `Store_DeleteRecord`

eip-review-bot

All Reviewers Have Approved; Performing Automatic Merge...

eip-review-bot

All Reviewers Have Approved; Performing Automatic Merge...

github-actions Bot added c-new s-draft t-erc labels Nov 8, 2024

eip-review-bot added e-consensus e-review labels Nov 8, 2024

github-actions Bot added the w-ci label Nov 8, 2024

alvrs marked this pull request as ready for review November 8, 2024 16:53

alvrs requested a review from eip-review-bot as a code owner November 8, 2024 16:53

abcoathup reviewed Nov 8, 2024

View reviewed changes

Comment thread ERCS/erc-xxxx.md Outdated

abcoathup reviewed Nov 8, 2024

View reviewed changes

Comment thread ERCS/erc-xxxx.md Outdated

abcoathup reviewed Nov 8, 2024

View reviewed changes

Comment thread ERCS/erc-xxxx.md Outdated

abcoathup reviewed Nov 8, 2024

View reviewed changes

github-actions Bot removed the w-ci label Nov 18, 2024

github-actions Bot added the w-ci label Nov 18, 2024

github-actions Bot removed the w-ci label Nov 27, 2024

alvrs and others added 8 commits November 27, 2024 11:34

init store ERC

56a4769

add ethereum magicians link

5442a9a

Remove empty line

05b735d

Co-authored-by: Andrew B Coathup <28278242+abcoathup@users.noreply.github.com>

Set eip number

bc68fd2

Co-authored-by: Andrew B Coathup <28278242+abcoathup@users.noreply.github.com>

Update ethereum magicians link

84fb405

Co-authored-by: Andrew B Coathup <28278242+abcoathup@users.noreply.github.com>

Rename erc-xxxx.md to erc-7813.md

93c1311

update author field

d28759a

update author field to add github usernames

0344f1b

alvrs force-pushed the store branch from 2950c8d to 0344f1b Compare November 27, 2024 10:34

alvrs requested a review from abcoathup November 27, 2024 10:34

SamWilsn reviewed Dec 9, 2024

View reviewed changes

Update ERCS/erc-7813.md

2f0bcbd

Co-authored-by: Sam Wilson <57262657+SamWilsn@users.noreply.github.com>

vdrg and others added 5 commits January 3, 2025 08:33

Update ERCS/erc-7813.md

97988c8

Co-authored-by: Sam Wilson <57262657+SamWilsn@users.noreply.github.com>

Update ERCS/erc-7813.md

6965639

Co-authored-by: Sam Wilson <57262657+SamWilsn@users.noreply.github.com>

Update ERCS/erc-7813.md

b01ae8c

Co-authored-by: Sam Wilson <57262657+SamWilsn@users.noreply.github.com>

Update ERCS/erc-7813.md

c7ec7fd

Co-authored-by: Sam Wilson <57262657+SamWilsn@users.noreply.github.com>

Store feedback

ec342c2

vdrg mentioned this pull request Jan 3, 2025

Store feedback latticexyz/ERCs#1

Merged

vdrg and others added 3 commits January 3, 2025 10:03

typo

8c43f4e

Merge pull request #1 from latticexyz/store-feedback

1ac36e4

Store feedback

Merge branch 'master' into store

4350dc9

Merge branch 'master' into store

5e6d174

SamWilsn approved these changes Mar 20, 2025

View reviewed changes

eip-review-bot enabled auto-merge (squash) March 20, 2025 16:07

eip-review-bot approved these changes Mar 20, 2025

View reviewed changes

eip-review-bot merged commit 051392f into ethereum:master Mar 20, 2025

eip-review-bot approved these changes Mar 20, 2025

View reviewed changes

	title: Store, Table-Based Introspectable Storage
	title: Table-Based Introspectable Storage


		## Abstract

		This standard introduces a flexible on-chain storage pattern that organizes data into structured tables with schemas, similar to a traditional database. This approach allows new tables to be added at runtime without impacting existing contracts, thereby simplifying upgrades and extensions. By providing a unified interface for data access, the standard enables any contract or off-chain service to read stored data without the need for custom getter functions. Additionally, by standardizing event emissions for state changes it enables automatic, schema-aware indexing.


		A piece of data stored in a Table, addressed by one or more keys.

		#### ResourceId

Conversation

alvrs commented Nov 8, 2024

Uh oh!

eip-review-bot commented Nov 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Nov 18, 2024

Uh oh!

alvrs commented Dec 4, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alvrs commented Jan 10, 2025

Uh oh!

alvrs commented Jan 27, 2025

Uh oh!

SamWilsn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eip-review-bot left a comment

Choose a reason for hiding this comment

Uh oh!

eip-review-bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

eip-review-bot commented Nov 8, 2024 •

edited

Loading