A progressive Node.js framework for building efficient and scalable server-side applications.

Description

Nest framework TypeScript starter repository.

Installation

$ yarn install

Running the app

# development
$ yarn run start:dev:node1
$ yarn run start:dev:node2
$ yarn run start:dev:node3
# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod

Test

# unit tests
$ yarn run test

# e2e tests
$ yarn run test:e2e

# test coverage
$ yarn run test:cov

Docs API

Ordinal

Base URL: /ordinals

Endpoints

1. Create Ordinal Create a new ordinal.

• HTTP Method: POST
• Endpoint: /ordinals
• Request Body: JSON object of type CreateOrdinalDto
• Request Body (CreateOrdinalDto)
• Field Type Description
• nftId string The ID of the NFT associated with the ordinal.
• owner string The owner of the ordinal.
• price Number The price of the ordinal. (optional)
• promptPrice Number The prompt price of the ordinal. (optional)
• promptBuyer Array An array of strings containing the prompt buyers' IDs. (optional)

2. Get Ordinal by ID

• Retrieve an ordinal by its NFT ID.

• HTTP Method: GET

• Endpoint: /ordinals/:id

• Path Parameter: id (string) - The NFT ID of the ordinal to retrieve.

3. Get All Ordinals

• Retrieve a list of all ordinals.

• HTTP Method: GET

• Endpoint: /ordinals

4. Update Ordinal

• Update the owner of an existing ordinal. Requires authentication with an access token.

• HTTP Method: PUT

• Endpoint: /ordinals

• Request Body: JSON object of type UpdateOrdinalDto

• Request Header: Authorization - Bearer token (required)

5. Delete Ordinal

• Delete an existing ordinal. Requires authentication with an access token.

• HTTP Method: DELETE

• Endpoint: /ordinals/:id

• Path Parameter: id (string) - The NFT ID of the ordinal to delete.

• Request Header: Authorization - Bearer token (required)

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.