Introduction

The NuvoSphere Inscription Platform is designed for seamless interactions with EVM-compatible blockchains. It integrates key components including a blockchain event indexer, a user-friendly frontend, and a comprehensive REST API, making it an all-encompassing platform for managing blockchain transactions.

Objective

Aiming to provide a streamlined experience, the platform simplifies various blockchain operations like token deployment, minting inscriptions, and transaction management. It is tailored to cater to a wide range of users, from beginners to experienced developers, ensuring accessibility and efficiency.

Construct Mint Message

Path

• GET /message/mint/:ticker/:id/:amount

Description

• Creates a mint message for a specific ticker, ID, and amount.

Parameters

• ticker: Ticker symbol (path parameter).

• id: Token ID (path parameter).

• amount: Amount to mint (path parameter).

Request Example

Response Example

Path

• GET /holder/:ticker

Description

• Get number of holders for a ticker

Parameters

• tick: Ticker symbol (query parameter)

Request Example

Response Example

Unique Features of the NuvoSphere Inscription Platform

The NuvoSphere Inscription Platform stands out with several unique features:

1. Customizable Minting Process:

   • Deployers can specify contracts to refine controls over the minting process, offering flexibility and enhanced security.

2. Unique Sequencing for Minting:

   • While global uniqueness isn’t enforced, the platform ensures a unique sequence in the minting process, making it fairer and more manageable.

3. Integration with Nuvo Platform:

   • Fully integrated with the Nuvo platform, providing a range of login methods backed by industry-leading MPC wallet technology.

4. Marketplace with Derivative Support:

   • An upcoming marketplace feature will allow easy operation and support for derivatives, broadening the platform’s capabilities.

5. Snapshot Features for Token Balances:

   • Periodic on-chain snapshots of token balances are taken, ensuring permanence and reliability of data without the worry of data purges.

These features make the NuvoSphere Inscription Platform a comprehensive, secure, and user-friendly environment for blockchain interactions.

Frontend Usage

The NuvoSphere Inscription Platform's frontend is designed for ease of use and accessibility, enabling users to interact with the blockchain efficiently.

Interface Overview

• User-Friendly Design: A clear and intuitive interface for all user interactions.

• Functionality Access: Easy access to key features like token deployment, minting, and transferring.

Navigating the Frontend

• Detailed instructions on navigating the interface, accessing different functionalities, and performing key operations.

User Guide

• Step-by-Step Instructions: Walkthroughs for common tasks such as connecting a wallet, deploying a token, minting, and transferring tokens.

• Feedback and Notifications: Information on how the interface provides transaction feedback and status updates.

Jan 19: Due to an error in the smart contract, we need to override the contract address of NUVOGENESIS by replacing "0x6c38B96C3417D46431906744B0D2D605dEA30fd3" with "0x213675a2BdF53F910972E43166165a08f1AD4489" when indexing block 11097263

Coming soon ......

Get Transaction History of a Token

Path

• GET /transactions/:ticker/:txhash

Description

• Retrieves the full transaction history for a given ticker and transaction hash.

Parameters

• ticker: The ticker symbol of the token (path parameter).

• txhash: The hash of the transaction (path parameter).

Request Example

Response Example

Error Responses

• 404 Not Found: If no transaction history is found for the given ticker and transaction hash.

• 500 Internal Server Error: For server-related issues.

1. Search token name via search bar or through the list

2. Click the selected token

3. (On the right hand side) enter the amount you wish to mint. It can not be more than the amount limit per mint

4. Make sure the recipient address is accurate

5. Click Mint token. You will need to have sufficient Metis token as gas fee to proceed

1. The following dialog will display in order to proceed, click "Accept"

Check ID Availability

Path

• GET /:ticker/checkid

Description

• Determines if a specific ID is available for minting under the given ticker.

Parameters

• ticker: The ticker symbol of the token (path parameter).

• id: The ID to check for availability (query parameter).

Request Example

Response Example

Error Responses

• 400 Bad Request: If the ID is invalid or not provided.

• 404 Not Found: If the specified ticker does not exist.

• 500 Internal Server Error: For server-related issues.

Endpoint Details: Get Next ID for Minting

Path

• GET /:ticker/nextid

Description

• Retrieves the next available ID for minting a new inscription for the specified ticker.

Parameters

• ticker: The ticker symbol of the token (path parameter).

Request Example

Response Example

Error Responses

• 404 Not Found: If the specified ticker does not exist.

• 500 Internal Server Error: For server-related issues.

1. When signed in, click wallet address

2. Click “My account”

3. You may now view your total asset, NuvoBadge status, RP, rebate, and more.

Get Status of an Transaction

Path

Step-by-Step Instructions for Frontend Usage

Connecting a Wallet

1. Access Wallet Connection: Click on the 'Connect Wallet' button.

2. Select Wallet: Choose your wallet from the list provided by the Web3Modal.

3. Authorize Access: Confirm the connection in your wallet.

Deploying a Token

1. Navigate to Deploy Tab: Select the 'Deploy' tab in the interface.

2. Enter Details: Fill in the token ticker, max amount, and mint limit.

3. Deploy: Click the 'Deploy Token' button and confirm the transaction in your wallet.

Minting Tokens

1. Select Mint Tab: Go to the 'Mint' tab.

2. Input Details: Provide the ticker, amount, and recipient address.

3. Mint Token: Click 'Mint Token' and confirm the transaction.

Transferring Tokens

1. Access Owned Tokens: Switch to the 'Owned Tokens' tab.

2. Initiate Transfer: For the chosen token, enter the recipient's address.

3. Confirm Transfer: Click the 'Transfer' button and approve the transaction in your wallet.

Feedback and Notifications

Real-Time Transaction Feedback

• Progress Indicators: When a transaction is initiated (deploy, mint, transfer), the interface displays a progress indicator.

• Confirmation Messages: Upon successful completion of a transaction, a confirmation message is displayed.

Error Handling and Alerts

• Error Notifications: The interface provides clear error messages for failed transactions or issues.

• Guidance: Suggestions for corrective actions in case of errors are provided.

Status Updates

• Transaction Status: Updates on transaction status (pending, confirmed, failed) are displayed.

• Wallet Connectivity: Notifications regarding wallet connection status are shown.

Coming soon ......

1. Click "Connect Wallet"

1. Select Connect Wallet through Nuvo or Metamask

   (You are recommended to connect via Nuvo as your referral and transaction activities will be tracked through your Nuvo account, and you may be eligible for fee rebates and other benefits)

1. （Through Nuvo）Choose to login either through email, google account and more

1. （Through Metamask）Enter credential of your Metamask plugin and approve metamask permissions to login through Metamask.

Get Mint Amount

Path

• GET /mint-amount/:ticker/:txhash

Description

• Retrieves the amount of a token minted in a specific transaction for the given ticker.

Parameters

• ticker: The ticker symbol of the token (path parameter).

• txhash: The hash of the minting transaction (path parameter).

Request Example

Response Example

Error Responses

• 404 Not Found: If the ticker or transaction hash does not exist.

• 500 Internal Server Error: For server-related issues.

Get Balance of an Inscription for an Address

Path

• GET /:address/:ticker/balanceb

Description

• Return the balance of an inscriptoion for an address.

Parameters

• address: The wallet address of the user (path parameter).

• ticker: Ticker symbol (path parameter).

Request Example

Response Example

Get Deployment Details

Path

• GET /deployment/:ticker

Description

• Retrieves deployment details for a given ticker, such as contract address and deployment parameters.

Parameters

• ticker: The ticker symbol of the token (path parameter).

Request Example

Response Example

Error Responses

• 404 Not Found: If the ticker has not been deployed.

• 500 Internal Server Error: For server-related issues.

Construct Deployment Message

Path

• GET /message/deploy/:ticker

Description

• Generates a deployment message for a given ticker.

Parameters

• ticker: Ticker symbol of the token (path parameter).

Request Example

Response Example

Transaction Existence Verification

Path

Get Delegation amount information

Path

API Documentation

The REST API of the NuvoSphere Inscription Platform provides programmatic access to blockchain operations. This section documents each endpoint, detailing request formats, responses, and examples.

Overview

List All Minted Inscriptions

Path

Indexer Logic

The Indexer in the NuvoSphere Inscription Platform is a sophisticated component designed to interact with EVM-compatible blockchains, processing direct operations and contract-emitted events.

Functionality

Path

• GET /token/gettokens

Inscription Existence Verification

Path

API Overview

Base URL

Get Token Owner

Path

• GET /owner/:ticker/:txhash

Description

• Determines the current owner of a specific token, identified by its ticker and transaction hash.

Parameters

• ticker: The ticker symbol of the token (path parameter).

• txhash: The hash of the transaction to trace ownership (path parameter).

Request Example

Response Example

Error Responses

• 404 Not Found: If the ticker or transaction hash does not correspond to an existing token.

• 500 Internal Server Error: For server-related issues.

List Owned Tokens

Path

• GET /tokens/ownedBy

Description

• Retrieves a list of tokens owned by a specified wallet address.

Parameters

• address: The wallet address of the user (query parameter).

Request Example

Response Example

Error Responses

• 400 Bad Request: If the wallet address is not provided or invalid.

• 500 Internal Server Error: For server-related issues.

Construct Transfer Message

Path

• GET /message/transfer/:ticker/:id

Description

• Generates a transfer message for a given ticker and ID.

Parameters

• ticker: Ticker symbol (path parameter).

• id: Token ID (path parameter).

Request Example

Response Example

Protocol-Level Operations

Understanding protocol-level operations is key for interacting with the blockchain. This section explains how deploy, mint, and transfer messages function, including where they are sent.

GENESIS BLOCK: 11097263

General Rule:

All operations, whether they are part of the tx.data or as emitted contract events, are processed based on the order of the blocknumber and tx_index within the block in a deterministic manner. Future operations will not ever change the outcome of the past events.

Sending Messages

• Messages are sent as transaction data to the blockchain.

• Any data that conforms with the open dataURL format are recognized as an inscription. For example: 'data:,{"p":"nip-20", "op":"deploy", "tick":"<TICKER>" '

• However, the validity of the message are determined according to the following rules

Deploy Operation

• Message: {"p":"nip-20", "op":"deploy", "tick":"<TICKER>", "max":<MAXAMOUNT>, "lim":<MINT_LIMIT>, "contract":<optional:ADDRESS>, "cmint":<optional:bool>}

• Recipient: Can be sent to any address.

• Validation:

Mint Operation

• Message: {"p":"nip-20", "op":"mint", "tick":"<TICKER>", "id":"<ID>", "amt":"<AMOUNT>"}

• Recipient: The address receiving the newly minted token.

• Validation:

Transfer Operation

• Message: {"p":"nip-20", "op":"tsf", "tick":"<TICKER>", "id":"<ID>"}

• Recipient: The new owner of the token.

• Validation:

The following operations will be enabled in the future update:

Split Operation - split one inscribed token into two smaller amounts

• Message: {"p":"nip-20", "op":"split", "tick":<TICKER>, "id":<ID>, "amt1":<AMOUNT1>, "amt2":<AMOUNT2> }

• Recipient: The owner of the two splited inscriptions.

• Validation: Confirms TICKER and ID, the tx.hash where the inscription happened,existence, checks sender's ownership. Amount1 + Amount2 should equal to the original minted mount of this ID. two new inscriptions will be minted as a result. the original inscription will be burned.

Burn Operation - destroy an inscription

• Message: {"p":"nip-20", "op":"list", "tick":"<TICKER>", "id":"<ID>"}

• Recipient: must be the owner itself

• Validation:

List Operation - list the inscription for a price

• Message: {"p":"nip-20", "op":"list", "tick":"<TICKER>", "id":"<ID>", "price":<number>, "unit":<UNIT>}

• Recipient: must be the owner itself

• Validation:

UnList Operation - unlist the inscription for a price

• Message: {"p":"nip-20", "op":"ulist", "tick":"<TICKER>", "id":"<ID>"}

• Recipient: must be the owner itself

• Validation:

Exchange Operation - exchange for the inscription by paying a price

• Message: {"p":"nip-20", "op":"ex", "tick":"<TICKER>", "id":"<ID>"}

• Recipient: must be the owner of the listed inscription.

• Validation:

Contract Events:

'NIP20TokenEvent_transfer(address,address,bytes32,bytes32)' - transfer from sender to recipient with ticker and id

'NIP20TokenEvent_mint(address,address,bytes32,uint256,uint256)' - mint from sender to recipient of ticker with mint id and amount. Note: require contract address set in the deployment of the token. events emitted from other contracts are ignored.

'NIP20TokenEvent_bridgeIn(address,address,address,bytes32,uint256,uint256)' - bridge erc20 in to mint a inscription

'NIP20TokenEvent_bridgeOut(address,address,address,bytes32,uint256,uint256)' - bridge inscription out for an erc20 token

Ownership Determination

• Ownership of a token is tracked from minting. Transfer operations update ownership, with the latest valid transfer indicating the current owner.