avislash / nftstamper

NFT Image Stamper

NFT Stamper

NFT Stamper is a Golang Discord bot designed to programatically apply custom images/branding to supported NFT Collections.

Installation

Standard go installation

$ go get github.com/avislash/nftstamper@latest

Usage & Examples

Using the bot is fairly simple

Begin by running

./nftstamper -h

This will print out a list of supported NFT collections for which the bot can be brought up for.

Refer to respective READMEs under supported collections for configuring and running the bot for that collection.

Supported Collections

• The Mutant Cartel
  • Mutant Hounds
    • Mega Hound Support Pending
• Applied Primate Engineering (A.P.E.)
  • MegaForce Sentinels

How do I get a collection integrated

You may add the collection yourself by either

1. Cloning the repo and modifying the source code and/or artwork
2. Contacting me using one of the options listed in the Contact Me section
3. Opening an issue via the Github Issue Tracker

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Acknowledgements

• The Best Online README Generator

Contact Me

nftstamper's Issues

Refactor repeated logic in bgReplacementInteraction function

There is repeated logic in the function for fetching metadata and images from IPFS. This logic could be refactored into separate methods to adhere to the DRY principle and improve code maintainability.

An example of how the refactoring could look like is provided below:

// Example refactoring for fetching metadata and images from IPFS
func fetchMetadataAndImage(client ipfs.Client, fetcher metadata.MetadataFetcher, id uint64) (*bytes.Buffer, error) {
    metadata, err := fetcher.Fetch(id)
    if err != nil {
        return nil, fmt.Errorf("Failed to fetch Metadata for ID %d: %w", id, err)
    }

    image, err := client.GetImageFromIPFS(metadata.Image)
    if err != nil {
        return nil, fmt.Errorf("Failed to retrieve image from IPFS for ID %d: %w", id, err)
    }

    return image, nil
}

This issue was created following a discussion in PR #27.

Refactor repeated logic in cutoutInteraction function

There is repeated logic for fetching metadata and images from IPFS within the function. This logic could be refactored into separate methods to adhere to the DRY principle and improve code maintainability.

A committable suggestion was provided in PR #27, which should be implemented to reduce redundancy.

PR URL: #27
Comment URL: #27 (comment)

This issue is to track the implementation of the suggested changes in a separate PR as per the discussion in the PR comments.