NFT APIs

[pro-wh]

this first part has a way to list NFTs by contract address

[mitjat]

When this gets closer to stable, let's loop in the FE folks, and possibly Matevz as effectively our developer advocate.

[mitjat]

👍
Just trying to figure out how the relationship between individual NFTs and ERC721 contracts should be reflected in our API.

[csillag]

I am getting SWAGGER OpenAPI validation errors.

🍻 Start orval v6.17.0 - A swagger client generator for typescript
⚠ SyntaxError: Swagger schema validation failed.
#/paths/1{runtime}1evm_nfts1{address}/get/responses/200/content/application1json/schema/allOf/1/properties/evm_nfts/items/required must NOT have fewer than 1 items
#/paths/1{runtime}1evm_nfts1{address}/get/responses/200/content/application1json/schema/allOf/1/properties/evm_nfts/items must have required property '$ref'
#/paths/1{runtime}1evm_nfts1{address}/get/responses/200/content/application1json/schema/allOf/1/properties/evm_nfts/items must match exactly one schema in oneOf
#/paths/1{runtime}1evm_nfts1{address}/get/responses/200/content/application1json/schema/allOf/1/properties/evm_nfts must have required property '$ref'
#/paths/1{runtime}1evm_nfts1{address}/get/responses/200/content/application1json/schema/allOf/1/properties/evm_nfts must match exactly one schema in oneOf
#/paths/1{runtime}1evm_nfts1{address}/get/responses/200/content/application1json/schema/allOf/1 must have required property '$ref'
#/paths/1{runtime}1evm_nfts1{address}/get/responses/200/content/application1json/schema/allOf/1 must match exactly one schema in oneOf
#/paths/1{runtime}1evm_nfts1{address}/get/responses/200/content/application1json/schema must have required property '$ref'
#/paths/1{runtime}1evm_nfts1{address}/get/responses/200/content/application1json/schema must match exactly one schema in oneOf
#/paths/~1{runtime}1evm_nfts1{address}/get/responses/200 must have required property '$ref'
#/paths/~1{runtime}1evm_nfts1{address}/get/responses/200 must match exactly one schema in oneOf
#/components/schemas/EvmNftList/allOf/1/properties/evm_nfts/items/required must NOT have fewer than 1 items
#/components/schemas/EvmNftList/allOf/1/properties/evm_nfts/items must have required property '$ref'
#/components/schemas/EvmNftList/allOf/1/properties/evm_nfts/items must match exactly one schema in oneOf
#/components/schemas/EvmNftList/allOf/1/properties/evm_nfts must have required property '$ref'
#/components/schemas/EvmNftList/allOf/1/properties/evm_nfts must match exactly one schema in oneOf
#/components/schemas/EvmNftList/allOf/1 must have required property '$ref'
#/components/schemas/EvmNftList/allOf/1 must match exactly one schema in oneOf
#/components/schemas/EvmNftList must have required property '$ref'
#/components/schemas/EvmNftList must match exactly one schema in oneOf
#/components/schemas/EvmNft/required must NOT have fewer than 1 items
#/components/schemas/EvmNft must have required property '$ref'
#/components/schemas/EvmNft must match exactly one schema in oneOf

These all seem to be related to the new additions; the version on the master branch passes without any issues.

[pro-wh]

yeah these look like they're related to the additions. I'll check on these tomorrow

[csillag]

yeah these look like they're related to the additions. I'll check on these tomorrow

If there will be an update, it would be very nice to sneak it the owner field, too.

[pro-wh]

gonna add the owner field in #529

[pro-wh]

"token" info moved to subobject, matching evm tokens json schema. however, note that that api was designed earlier, where more fields are required. those fields will have the Go default value when the data is not available. e.g. the zero ethereum address if we somehow don't know the preimage or token type unknown instead of null if we haven't checked the contract yet

[pro-wh]

moved to /{runtime}/evm_tokens/{address}/nfts

[mitjat]

Thank you for the additional changes!

A reply to your comment:

"token" info moved to subobject, matching evm tokens json schema.
note that that api was designed earlier, where more fields are required.

Now is the "best" time to change that in a backwards-incompatible way -- best compared to any future time. I'm sure @csillag can accommodate optionality on the FE, and we don't have other clients for now.
OTOH if the only two potentially-defaulted fields are eth_address and token_type, I wouldn't worry. token_type has to be 721 for us to even list the NFT, presumably? And not knowing the preimage would pretty much imply a bug in nexus, because all events via which we observe NFTs are encoded with eth addresses, so we observe preimages all the time. So I'm not worried about that corner case either.

[pro-wh]

metadata_accessed lmao

[pro-wh]

changes worth looking at:

1. new e2e regression test hits network resources. time bomb warning
2. db fixes, let me know if it's right

[Andrew7234]

nit: If 21_evm_nfts.up.sql hasn't been applied yet to prod, I'd also be fine with merging this with that migration. This way is also completely fine too.

[pro-wh]

it was in 0.1.16 😬