https://github.com/balmy-protocol/nft-descriptors

A repository to store all NFT descriptors
https://github.com/balmy-protocol/nft-descriptors

Last synced: 14 days ago
JSON representation

A repository to store all NFT descriptors

• Host: GitHub
• URL: https://github.com/balmy-protocol/nft-descriptors
• Owner: Balmy-protocol
• License: agpl-3.0
• Created: 2022-08-03T21:14:25.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-29T12:20:05.000Z (8 months ago)
• Last Synced: 2024-05-09T15:10:37.389Z (6 months ago)
• Language: Solidity
• Size: 1.26 MB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Lint](https://github.com/Mean-Finance/nft-descriptors/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/Mean-Finance/nft-descriptors/actions/workflows/lint.yml)

[![Tests](https://github.com/Mean-Finance/nft-descriptors/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/Mean-Finance/nft-descriptors/actions/workflows/tests.yml)

[![Slither Analysis](https://github.com/Mean-Finance/nft-descriptors/actions/workflows/slither.yml/badge.svg?branch=main)](https://github.com/Mean-Finance/nft-descriptors/actions/workflows/slither.yml)

# Mean Finance NFT Descriptors

This repository holds Mean's NFT Descriptors. These are contracts that will generate an SVG completely on-chain, to describe the current state of an NFT.

## Package

The package will contain:

- Artifacts can be found under `@mean-finance/nft-descriptors/artifacts`

- Compatible deployments for [hardhat-deploy](https://github.com/wighawag/hardhat-deploy) plugin under the `@mean-finance/nft-descriptors/deployments` folder.

- Typescript smart contract typings under `@mean-finance/nft-descriptors/typechained`

## Documentation

Everything that you need to know as a developer on how to use all repository smart contracts can be found in the [documented interfaces](./solidity/interfaces/).

## Installation

To install with [**Hardhat**](https://github.com/nomiclabs/hardhat) or [**Truffle**](https://github.com/trufflesuite/truffle):

#### YARN

```sh

yarn add @mean-finance/nft-descriptors

```

### NPM

```sh

npm install @mean-finance/nft-descriptors

```