Skip to content

Commit

Permalink
fix: fix types (#4522)
Browse files Browse the repository at this point in the history
## Explanation

Added optional types on the `NftMetadata` type.

## References

<!--
Are there any issues that this pull request is tied to? Are there other
links that reviewers should consult to understand these changes better?

For example:

* Fixes #12345
* Related to #67890
-->

## Changelog

<!--
If you're making any consumer-facing changes, list those changes here as
if you were updating a changelog, using the template below as a guide.

(CATEGORY is one of BREAKING, ADDED, CHANGED, DEPRECATED, REMOVED, or
FIXED. For security-related issues, follow the Security Advisory
process.)

Please take care to name the exact pieces of the API you've added or
changed (e.g. types, interfaces, functions, or methods).

If there are any breaking changes, make sure to offer a solution for
consumers to follow once they upgrade to the changes.

Finally, if you're only making changes to development scripts or tests,
you may replace the template below with "None".
-->

### `@metamask/assets-controllers`

- **ADDED**: Added optional `topBid` type in `NftMetadata` type
- **ADDED**: Added optional `floorAsk` in `TokenCollection` type
- **FIXED**:  Fixed type. attributes in NftMetadata to be `Attributes[]`


## Checklist

- [ ] I've updated the test suite for new or updated code as appropriate
- [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [ ] I've highlighted breaking changes using the "BREAKING" category
above as appropriate
  • Loading branch information
sahar-fehri authored and MajorLift committed Jul 16, 2024
1 parent 8ea6ab2 commit 9f7203f
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 1 deletion.
4 changes: 3 additions & 1 deletion packages/assets-controllers/src/NftController.ts
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ import type {
Attributes,
LastSale,
GetCollectionsResponse,
TopBid,
} from './NftDetectionController';

type NFTStandardType = 'ERC721' | 'ERC1155';
Expand Down Expand Up @@ -176,9 +177,10 @@ export type NftMetadata = {
tokenURI?: string | null;
collection?: Collection;
address?: string;
attributes?: Attributes;
attributes?: Attributes[];
lastSale?: LastSale;
rarityRank?: string;
topBid?: TopBid;
};

/**
Expand Down
21 changes: 21 additions & 0 deletions packages/assets-controllers/src/NftDetectionController.ts
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 +351,26 @@ export type CollectionResponse = {
};
};

export type FloorAskCollection = {
id?: string;
price?: Price;
maker?: string;
kind?: string;
validFrom?: number;
validUntil?: number;
source?: SourceCollection;
rawData?: Metadata;
isNativeOffChainCancellable?: boolean;
};

export type SourceCollection = {
id: string;
domain: string;
name: string;
icon: string;
url: string;
};

export type TokenCollection = {
id?: string;
name?: string;
Expand All @@ -367,6 +387,7 @@ export type TokenCollection = {
floorAskPrice?: Price;
royaltiesBps?: number;
royalties?: Royalties[];
floorAsk?: FloorAskCollection;
};

export type Collection = TokenCollection & CollectionResponse;
Expand Down

0 comments on commit 9f7203f

Please sign in to comment.