feat/metadata-field-hip-766 #64
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: michalrozekariane <[email protected]>
…adata-field-hip-766 Signed-off-by: michalrozekariane <[email protected]>
Signed-off-by: michalrozekariane <[email protected]>
Signed-off-by: michalrozekariane <[email protected]>
Signed-off-by: michalrozekariane <[email protected]>
Signed-off-by: michalrozekariane <[email protected]>
Signed-off-by: michalrozekariane <[email protected]>
Signed-off-by: michalrozekariane <[email protected]>
Signed-off-by: michalrozekariane <[email protected]>
Signed-off-by: michalrozekariane <[email protected]>
Signed-off-by: michalrozekariane <[email protected]>
Signed-off-by: michalrozekariane <[email protected]>
Signed-off-by: michalrozekariane <[email protected]>
BartoszSolkaArianelabs
requested changes
May 10, 2024
README.md
Outdated
| @@ -30,6 +30,7 @@ This package includes all sorts of tooling for the Hedera NFT ecosystem, includi | |||
| - **PinataService:** Utilizes Pinata Cloud to pin files to IPFS, providing an `ipfs://` URL upon successful upload. Includes metadata and options customization. | |||
| - **NftStorageService:** Integrates with the NFT.storage API to upload files directly to IPFS and returns an `ipfs://` URL. It supports dynamic API key usage based on a provided list. | |||
| - **MockStorageService:** A mock storage service for testing purposes, returning predefined URLs. | |||
| 15. **Collection Metadata Validation** Provides a possibility to validate the collection metadata of a collection against the HIP766 metadata schema. This method can handle both direct HTTP(S) URLs or IPFS CIDs as input. If an IPFS CID is provided without a full URL, the method will attempt to use an IPFS gateway to retrieve the metadata. The IPFS gateway parameter is optional; if not specified and required (i.e., when a CID is provided without a full URL), the method will throw an error indicating that the IPFS gateway is required. This ensures that the metadata conforms to the standards required for NFT collections on the Hedera network. The validator provides a thorough check, highlighting any errors or missing fields in the collection metadata structure. | |||
There was a problem hiding this comment.
change HIP766 to HIP-766 and add a hyperlink to https://hips.hedera.com/hip/hip-766
README.md
Outdated
| @@ -1812,6 +1814,39 @@ type UploadResult = { | |||
|
|
|||
| --- | |||
|
|
|||
| ## Collection Metadata Validation | |||
|
|
|||
| The `validateCollectionMetadata` validates the metadata of a collection against the [HIP766 metadata schema](https://hips.hedera.com/hip/hip-766) using a specified IPFS gateway to retrieve the metadata. This method ensures that the metadata conforms to the standards required for NFT collections on the Hedera network, offering a comprehensive check that highlights any errors or missing fields in the metadata structure. | |||
There was a problem hiding this comment.
change HIP766 to HIP-766
README.md
Outdated
|
|
||
| This method returns an object that contains: | ||
|
|
||
| - `isValid`: A boolean flag indicating whether the metadata conforms to the HIP766 schema. |
There was a problem hiding this comment.
change HIP766 to HIP-766
Signed-off-by: michalrozekariane <[email protected]>
BartoszSolkaArianelabs
approved these changes
May 10, 2024
Signed-off-by: kacper-koza-arianelabs <[email protected]>
Signed-off-by: kacper-koza-arianelabs <[email protected]>
Signed-off-by: kacper-koza-arianelabs <[email protected]>
kacper-koza-arianelabs
force-pushed
the
feat/metadata-field-hip-766
branch
from
398f480 to
d4dd707
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist