chore: use exotics api v2 #298
Conversation
types/api/xverse/ordinals.ts
Outdated
| export const RoadArmorRareSats = ['MYTHIC', 'LEGENDARY', 'EPIC', 'RARE', 'UNCOMMON', 'COMMON'] as const; | ||
| export type RoadArmorRareSatsType = (typeof RoadArmorRareSats)[number]; |
There was a problem hiding this comment.
nit: should be Rodarmor
types/api/xverse/ordinals.ts
Outdated
| rarity_ranking: SatRarity; | ||
| offset: number; | ||
| }; | ||
| export const Sattributes = [ |
There was a problem hiding this comment.
nit: we use "satribute" in api code
There was a problem hiding this comment.
Yeah, I initially wrote it sattributes everywhere as well because English 😋 All the market places use a single 't' though, so we went with that for consistency.
… types as common/unknown
tests/api/ordinals.test.ts
Outdated
| import { mapRareSatsAPIResponseToBundle } from 'api'; | ||
| import { Bundle, UtxoOrdinalBundle } from 'types'; |
There was a problem hiding this comment.
Please make these relative imports
api/ordinals.ts
Outdated
| totalSats: apiBundle.value, | ||
| }; | ||
|
|
||
| // if bundle has and empty sat ranges, it means that it's a common/unknown bundle |
There was a problem hiding this comment.
nit 👀
| // if bundle has and empty sat ranges, it means that it's a common/unknown bundle | |
| // if bundle has empty sat ranges, it means that it's a common/unknown bundle |
api/ordinals.ts
Outdated
| ); | ||
|
|
||
| const rangeWithUnsupportedSatsAndWithoutInscriptions = | ||
| satRange.satributes.length === 1 && !satRange.inscriptions.length && !supportedSatributes.length; |
There was a problem hiding this comment.
Shouldn't this be
| satRange.satributes.length === 1 && !satRange.inscriptions.length && !supportedSatributes.length; | |
| !satRange.inscriptions.length && !supportedSatributes.length; |
api/ordinals.ts
Outdated
| yearMined, | ||
| satributes, | ||
| // only one inscription per range is supported | ||
| inscriptions: satRange.inscriptions.length > 1 ? [satRange.inscriptions[0]] : satRange.inscriptions, |
There was a problem hiding this comment.
Why do we only support one? 👀
api/ordinals.ts
Outdated
|
|
||
| // if totalExoticSats doesn't match the value of the bundle, | ||
| // it means that the bundle is not fully exotic and we need to add a common unknown sat range | ||
| if (totalExoticSats !== apiBundle.value) { |
There was a problem hiding this comment.
| if (totalExoticSats !== apiBundle.value) { | |
| if (totalExoticSats + totalCommonUnknownInscribedSats !== apiBundle.value) { |
| export type Bundle = Omit<UtxoOrdinalBundle, 'sat_ranges'> & { | ||
| satRanges: BundleSatRange[]; | ||
| inscriptions: SatRangeInscription[]; | ||
| satributes: RareSatsType[][]; |
There was a problem hiding this comment.
This is the return type of the API to bundle mapping. At this point, any unknown satributes would have been filtered out.
Maybe we should have RareSatsType as just RodarmorRareSatsType | SatributesType and use that here. Then we can have something like FuzzyRareSatTypes (please choose a better name 😅 ) which is RareSatsType | string which we can use for the API response type.
|
🔘 PR Type
📜 Background
This PR implements the v2 of exotics API and adds an util to map API response to Bundle
🔄 Changes
Does this PR introduce a breaking change?
Changes:
✅ Review checklist
Please ensure the following are true before merging: