Usage

• Provide environment variables file

cp .env.sample .env

• Run with docker-compose

docker-compose up

• Format and lint source code files

npm run format
npm run lint

• Generate database migration file

npm run db:migration:generate <file-name>

• Run database migrations

npm run db:migration:run

Debugging

Few steps are needed in order to be able to debug:

• Create .vscode folder in root directory and create launch.json file.

• Paste the following config:

  {
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "attach",
      "name": "Debug: app-name",
      "remoteRoot": "/usr/src/app",
      "localRoot": "${workspaceFolder}",
      "protocol": "inspector",
      "port": 9229,
      "restart": true,
      "address": "0.0.0.0",
      "skipFiles": ["<node_internals>/**"]
    }
  ]
 }

The important variables are "port": 9229 and "address": "0.0.0.0",

• Open package.json and add this:

"start:debug": "nest start --debug 0.0.0.0:9229 --watch"

• Open .dev.command.sh and replace the last line:

npm run start:dev

with

npm run start:debug

• Run docker-compose up

• After the project has started start the debugger and add a breakpoint somewhere

• The breakpoint should be hit next time you run across it

Remember to not commit the changes to dev.command.sh file

Authentication

The authentication process is based around the notion that a user must prove that he controls a specific address by signing a challenge with the corresponding private key. The first step is to get the challenge by doing a GET request to

API_BASE_URL/api/auth/getChallenge

which returns a string, which you need to sign. You can do this using metamask, or any other kind of wallet provider.

After signing, you post the signature along with the address:

  method: 'post',
  url: 'API_BASE_URL/api/auth/login',
  headers: {
    'Content-Type': 'application/json'
  },
  data : JSON.stringify({"address":"0x39aE4d18f...","signature":"0xe7203e823f..."});

We can extract from the signature and the challenge stored server side the signing address. If the signing address matches the provided address you get JWT token that you can use for subsequent requests.

After you get the token you add as a header to all authenticated requests:

 'Authorization': 'Bearer eyJhbGciOi...'

Mint new collection

The process of minting new collection requires multiple steps:

1. POST /api/nfts/minting-collections. This request will create the collection entity in the database so as to hold all off-chain data

2. Call the deployUniverseERC721() method of UniverseERC721Factory contract and keep the txHash in memory

3. PATCH /api/nfts/minting-collections/{id}. Use this endpoint to send the txHash to backend

Mint NFTs

The process of minting NFTs can be accomplished by the sending the metadata directly to the backend or using an existent Saved NFT

1. Get the token URI
   1.1 Perform a GET /api/saved-nfts/:id/token-uri request to obtain the token URI for a Saved NFT.
   1.2 Perform a POST /api/nfts/token-uri request to obtain the token URI from plain metadata
   The response will have the following format

{
  "mintingNft": {
    "id": number,
  },
  "tokenUris": string[],
}

These 2 endpoints create a new Minting NFT instance, which represents a NFT that is the minting process.
2. Submit transaction to Ethereum blockchain
3. Send the transaction hash using PATCH /api/minting-nfts/:id

{
  "txHash": "..."
}

4. Get My NFTs page by calling the GET /api/pages/my-nfts endpoint