NFT Module #4209

fedekunze · 2019-04-26T21:05:05Z

Closes #4046

Specification: #4766

Closes: #4809

Targeted PR against correct branch (see CONTRIBUTING.md)
Linked to github-issue with discussion and accepted design OR link to spec that describes this work.
Wrote tests
Updated relevant documentation (docs/)
Added a relevant changelog entry: sdkch add [section] [stanza] [message]
rereviewed Files changed in the github PR explorer

For Admin Use:

Added appropriate labels to PR (ex. wip, ready-for-review, docs)
Reviewers Assigned
Squashed all commits, uses message "Merge pull request #XYZ: [title]" (coding standards)

…lly/nft

x/nfts/client/cli/query.go

x/nfts/querier/querier.go

x/nfts/keeper/key.go

x/nfts/types/msgs.go

x/nft/client/cli/query.go

rigelrozanski

Mostly reviewed the spec. Beyond the typos I'm okay with this PR getting merged without the major indexing changes I've suggested so long as issues are opened such that NFT will be updated in future PRs.

After these comments are addressed (as well as merge conflicts) I recommend we merge NFT ASAP in order to include it in our on-going sdk maintenance as core changes are made.

docs/spec/SPEC-SPEC.md

rigelrozanski · 2019-08-02T20:52:59Z

docs/spec/nft/01_concepts.md

+}
+```
+
+An `IDCollection` is similar to a `Collection` except instead of containing NFTs it only contains an array of `NFT` IDs. This saves storage by avoiding redundancy.


EDIT:
we should most likely eliminate these structs if they are expected to be stored anywhere and simply replace them with indexes on the NFT object see my next comment

~~couple things, a) in the above owner struct the field is of type IDCollections however you only define the IDCollection (singular) struct below, we should probably also include the line:~~

type IDCollections [] IDCollection

~~just for clarity.~~

b) type Collection should probably expose a function GetIDCollections() IDCollections and similarly NFT should expose a function GetIDCollection() IDCollection. These functions are worth mentioning maybe? add this into the NFT type interface at maybe?

Opened the issue https://github.com/cosmos/cosmos-sdk/issues/4955

docs/spec/nft/01_concepts.md

rigelrozanski · 2019-08-02T21:09:50Z

docs/spec/nft/01_concepts.md

+type IDCollection struct {
+  Denom string   `json:"denom"`
+  IDs   []string `json:"IDs"`
+}


Yo. Okay so I think that the NFT design should be restructured to eliminate the:

Owner struct

IDCollection struct

We should instead by applying the use of secondary indexes similarly to how the staking module stores references to the same validators by: operator-address, consensus-address, power, etc. (see example https://github.com/cosmos/cosmos-sdk/blob/master/x/staking/keeper/validator.go#L70)
(see spec: https://github.com/cosmos/cosmos-sdk/blob/master/docs/spec/staking/01_state.md#validator)

This way we should be able to easily create functions on the NFTKeeper to get the NFTs efficiently without requiring these extra object. For example I'd suggest the keeper look like:

type NFTKeeper interface { GetNFTByID(string) NFT GetCollectionByDenom(string) []*NFT GetCollectionsByOwner(sdk.AccAddress) []Collection }

Or something along those lines.

Opened the issue #4955

rigelrozanski · 2019-08-02T21:10:28Z

docs/spec/nft/02_state.md

+
+As all NFTs belong to a specific `Collection`, they are kept on store in an array
+within each `Collection`. Every time an NFT that belongs to a collection is updated,
+it needs to be updated on the corresponding NFT array on the corresponding `Collection`.


whoa - are you saying NFTs are stored in two places? that sounds like asking for trouble. We should most certainly only store pointer objects in the collection to avoid having to update both. (See my suggested code change to the spec).

Also referenced in https://github.com/cosmos/cosmos-sdk/issues/4955

docs/spec/nft/05_future_improvements.md

docs/spec/nft/README.md

Co-Authored-By: frog power 4000 <rigel.rozanski@gmail.com>

…lly/nft

tnachen · 2019-08-22T16:59:40Z

needs @rigelrozanski @alexanderbez review

alexanderbez · 2019-08-22T18:20:08Z

I would not advise blocking this PR on my review (although I will still review). Please resolve CI and merge conflict issues and merge with preferably @rigelrozanski's approval.

simapp/sim_test.go

x/nft/client/cli/query.go

x/nft/simulation/operations/msgs.go

x/nft/internal/keeper/querier_test.go

simapp/sim_test.go

x/nft/internal/keeper/querier_test.go

x/nft/internal/types/owners_test.go

RiccardoM · 2019-08-26T05:38:29Z

Sorry for asking guys, but is this PR going to be merged anytime soon?

fedekunze · 2019-08-26T07:47:05Z

@RiccardoM yeah, @rigelrozanski just needs to approve + merge

rigelrozanski

Approved - indexing issue opened as an offshoot here (https://github.com/cosmos/cosmos-sdk/issues/4955)

simapp/app.go

Co-Authored-By: Bot from GolangCI <42910462+golangcibot@users.noreply.github.com>

* in sync with @okwme/cosmos-nft * remove tmp tx * structuring and minor changes * supply and client files * adding cli client * complete cli/tx and rest.go * cleanup and restructuring * restructure rest folder * minor updates on clients * update querier * encoding for clients and other changes * genesis, invariants, and keeper updates * update types * make golangcibot happy * renamed and removed bank keeper * remove handlers for editmetadata, mint, burn, buy * nft interface * minor cleanup * sort collections and nfts * balance and find * nft query and tx * touch ups * uint in place of int Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * little fixes: - fix error to err to avoid collision - error handling Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * module generalization changes * fixes * query with data * minor updates and TODOs * fix CLI tx * golang bot fixes * handlers and txs done * update module generalization * Added very basic tests which for some reason do not work * fix test Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * fixed test, now we should fix implementation, seems to fail Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * fix test, create new struct instead of changing the old one Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * fix handler with new logic Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * let's make it compile Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * single failing test example, need to be fixed and extended Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * single failing test example, need to be fixed and extended Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * reverting work, still problems unmarshalling inside iterator from test Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * Setter in nft.go should return NFT instead of BaseNFT Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * remove TODOS Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * comment out broken tests, we want at least a green mark here Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * little fixes Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * hopefully no conflict * minor changes for tests * change nft id to string, refactors * messy pause * Changes Balances to OWners add all necessary functions, updated Keeper with UpdateNFT as as well as MintNFT and made sure they all update Owners * pause dev to merge sdk master * go.mod changes * getting closer still need module.go * builds!!! * fix lint begin handler tests * stableish * re-order nft attributes, add back mint and burn msgs and handlers * add errors to minting the same NFT and burning an NFT that doesnt exist * first querier test * add simulations for nft msgs * handler tests check tags now (fixed a bug!) * update simulation * generic handler * need to check if it compiles on another machine * fix weird interface error * add back cli * wtfff * codec error fixed, logs removed. still returning empty arrays of IDs * Take empty input as yes answer Closes: cosmos#4564 * Add pending log entry * merged in master * marshall errors * build commands * working!!! * linting errors * remove unused func * pause * fix burn error * fix burn error * tests for querier * typo * tests for NFT types * module spec standard * tests for Collection and Collections types * merge w Fede * tests for Owner Type * added genesis tests and beefed up keeper, querier, handler & types tests * linting errors deadcode * DONT COVER test_common.go * add msg type tests * Update x/nft/internal/keeper/key.go Co-Authored-By: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * Update x/nft/genesis.go Co-Authored-By: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * Update x/nft/client/cli/query.go Co-Authored-By: Federico Kunze <31522760+fedekunze@users.noreply.github.com> * Apply suggestions from code review * typo * cleanup events * split events * more cleanup * remove restrictions from default handlers * not sure where these go mod changes came from * sim generated changes * make format * add mint and burn sims * move NFT interface to nft/exported * make format * NFT spec * Updates * more updates * update specs readme * fix sims * rest additions * rest additions * fix invariant * minimal nft without name, description or image * sim * fix sim * fix sim * fix Update methods * nothing * simplify update and remove Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * remove test on memory location Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * TEST to get logs, need to be removed Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * fix simulator editMetadata Msg type * owner not found start with empty collection Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * artifacts on errors in case of failure, else, no artifacts Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com> * add more invariant checks to handler_tests * never forget to overwrite * merge and update spec * colins feedback * code coverage test * code coverage test * code coverage test * spelling * clean up client * testing code coverage * testing code coverage * testing code coverage * testing code coverage * testing code coverage * Update docs/spec/nft/README.md Co-Authored-By: frog power 4000 <rigel.rozanski@gmail.com> * Apply suggestions from code review Co-Authored-By: frog power 4000 <rigel.rozanski@gmail.com> * minor changes * integration tests and fixes * minor golangCI fixes * Update simapp/app.go Co-Authored-By: Bot from GolangCI <42910462+golangcibot@users.noreply.github.com>

okwme and others added 8 commits April 15, 2019 16:45

in sync with @okwme/cosmos-nft

9d751b4

remove tmp tx

b7c8c7f

structuring and minor changes

8d57122

supply and client files

29b170d

adding cli client

53ddc52

complete cli/tx and rest.go

bf8864e

cleanup and restructuring

e018425

restructure rest folder

4fc18b0

fedekunze requested review from alessio, alexanderbez, jackzampolin and rigelrozanski as code owners April 26, 2019 21:05

fedekunze added the WIP label Apr 26, 2019

fedekunze added 2 commits April 28, 2019 16:03

Merge branch 'master' of https://github.com/cosmos/cosmos-sdk into bi…

2183f39

…lly/nft

minor updates on clients

a9aa360

golangcibot reviewed Apr 28, 2019

View reviewed changes

x/nfts/client/cli/query.go Outdated Show resolved Hide resolved

x/nfts/client/cli/query.go Outdated Show resolved Hide resolved

update querier

6018b16

golangcibot reviewed Apr 28, 2019

View reviewed changes

x/nfts/querier/querier.go Outdated Show resolved Hide resolved

encoding for clients and other changes

b438068

fedekunze requested a review from okwme April 28, 2019 23:15

genesis, invariants, and keeper updates

c904493

golangcibot reviewed Apr 29, 2019

View reviewed changes

x/nfts/keeper/key.go Outdated Show resolved Hide resolved

x/nfts/types/msgs.go Outdated Show resolved Hide resolved

x/nfts/types/msgs.go Outdated Show resolved Hide resolved

update types

8ebfdc9

golangcibot reviewed Apr 29, 2019

View reviewed changes

x/nfts/types/msgs.go Outdated Show resolved Hide resolved

fedekunze and others added 2 commits April 30, 2019 01:36

make golangcibot happy

dcb7e04

renamed and removed bank keeper

65194cf

golangcibot reviewed May 2, 2019

View reviewed changes

x/nft/client/cli/query.go Outdated Show resolved Hide resolved

x/nft/client/cli/query.go Outdated Show resolved Hide resolved

okwme and others added 3 commits May 2, 2019 23:17

remove handlers for editmetadata, mint, burn, buy

6fe5e40

nft interface

7f18f53

minor cleanup

d782701

okwme added 5 commits July 31, 2019 17:35

testing code coverage

c1fa44e

testing code coverage

6b5e0ed

testing code coverage

a859dfd

testing code coverage

575d991

testing code coverage

c613491

rigelrozanski suggested changes Aug 2, 2019

View reviewed changes

fedekunze and others added 5 commits August 2, 2019 23:34

Update docs/spec/nft/README.md

e0e68cd

Co-Authored-By: frog power 4000 <rigel.rozanski@gmail.com>

Apply suggestions from code review

a0c3799

Co-Authored-By: frog power 4000 <rigel.rozanski@gmail.com>

merge master

7f79b92

minor changes

5e47cc2

Merge branch 'master' of https://github.com/cosmos/cosmos-sdk into bi…

caec9f3

…lly/nft

merge master; add sim decoder

81dd140

golangcibot reviewed Aug 24, 2019

View reviewed changes

integration tests and fixes

151f309

fedekunze requested a review from rigelrozanski August 24, 2019 08:33

golangcibot reviewed Aug 24, 2019

View reviewed changes

minor golangCI fixes

e44c1db

Merge branch 'master' into billy/nft

ccf6a52

rigelrozanski approved these changes Aug 26, 2019

View reviewed changes

golangcibot reviewed Aug 26, 2019

View reviewed changes

simapp/app.go Outdated Show resolved Hide resolved

Update simapp/app.go

832de38

Co-Authored-By: Bot from GolangCI <42910462+golangcibot@users.noreply.github.com>

rigelrozanski merged commit eeb847c into master Aug 26, 2019

rigelrozanski deleted the billy/nft branch August 26, 2019 16:54

fedekunze mentioned this pull request Aug 27, 2019

NFT module spec #4735

Closed

4 tasks

rigelrozanski mentioned this pull request Oct 9, 2019

NFT Module - Use Store Indexes cosmos/modules#6

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

NFT Module #4209

NFT Module #4209

fedekunze commented Apr 26, 2019 •

edited by okwme

Loading

rigelrozanski left a comment

rigelrozanski Aug 2, 2019 •

edited by fedekunze

Loading

rigelrozanski Aug 26, 2019

rigelrozanski Aug 2, 2019

rigelrozanski Aug 26, 2019

rigelrozanski Aug 2, 2019

rigelrozanski Aug 26, 2019

tnachen commented Aug 22, 2019

alexanderbez commented Aug 22, 2019

RiccardoM commented Aug 26, 2019

fedekunze commented Aug 26, 2019

rigelrozanski left a comment

NFT Module #4209

NFT Module #4209

Conversation

fedekunze commented Apr 26, 2019 • edited by okwme Loading

rigelrozanski left a comment

Choose a reason for hiding this comment

rigelrozanski Aug 2, 2019 • edited by fedekunze Loading

Choose a reason for hiding this comment

rigelrozanski Aug 26, 2019

Choose a reason for hiding this comment

rigelrozanski Aug 2, 2019

Choose a reason for hiding this comment

rigelrozanski Aug 26, 2019

Choose a reason for hiding this comment

rigelrozanski Aug 2, 2019

Choose a reason for hiding this comment

rigelrozanski Aug 26, 2019

Choose a reason for hiding this comment

tnachen commented Aug 22, 2019

alexanderbez commented Aug 22, 2019

RiccardoM commented Aug 26, 2019

fedekunze commented Aug 26, 2019

rigelrozanski left a comment

Choose a reason for hiding this comment

fedekunze commented Apr 26, 2019 •

edited by okwme

Loading

rigelrozanski Aug 2, 2019 •

edited by fedekunze

Loading