Changes to new `Update` instruction #1058

danenbm · 2023-03-30T07:48:08Z

New change

Binary space savings changes
- Remove InternalUpdateArgs struct and From trait implementation.
- Deconstruct UpdateArgs where used.
- Remove redundant authority type and metadata delegate role checks from Metadata::update_v1 because validate_update already checks that the authority is allowed to perform an update, and the UpdateArgs enforces that the authority is only changing fields for which it is authorized.

Notes

Add Additional Metadata Delegates
- Add support in Delegate and Revoke for AuthorityItem, Data, DataItem, CollectionItem, and ProgrammableConfigItem Metadata delegates.
- Authority Metadata delegate is replaced by AuthorityItem, and Update Metadata delegate is replaced by Data. This is OK because @samuelvanderwaal ran a script and saw no current usage of those delegates (those delegates cannot currently do anything anyways).
Changes to Update to support new and changed delegates
- Modify authority check to separate out item and collection-level delegates.
- Add several new V2 UpdateArgs variants for update authority and each metadata delegate type, which makes it clear to users what metadata fields can be updated by each authority type. It also makes it trivial to enforce this in the handler.
- Modify Update handler to update metadata areas based on update authority or delegated authority.

Cargo lock change

During test development Cargo.lock file was updated, had to run cargo update -p mpl-token-metadata@1.10.0 to get the compiler to select a newer version of mpl-utils and succeed overall.

Docs

Here is the related docs PR: metaplex-foundation/docs#425

Enum Compatibility

For UpdateArgs I added all new variants to the end of the enum.
For MetadataDelegateRole enum I changed the name of Authority to AuthorityItem, Update to Data, and added the new delegates to the end of the enum. This is OK because @samuelvanderwaal ran a script and saw no current usage of those delegates (those delegates cannot currently do anything anyways).
For DelegateArgs and RevokeArgs enums I changed the name of UpdateV1 to DataV1, and added new delegates to the end of the enum.

Delegate expiration

This is an idea that was explored as part of this PR, but decided to keep this PR focused on new delegates and the Update instruction.
Current idea for delegate expiration can be seen in: Adding expiration for delegates #1063

Tests

Change unverify test on collection delegate behavior change
Added tests for:
- new delegates passing and failing to update
- persistent delegate failing to update
- updating token standard
- collection-level Collection delegate can update collection for items in the collection.
- collection-level Collection Item delegate cannot update items in the collection.
- collection-level Programmable Config delegate cannot update collection for items in the collection by using wrong UpdateArgs.
- collection-level Programmable Config delegate can update programmable config for items in the collection, using both the V2 UpdateArgs meant for Programmable Config delegate, as well as the V1 UpdateArgs.
  - This was to maintain backwards compatibility since Programmable Config delegate was in place before this PR.
- collection-level Programmable Config delegate cannot update collection for items in the collection by using collection field in V1 UpdateArgs.
- collection cannot be updated to verified.
- old version of lib can be used to delegate and update with new deployed program (even though DelegateArgs enum was modified).

Unrelated change

Fix delegate test based on auth rules update.

github-actions · 2023-03-30T07:51:24Z

Workflow Verify package library found differences when running yarn api:gen in the JS lib for token-metadata. Please see the job for more details: https://github.com/metaplex-foundation/metaplex-program-library/actions/runs/4561889528.

github-actions · 2023-04-03T16:04:43Z

Workflow Verify package library found differences when running yarn api:gen in the JS lib for token-metadata. Please see the job for more details: https://github.com/metaplex-foundation/metaplex-program-library/actions/runs/4598802660.

* Add support in Delegate and Revoke for Authority, Data, CollectionItem, and ProgrammableConfigItem Metadata delegates. * Remove Update Metadata delegate.

* Modify authority check to separate out item and collection-level delegates. * Add V2 Update args struct to allow user to specify token standard. * Check that new delegates are only changing metadata for which they are meant to have access. * Modify Update handler to update metadata fields based on the delegate type.

* Also add macro to help destructure UpdateArgs fields.

github-actions · 2023-04-04T18:13:06Z

Workflow Verify package library found differences when running yarn api:gen in the JS lib for token-metadata. Please see the job for more details: https://github.com/metaplex-foundation/metaplex-program-library/actions/runs/4610937013.

github-actions · 2023-04-04T18:29:11Z

Workflow Verify package library found differences when running yarn api:gen in the JS lib for token-metadata. Please see the job for more details: https://github.com/metaplex-foundation/metaplex-program-library/actions/runs/4611076067.

* Update is still changed to Data but order is preserved. * Also remove unnecessary Option for token_record in Update. * Add some comments clarifying authority types in Unverify.

github-actions · 2023-04-06T08:54:58Z

Workflow Verify package library found differences when running yarn api:gen in the JS lib for token-metadata. Please see the job for more details: https://github.com/metaplex-foundation/metaplex-program-library/actions/runs/4627158045.

github-actions · 2023-04-06T09:18:09Z

Workflow Verify package library found differences when running yarn api:gen in the JS lib for token-metadata. Please see the job for more details: https://github.com/metaplex-foundation/metaplex-program-library/actions/runs/4627358794.

github-actions · 2023-04-06T09:43:52Z

Workflow Verify package library found differences when running yarn api:gen in the JS lib for token-metadata. Please see the job for more details: https://github.com/metaplex-foundation/metaplex-program-library/actions/runs/4627569868.

* Return the value derived in the delegate method. * Also add a test for Authority delegate.

github-actions · 2023-04-06T10:14:33Z

Workflow Verify package library found differences when running yarn api:gen in the JS lib for token-metadata. Please see the job for more details: https://github.com/metaplex-foundation/metaplex-program-library/actions/runs/4627813314.

github-actions · 2023-04-06T10:16:06Z

Workflow Verify package library found differences when running yarn api:gen in the JS lib for token-metadata. Please see the job for more details: https://github.com/metaplex-foundation/metaplex-program-library/actions/runs/4627827526.

github-actions · 2023-04-06T10:39:54Z

Workflow Verify package library found differences when running yarn api:gen in the JS lib for token-metadata. Please see the job for more details: https://github.com/metaplex-foundation/metaplex-program-library/actions/runs/4628014650.

github-actions · 2023-04-06T10:46:46Z

Workflow Verify package library found differences when running yarn api:gen in the JS lib for token-metadata. Please see the job for more details: https://github.com/metaplex-foundation/metaplex-program-library/actions/runs/4628068920.

github-actions · 2023-04-25T19:05:29Z

Workflow Verify package library found differences when running yarn api:gen in the JS lib for token-metadata. Please see the job for more details: https://github.com/metaplex-foundation/metaplex-program-library/actions/runs/4801203150.

github-actions · 2023-04-26T00:07:15Z

Workflow Verify package library found differences when running yarn api:gen in the JS lib for token-metadata. Please see the job for more details: https://github.com/metaplex-foundation/metaplex-program-library/actions/runs/4803365090.

* Remove InternalUpdateArgs struct and `From` trait implementation. * Deconstruct `UpdateArgs` where used. * Remove redundant authority type and metadata delegate role checks from `Metadata::update_v1` because `validate_update` already checks that the authority is allowed to perform an update, and the `UpdateArgs` enforces that the authority is only changing fields for which it is authorized.

Also make match statements in validate_update more concise.

github-actions · 2023-04-27T19:13:17Z

Workflow Verify package library found differences when running yarn api:gen in the JS lib for token-metadata. Please see the job for more details: https://github.com/metaplex-foundation/metaplex-program-library/actions/runs/4823533102.

github-actions · 2023-04-27T19:15:51Z

Workflow Verify package library found differences when running yarn api:gen in the JS lib for token-metadata. Please see the job for more details: https://github.com/metaplex-foundation/metaplex-program-library/actions/runs/4823555763.

github-actions · 2023-04-27T19:34:17Z

Workflow Verify package library found differences when running yarn api:gen in the JS lib for token-metadata. Please see the job for more details: https://github.com/metaplex-foundation/metaplex-program-library/actions/runs/4823697261.

* Holder authority test. * Pass with same token standard being passed in. * Token doesn't match mint test. * Metadata doesn't match mint test. * Wrong edition test. * Some failure cases around collection-level delegates.

lorisleiva

Thanks Michael! My approval vouches only for the client/JS side but I do really like the API that came out of this PR.

I left a little comment out of curiosity.

token-metadata/program/Cargo.toml

token-metadata/program/src/processor/metadata/update.rs

febo

LGTM

danenbm changed the title ~~New unified Update instruction~~ Update instruction Mar 30, 2023

danenbm changed the title ~~Update instruction~~ Changes to new Update instruction Mar 30, 2023

danenbm added 3 commits April 4, 2023 10:50

Additional Metadata Delegates

5f7b7aa

* Add support in Delegate and Revoke for Authority, Data, CollectionItem, and ProgrammableConfigItem Metadata delegates. * Remove Update Metadata delegate.

Update tests to support new version of UpdateArgs

8d3e5f4

* Also add macro to help destructure UpdateArgs fields.

danenbm force-pushed the danenbm/new-update branch from a6a3b29 to 8d3e5f4 Compare April 4, 2023 18:09

Fix delegate test based on auth rules update

7fcadd8

danenbm added 2 commits April 6, 2023 01:43

Put enums back in original order

ce19636

* Update is still changed to Data but order is preserved. * Also remove unnecessary Option for token_record in Update. * Add some comments clarifying authority types in Unverify.

Change unverify test on collection delegate behavior change

5789cfb

danenbm force-pushed the danenbm/new-update branch from b5d66ad to 21659ce Compare April 6, 2023 09:40

Fix JS Update test

23cfe43

danenbm force-pushed the danenbm/new-update branch from 21659ce to 23cfe43 Compare April 6, 2023 10:11

Modify DA test util object to return delegate or token record

71db91a

* Return the value derived in the delegate method. * Also add a test for Authority delegate.

danenbm added 2 commits April 6, 2023 03:35

Add collection delegate test

8cf0e57

Comment out JS test where the delegate is no longer available

2920b21

danenbm added 2 commits April 6, 2023 03:43

Add test for collection item delegate

dc4852c

Regenerate JS API

5fd48e7

danenbm added 2 commits April 6, 2023 15:42

Add more delegate success test cases

ff4d372

Add tests for delegate not authorized

cd49af1

danenbm added 2 commits April 25, 2023 17:04

Rename UpdateArgs to indicate updating as a role

0cc7129

Regenerate IDL and SDK

be50b1e

danenbm mentioned this pull request Apr 26, 2023

Fix toolchain env variable name in action #1077

Merged

Merge branch 'master' into danenbm/new-update

f96b81a

danenbm force-pushed the danenbm/new-update branch from 351a401 to f96b81a Compare April 27, 2023 00:56

danenbm added 3 commits April 26, 2023 18:29

Allow passing in current token standard

540c093

Also make match statements in validate_update more concise.

Clarify comments and reorder account validations

8cf70af

danenbm force-pushed the danenbm/new-update branch from 4aebe99 to 8cf70af Compare April 27, 2023 19:10

Merge branch 'master' into danenbm/new-update

d131663

danenbm added 2 commits April 27, 2023 12:31

Minor comment update

08ff9d8

Minor description change to generated IDL/SDK

27bf163

Add more BPF tests

e586ea0

* Holder authority test. * Pass with same token standard being passed in. * Token doesn't match mint test. * Metadata doesn't match mint test. * Wrong edition test. * Some failure cases around collection-level delegates.

danenbm requested review from febo, lorisleiva and samuelvanderwaal April 28, 2023 00:11

danenbm assigned lorisleiva Apr 28, 2023

lorisleiva approved these changes Apr 28, 2023

View reviewed changes

token-metadata/program/Cargo.toml Show resolved Hide resolved

blockiosaurus approved these changes Apr 28, 2023

View reviewed changes

token-metadata/program/src/processor/metadata/update.rs Show resolved Hide resolved

febo approved these changes Apr 28, 2023

View reviewed changes

samuelvanderwaal approved these changes May 1, 2023

View reviewed changes

danenbm merged commit 587ad02 into master May 1, 2023

danenbm deleted the danenbm/new-update branch May 1, 2023 20:02

danenbm mentioned this pull request May 1, 2023

Update idea: try using InternalUpdateArgs again to avoid multiple destructure #1079

Closed

danenbm restored the danenbm/new-update branch May 3, 2023 16:42

Changes to new Update instruction #1058

Changes to new Update instruction #1058

Uh oh!

Conversation

danenbm commented Mar 30, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New change

Notes

Cargo lock change

Docs

Enum Compatibility

Delegate expiration

Tests

Unrelated change

Uh oh!

github-actions bot commented Mar 30, 2023

Uh oh!

github-actions bot commented Apr 3, 2023

Uh oh!

github-actions bot commented Apr 4, 2023

Uh oh!

github-actions bot commented Apr 4, 2023

Uh oh!

github-actions bot commented Apr 6, 2023

Uh oh!

github-actions bot commented Apr 6, 2023

Uh oh!

github-actions bot commented Apr 6, 2023

Uh oh!

github-actions bot commented Apr 6, 2023

Uh oh!

github-actions bot commented Apr 6, 2023

Uh oh!

github-actions bot commented Apr 6, 2023

Uh oh!

github-actions bot commented Apr 6, 2023

Uh oh!

github-actions bot commented Apr 25, 2023

Uh oh!

github-actions bot commented Apr 26, 2023

Uh oh!

github-actions bot commented Apr 27, 2023

Uh oh!

github-actions bot commented Apr 27, 2023

Uh oh!

github-actions bot commented Apr 27, 2023

Uh oh!

lorisleiva left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

febo left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Changes to new `Update` instruction #1058

Changes to new `Update` instruction #1058

danenbm commented Mar 30, 2023 •

edited

Loading