feat: add `standards` key to `ContractSourceMetadata` #351

esaminu · 2022-04-08T20:28:02Z

This PR proposes the addition of an optional standards value to the ContractSourceMetadata type recently introduced in NEP-330 (#330).

This will allow wallets and Dapps to be able to more easily identify what type of contract they are dealing with and what functionality to expect and render without having to test for those methods and events existing.

One example use case of this is to introduce an extension that implements buy / sell for the USN contract and add it as ContractSourceMetadata so we can provide the functionality conditionally for fungible tokens in near/near-wallet#2568.

Additionally, this PR fixes missed updates of ContractMetadata to ContractSourceMetadata here and here.

render · 2022-04-08T20:28:05Z

Your Render PR Server URL is https://nomicon-pr-351.onrender.com.

Follow its progress at https://dashboard.render.com/static/srv-c989ll0ivq0br030qri0.

neps/nep-0330.md

frol · 2022-10-07T13:50:43Z

@near/wg-contract-standards This is a small extension to an existing NEP, so let's review it before our next Working Group call

ori-near · 2022-11-04T18:32:36Z

@esaminu Can you please address the comments/questions that @frol surfaced above?

Co-authored-by: Vlad Frolov <[email protected]>

frol · 2022-12-12T21:50:58Z

As a subject matter expert, I recommend moving this NEP forward and for @near/wg-contract-standards to accept it based on the following benefits and all the concerns being resolved.

Benefits

Unlocks NEP extensions that otherwise would be hard to integrate into the tooling as it would be guess-based (e.g. see "interface detection" concerns in the Non-transferrable NFT NEP)
Standardization enables composability as it makes it easier to interact with contracts when you can programmatically check compatibility
This NEP extension introduces an optional field, so there is no breaking change to the original NEP

Blockers & Concerns

[Resolved] It was recommended to use a flexible standard (string-value) field instead of NEP (integer-value) field

As a working group member, I lean towards approving this NEP extension.

neps/nep-0330.md

mfornet · 2022-12-21T10:38:05Z

It is a valuable and natural extension of NEP-330 in a non-breaking way. As a WG member, I lean towards approving this proposal.

Meta Question: Should contract developers include nep330 / nep351 as implemented standards? We should suggest in this document whether these standards should be included. It seems a good idea if they are included (to keep track of the version).

frol · 2022-12-21T11:57:06Z

Meta Question: Should contract developers include nep330 / nep351 as implemented standards?

I think it makes sense to include nep330. There is no strategy at the moment regarding the NEP extension numbering where we evolve the existing NEP and thus the NEP-330 has no mentions of this PR #351.

Another follow-up idea is that it is going to be useful to have JSON Events fired when the metadata gets updated (similar to how it is proposed to do for NEP-171 metadata updates in #423)

abacabadabacaba · 2023-01-06T18:53:00Z

I lean towards approving this request. With more standards being integrated into wallets and other user-facing tools, it would be great to be able to efficiently enumerate the interfaces a contract supports.

ori-near · 2023-01-06T19:32:17Z

As the moderator, I would like to thank the author @esaminu for submitting this NEP extension, and for the @near/wg-contract-standards working group members for your review. Based on the voting indications above, it seems like this proposal is close to a decision. We are therefore scheduling the third Contract Standards Working group meeting next week, where this NEP can enter the final voting stage. We encourage anyone who is interested to join the meeting.

Meeting Info
📅 Date: Friday, Jan 13, 4pm UTC
✏️ Register

neps/nep-0330.md

ori-near · 2023-01-14T01:14:10Z

Thank you to everyone who attended the third Contract Standards Working Group meeting today! The working group members reviewed the NEP and reached the following consensus:

Status: Approved

Meeting Recording:
https://youtu.be/pBLN9UyE6AA

@esaminu Thank you for authoring this NEP!

Next Steps:

~~@esaminu~~ @frol To embed the benefits & concerns into the NEP document
~~@esaminu~~ @frol To add a changelog at the end of the NEP document linking PR/NEP feat: add standards key to ContractSourceMetadata #351 for future reference
@near/nep-moderators to approve and merge the NEP
@near/nep-moderators To post on the NEAR Gigs Board a call for champions who are interested in implementing this NEP in the tooling

Implementation Status:
Needs support in SDK and API packages

Community contributions to the SDKs are welcome!

mfornet · 2023-01-19T14:35:38Z

@ori-near, we can merge this PR before all the steps are completed. I suggest we add this PR to the main page (README.md) and open a new issue to track the next steps.

… clarified the need to include NEP-330 v1.1.0 on the list of supported NEPs

frol

I embedded the "Decision Context" section with Benefits and Concerns for future reference.

As a moderator, I am approving this PR based on #351 (comment)

frol · 2023-01-24T13:35:50Z

specs/Standards/SourceMetadata.md

-:::caution
-This is part of proposed spec [NEP-330](https://github.com/near/NEPs/blob/master/neps/nep-0330.md) and subject to change.
-:::


I feel this scary disclaimer is not necessary anymore. This NEP is well-reviewed by Contract Standards Working Group and well-received by the community.

frol · 2023-01-24T13:36:31Z

neps/nep-0330.md

+    {
+        standard: "nep330", 
+        version: "1.1.0"
+    },


I have added reference to NEP-330 into all the examples to ensure that readers follow the advice.

frol · 2023-01-24T13:37:07Z

neps/nep-0330.md

 - `version`: a string that references the specific commit hash or version of the code that is currently deployed on-chain. This can be included regardless of whether or not the contract is open-sourced and can also be used for organizational purposes.
 - `link`: a string that references the link to the open-source code. This can be anything such as Github or a CID to somewhere on IPFS.
+- `standards`: a list of objects (see type definition below) that enumerates the NEPs supported by the contract. If this extension is supported, it is advised to also include NEP-330 version 1.1.0 in the list (`{standard: "nep330", version: "1.1.0"}`).


@esaminu I have added the standards field description here as you mentioned before.

frol · 2023-01-24T13:38:52Z

neps/nep-0330.md

 Type: Standards Track
 Category: Contract
+Version: 1.1.0


@ori-near I have introduced NEPs versioning as part of the metadata. I will go over all of the approved NEPs and set the version to 1.0.0 if it is not set, and update NEP-001.

frol · 2023-01-24T13:40:44Z

neps/nep-0330.md

+## Decision Context
+
+### 1.0.0 - Initial Version
+
+The initial version of NEP-330 was approved by @jlogelin on Mar 29, 2022.
+
+### 1.1.0 - Contract Metadata Extension
+
+The extension NEP-351 that added Contract Metadata to this NEP-330 was approved by Contract Standards Working Group members on January 17, 2023 ([meeting recording](https://youtu.be/pBLN9UyE6AA)).
+
+#### Benefits
+
+- Unlocks NEP extensions that otherwise would be hard to integrate into the tooling as it would be guess-based (e.g. see "interface detection" concerns in the Non-transferrable NFT NEP)
+- Standardization enables composability as it makes it easier to interact with contracts when you can programmatically check compatibility
+- This NEP extension introduces an optional field, so there is no breaking change to the original NEP
+
+#### Concerns
+
+| # | Concern | Resolution | Status |
+| - | - | - | - |   
+| 1 | Integer field as a standard reference is limiting as third-party projects may want to introduce their own standards without pushing it through the NEP process | Author accepted the proposed string-value standard reference (e.g. “nep123” instead of just 123, and allow “xyz001” as previously it was not possible to express it) | Resolved |
+| 2 | NEP-330 and NEP-351 should be included in the list of the supported NEPs | There seems to be a general agreement that it is a good default, so NEP was updated | Resolved |
+| 3 | JSON Event could be beneficial, so tooling can react to the changes in the supported standards | It is outside the scope of this NEP. Also, list of supported standards only changes with contract re-deployment, so tooling can track DEPLOY_CODE events and check the list of supported standards when new code is deployed | Won’t fix |


I have added this "Decision Context" as per NEP process

esaminu requested a review from a team as a code owner April 8, 2022 20:28

esaminu requested review from MaximusHaximus, 10d9e, mattlockyer, thisisjoshford, austinabell, agileurbanite, mfornet, bucanero and BenKurrek April 8, 2022 20:28

esaminu changed the title ~~Feat add standards key to contract source metadata~~ feat: add standards key to ContractSourceMetadata Apr 8, 2022

esaminu changed the title ~~feat: add standards key to ContractSourceMetadata~~ feat: add standards key to ContractSourceMetadata Apr 9, 2022

frol added the WG-contract-standards Contract Standards Work Group should be accountable label Sep 5, 2022

frol reviewed Oct 7, 2022

View reviewed changes

neps/nep-0330.md Outdated Show resolved Hide resolved

neps/nep-0330.md Outdated Show resolved Hide resolved

neps/nep-0330.md Outdated Show resolved Hide resolved

frol added the S-review/needs-author-revision A NEP in the REVIEW stage that needs an author revision. label Oct 7, 2022

frol requested review from a team and removed request for 10d9e and agileurbanite October 7, 2022 13:48

ori-near added the A-NEP A NEAR Enhancement Proposal (NEP). label Oct 13, 2022

esaminu and others added 5 commits November 11, 2022 02:48

feat: add standards key to ContractSourceMetadata

6d27a25

fix: ContractMetadata to ContractSourceMetadata

91879cd

fix: typo

9186f50

Co-authored-by: Vlad Frolov <[email protected]>

feat: open up to non NEP standards with string value

5bdc3db

Co-authored-by: Vlad Frolov <[email protected]>

feat: update examples to generic standard string

a54f6b1

esaminu force-pushed the feat-add-standards-key-to-ContractSourceMetadata branch from 8379750 to a54f6b1 Compare November 10, 2022 22:49

esaminu requested a review from frol November 10, 2022 22:51

ori-near added S-review/needs-wg-to-assign-sme A NEP that needs working group to assign two SMEs. and removed S-review/needs-author-revision A NEP in the REVIEW stage that needs an author revision. labels Dec 5, 2022

frol added A-NEP-Extension A new functionality proposal to existing NEP. Once original author merges changes, we close this. and removed A-NEP A NEAR Enhancement Proposal (NEP). labels Dec 12, 2022

frol mentioned this pull request Dec 12, 2022

feat: adding soulbound token #393

Merged

2 tasks

frol added S-voting/needs-wg-voting-indication A NEP in the VOTING stage that needs the working group voting indication. and removed S-review/needs-wg-to-assign-sme A NEP that needs working group to assign two SMEs. labels Dec 12, 2022

robert-zaremba reviewed Dec 12, 2022

View reviewed changes

neps/nep-0330.md Show resolved Hide resolved

ori-near added S-voting/final-comment-period A NEP in the final REVIEW stage. Last chance to bring up concerns before the voting call. and removed S-voting/needs-wg-voting-indication A NEP in the VOTING stage that needs the working group voting indication. labels Jan 6, 2023

esaminu commented Jan 13, 2023

View reviewed changes

neps/nep-0330.md Show resolved Hide resolved

ori-near mentioned this pull request Jan 14, 2023

add contract_metadata_update event #423

Merged

ori-near added S-approved A NEP that was approved by a working group. and removed S-voting/final-comment-period A NEP in the final REVIEW stage. Last chance to bring up concerns before the voting call. labels Jan 14, 2023

frol added 2 commits January 24, 2023 14:29

Integrated "Decision Context" section, introduced NEP versioning, and…

494a040

… clarified the need to include NEP-330 v1.1.0 on the list of supported NEPs

Mirrored the changes to the Nomicon page

265551d

frol approved these changes Jan 24, 2023

View reviewed changes

frol merged commit 3e23a5e into master Jan 24, 2023

frol deleted the feat-add-standards-key-to-ContractSourceMetadata branch January 24, 2023 13:47

frol mentioned this pull request Jan 24, 2023

Proposal to allow attached_deposit in view contexts #418

Merged

Cameron-Banyan mentioned this pull request Apr 14, 2023

Add support for signing in to more than one contract at once to Injected Wallet Standard #428

Merged

5 tasks

frol mentioned this pull request May 23, 2023

Contract Self-Identification NEP #129

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add `standards` key to `ContractSourceMetadata` #351

feat: add `standards` key to `ContractSourceMetadata` #351

esaminu commented Apr 8, 2022 •

edited

Loading

render bot commented Apr 8, 2022

frol commented Oct 7, 2022

ori-near commented Nov 4, 2022

frol commented Dec 12, 2022 •

edited

Loading

mfornet commented Dec 21, 2022 •

edited

Loading

frol commented Dec 21, 2022

abacabadabacaba commented Jan 6, 2023

ori-near commented Jan 6, 2023

ori-near commented Jan 14, 2023 •

edited by frol

Loading

mfornet commented Jan 19, 2023

frol left a comment

frol Jan 24, 2023

frol Jan 24, 2023

frol Jan 24, 2023

frol Jan 24, 2023

frol Jan 24, 2023

feat: add standards key to ContractSourceMetadata #351

feat: add standards key to ContractSourceMetadata #351

Conversation

esaminu commented Apr 8, 2022 • edited Loading

render bot commented Apr 8, 2022

frol commented Oct 7, 2022

ori-near commented Nov 4, 2022

frol commented Dec 12, 2022 • edited Loading

Benefits

Blockers & Concerns

mfornet commented Dec 21, 2022 • edited Loading

frol commented Dec 21, 2022

abacabadabacaba commented Jan 6, 2023

ori-near commented Jan 6, 2023

ori-near commented Jan 14, 2023 • edited by frol Loading

mfornet commented Jan 19, 2023

frol left a comment

Choose a reason for hiding this comment

frol Jan 24, 2023

Choose a reason for hiding this comment

frol Jan 24, 2023

Choose a reason for hiding this comment

frol Jan 24, 2023

Choose a reason for hiding this comment

frol Jan 24, 2023

Choose a reason for hiding this comment

frol Jan 24, 2023

Choose a reason for hiding this comment

feat: add `standards` key to `ContractSourceMetadata` #351

feat: add `standards` key to `ContractSourceMetadata` #351

esaminu commented Apr 8, 2022 •

edited

Loading

frol commented Dec 12, 2022 •

edited

Loading

mfornet commented Dec 21, 2022 •

edited

Loading

ori-near commented Jan 14, 2023 •

edited by frol

Loading