Setup

Learn how to setup the NFT-Kit on your local system

Choose your system

Do you want to build using our APIs or add the NFT-Kits functionalities as a direct dependency in a Kotlin/Java application

API

Get started building with our API endpoints

Java/Kotlin SDK

Add the NFT-Kits functionality as a direct dependency

API

Installation & Running the Project

Make sure you have Docker or a JDK 16 build environment including Gradle installed on your machine

Docker Build

1. Clone the project

git clone https://github.com/walt-id/waltid-nftkit.git

2. Change the folder

cd waltid-nftkit/

3. Configure your project

4. Building the docker container

docker build -t nftkit .

5. Running the container

docker run -p 7000:7000 -it nftkit

Local Build

1. Clone the project

git clone https://github.com/walt-id/waltid-nftkit.git

2. Change the folder

cd waltid-nftkit/

3. Configure your project

4. Build the project

gradle clean build

5. Run the executable

In build/distributions/ you have two archives, a .tar, and a .zip.

Extract the one that is built for your system and run it.

cd build/distributions/
tar xf waltid-nftkit-1.SNAPSHOT.tar
./waltid-nftkit-1.SNAPSHOT/bin/waltid-nftkit

Start Building

NFT | Creation & Management - How to deploy Smart Contracts and mint NFTs

NFT | Ownership Verification - How to verify NFT ownership within a collection and traits

Smart Contract | Extensions - Pause token transfers, minting and burning

Smart Contract | Access Control - Access Control functionalities

Kotlin/Java SDK

Gradle

implementation("id.walt:waltid-nftkit:VERSION")

Maven

  <dependency>
        <groupId>id.walt</groupId>
        <artifactId>waltid-nftkit</artifactId>
        <version>VERSION</version>
   </dependency>

Required Maven repos:

https://maven.walt.id/repository/waltid/

Start Building

NFT | Creation & Management - How to deploy Smart Contracts and mint NFTs

NFT | Ownership Verification - How to verify NFT ownership within a collection and traits

Smart Contract | Extensions - Pause token transfers, minting and burning

Smart Contract | Access Control - Access Control functionalities