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.

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

Add ERC: JSON Smart Contract with Value Version Control #734

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

lex-clinic
Copy link

From https://raw.githubusercontent.com/lexclinic/Templates/refs/heads/main/JSON%20Object%20Management%20with%20Version%20Control%20in%20Smart%20Contracts.md .

Draft created during MegaZu, given demo day feedback.

Following cat herder directions here https://discord.com/channels/916516304972824576/916725260664057916/1310976176013054043 . Please excuse my confusion. This is the first time I've gone through this process.

When opening a pull request to submit a new EIP, please use the suggested template: https://github.com/ethereum/EIPs/blob/master/eip-template.md

We have a GitHub bot that automatically merges some PRs. It will merge yours immediately if certain criteria are met:

  • The PR edits only existing draft PRs.
  • The build passes.
  • Your GitHub username or email address is listed in the 'author' header of all affected PRs, inside .
  • If matching on email address, the email address is the one publicly listed on your GitHub profile.

@eip-review-bot
Copy link
Collaborator

eip-review-bot commented Nov 26, 2024

File ERCS/erc-7827.md

Requires 1 more reviewers from @axic, @g11tech, @SamWilsn, @xinbenlv

@eip-review-bot eip-review-bot changed the title Create erc-0626.md Add ERC: JSON Smart Contract with Value Version Control Nov 26, 2024
@github-actions github-actions bot removed the w-ci label Nov 26, 2024
Copy link
Collaborator

@SamWilsn SamWilsn left a comment

Choose a reason for hiding this comment

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

You'll need to fix the issues raised by the bot.

ERCS/erc-0626.md Outdated

With an increasing number of developers from RESTful backgrounds joining the Ethereum ecosystem, there is a need for a contract interface that allows developers to easily interact with structured JSON data.
This EIP aims to create a universal standard that provides JSON data management and version control functionality in a straightforward and REST-like way, making Ethereum more accessible and developer-friendly.

Copy link
Collaborator

Choose a reason for hiding this comment

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

You could (but don't have to) include some specific use cases that you expect this to be useful for.

ERCS/erc-0626.md Outdated

## Specification

The contract interface includes the following methods:
Copy link
Collaborator

Choose a reason for hiding this comment

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

It might be more readable to include a full solidity interface instead of listing individual methods, but that's up to you.

ERCS/erc-0626.md Outdated
By making this contract accessible through Web3 abstractions, developers with REST experience can seamlessly interact with the contract.

## Rationale

Copy link
Collaborator

@SamWilsn SamWilsn Nov 26, 2024

Choose a reason for hiding this comment

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

You'll definitely want to explain why you're returning JSON strings instead of providing a key-value interface.

ERCS/erc-0626.md Outdated
3. **Compatibility with Web3 Abstractions**
Ensuring a simple and standardized ABI is essential for usability with Web3 libraries, thus enhancing developer experience and facilitating onboarding.

## Example Usage
Copy link
Collaborator

Choose a reason for hiding this comment

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

The bot will complain about this section. You should move it to be a subheading under Specification.

@github-actions github-actions bot added the w-ci label Nov 26, 2024
@github-actions github-actions bot removed the w-ci label Nov 26, 2024
Copy link

The commit c57e8cd (as a parent of 6632c70) contains errors.
Please inspect the Run Summary for details.

@github-actions github-actions bot added the w-ci label Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants