Add Nft Api Compute Rarity #148
Conversation
…/nft-api-compute-rarity
…lchemy-sdk-js into xeno097/nft-api-compute-rarity
src/types/types.ts
Outdated
| value: string; | ||
|
|
||
| /** The type of NFT attribute. */ | ||
| trait_type: string; |
There was a problem hiding this comment.
Please rename to traitType in order to be consistent with JS style.
src/types/types.ts
Outdated
| /** The type of NFT attribute. */ | ||
| trait_type: string; | ||
|
|
||
| /** The NFT's attribute frequency in the current collection. */ |
There was a problem hiding this comment.
Please update comment to:
A number from 0 to 1 representing the prevalence of this value for this trait type in the current collection.
| const response = await alchemy.nft.computeRarity(contractAddress, tokenId); | ||
|
|
||
| expect(response).toBeDefined(); | ||
| expect(response.length).toBeGreaterThan(0); |
There was a problem hiding this comment.
Please update the test to check that each field in the response type is present in the first element of the array.
There was a problem hiding this comment.
Thank you for the suggestion!
test/unit/nft-api.test.ts
Outdated
| 'contractAddress', | ||
| contractAddress | ||
| ); | ||
| expect(mock.history.get[0].params).toHaveProperty('tokenId', tokenId); |
There was a problem hiding this comment.
Once you update trait_type to traitType, can you also add a test to check that the method converts the field properly?
…mputeRarity method
test/unit/nft-api.test.ts
Outdated
| @@ -1204,6 +1209,54 @@ describe('NFT module', () => { | |||
| }); | |||
| }); | |||
|
|
|||
| describe('computeRarity()', () => { | |||
| const contractAddress = '0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d'; | |||
| const tokenId = '7495'; | |||
There was a problem hiding this comment.
one more request: can you use a numerical value for tokenId here to check that the logic to convert Bignumberish input to a string is properly executed? Thanks!
🔥 |
…g call works correctly in computeRarity tests
Changelog
computeRaritymethod in thenftnamespace.NftAttributeRaritytype to represent the result of thecomputeRarityendpoint.OwnedBaseNftsResponsetype doc.computeRaritymethod.Extra
I was considering wrapping the
computeRarityendpoint result in an object with the following structure{attributes: NftAttributeRarity[] }and exposing that in the public API but then decided to keep the same format as the endpoint response. Also, I'll gladly accept suggestions for theNftAttributeRaritytype name if you have a better name for this use case.The other endpoints listed in #140 will be added in another pr.