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.

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.

Feedback and Notifications

Real-Time Transaction Feedback

API Overview

Base URL

Get Deployment Details

Path

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 ......

In this guide we describe step-by-step guide to develop, test and deploy a Nuvo badge project. The main steps are

• Access Nuvo One test environment

• Create a new application

• Issue Nuvo Badge

• Test Nuvo Badge on testnet

• Deploy Nuvo Badge project on main net

<Note> It may take time for the process, there will be a slight delay in API queries related to NFT transactions

Coming soon ......

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

• Describes the base URL, authentication methods (if any), and general usage guidelines.

Endpoint Details

Each endpoint is documented with:

• Path: The URL path of the endpoint.

• Method: HTTP method (GET, POST, etc.).

• Parameters: Required and optional parameters.

• Request Example: Sample request format.

Sample Endpoints

• Get Next ID for Minting

  • Path: /:ticker/nextid

  • Method: GET

  • ...

Usage Examples

• Code snippets or example requests to demonstrate how to interact with each endpoint.

Error Handling

• Information on how the API communicates errors and how to interpret th

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.

Get Delegation amount information

Path

• GET /:address/:ticker/:target/delegation

Description

• Return delegation amount of a ticker from address to a target address before a maximum height.

Parameters

• address: The address to delegate from (path parameter).

• ticker: Ticker symbol (path parameter).

• target: The address to delegate to (path parameter)

• height: Maximum revoke height (Optional query parameter)

Request Example

Response Example

Error Responses

• 500 Server Error: For server-related issues.

Once all information is filled, we can now deploy Nuvo Badge project on testnet.

Get Status of an Transaction

Path

• GET /:tx_hash/status

Description

• Return the status of an inscription transaction

Parameters

• tx_hash: Transaction hash(path parameter).

Request Example

Response Example

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.

Path

• GET /holder/:ticker

Description

• Get number of holders for a ticker

Parameters

• tick: Ticker symbol (query parameter)

Request Example

Response Example

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

You can navigate to NuvoBadge Claim by the URL directly or you can find the link in NuvoMe

How to Claim the Badge

Once you have completed the requirements and are eligible to claim the badges, you can navigate to NuvoBadge Claim. If the badge is distributed by QR code, you can scan the QR code and claim the badge. Else the badge is distributed by redemption code or whitelist, you can navigate to the CLAIM page and claim the badge with your redemption code provided by the Dapp owner and wallet address directly.

We recommend reading How to issue NFT Badge and set up the campaign for more detailed description on setting up Badge campaign. For distribution method, we recommend using "mass distribution with 1 QR code", which is currently the most well-supported method.

Dapp

The Dapp developers can create an application through the Nuvo platform and get the API Key for future development. To create a New App we will need you to enter with App Name, User Support Email, choose your App Logo, Dapp URL link, Dapp Authorized Domain, Dapp Permission, and Developer information.

When your first Dapp is created then you can find the Dapp Key and Id on the Dapp Credentials. This credential is required when you are using API to call the Dapp.

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.

List All Minted Inscriptions

Path

List Owned Tokens

Path

Step-by-Step Instructions for Frontend Usage

Connecting a Wallet

Construct Mint Message

Path

How does it work?

Reputation Power (or RP) is accrued by performing actions on-chain. Each action has its own RP value set by projects, allowing projects to reward community members and Dapp users for valued achievements and milestones. For example, a DEX might value governance voting more heavily than trade executions, as an action that helps the project shape the future of its design; therefore, the project can award more RP for voting than trading on the DEX.

RP accrual is a bit like earning XP in a video game. Similar to a game, individuals can earn RP to level up and gain benefits like the ability to mint nontransferable NFT Badges on their Nuvo profile, representing milestone achievements on-chain. NFT Badges are issued by Nuvo or other Dapp on Andromeda and are tied to a user’s wallet address on the Nuvo network. Individuals will be able to build their own profiles, check out new RP features, and look up profiles for other users and DACs. Long-term community engagement is empowered, even adding a social element for communities to uniquely reward users for their engagement and contributions.

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

Get Dapp info

GET /api/v1/oauth2/applications/get_app_info

👋 Hi! Welcome to Nuvo. This guide will teach you the principle of optimizing your NFT badge design.

🪄NFT Badge Composition

The NFT badge comprises a pattern (image) and badge shell. The Dapp's / NFT badge issuer is responsible for designing the pattern (image). The badge shell's color depends on the Reputation Power(RP) you set. The design will then be combined with the badge shell to form a unique NFT badge.

Nuvo provides a ready-to-use sandbox environment for badge issuers. Simply go to one.staging.nuvosphere.io to access this sandbox enviroment. There are many ways to register or login to the environment, in this guide we use metamask as an example.

Click the Metamask icon and bring up Metamask approval page

Click "Sign" button to login to the sandbox environment.

Reputation Power Web 3.0 for Dapp Owners

There is an important discussion around Web 3.0 about the ability to manage the identity and reputation of each user that joins the platform. Reputation is very important in our physical world that helps financial processes perform without any issues. To prove the trustworthiness and reliability of the new Web platform, Dapp owners must consider reputation power when using Web 3.0 features.

One logged into the Nuvo One dashboard, we first need to create an application associated with the Nuvo Badge. To do this, click the "Application" menu item on the left menu bar, and click "Create" button (or click "Create New App" tab).

Fill in all the requried field of the application and click "save"

Dashboard

You may want to check your personal wallet detail information such as Wallet Address, Token Distribution, and Transaction Records. Here you can grab the information you need on the platform.

Once your Nuvo Badge is live on test environment, and got tested well, we will be ready to deploy it on production environment! Simply go to one.nuvosphere.io and repeat the previous process. Note to select Metis mainnet (Andromeda) instead of testnet.

Finally, this is a quick step-by-step guide to get new user of Nuvosphere start quickly. For more comprehensive documentation, please refer to for more details.

Get Token Owner

Path

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

Path

• GET /token/gettokens

Get user info

GET /api/v1/oauth2/user/userinfo

Transaction Existence Verification

Path

Nuvosphere appears to provide a suite of four different platforms to serve the needs of web2 and web3 users. Here is some more information about each platform:

NuvoOne -

This is a middleware that developers can use to build decentralized applications (dapps), smart contracts, and NFT badges. Providing a common set of services that multiple applications can use. NuvoOne provides developers with tools and services to create decentralized applications that can interact with the blockchain.

NuvoMe -

This is an end-user platform that allows users to own transaction wallets and personal profiles. This platform enables users to securely manage their digital assets, interact with dapps, and control their own data. With NuvoMe, users can also access and manage their NFT badges.

NuvoID -

This is a platform that allows end-users to mint their own web3 avatar. An avatar is a digital representation of a user in the virtual world. NuvoID enables users to create a unique and personalized avatar that can be used in different applications and platforms across the web3 ecosystem.

NuvoBadge Claim -

This platform enables end-users to claim NuvoBadge. A badge is a digital credential that represents an achievement or a skill. NuvoBadge enables users to earn and claim badges for their accomplishments, which can be used to showcase their skills and knowledge to others.

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.

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

You can navigate to NuvoPass by the URL directly or you can find the link in NuvoMe

Badge Display Wall

Navigate to NuvoID you will see the personal NuvoID information. Click EXPLORE the displaying badges are all the projects launched in Nuvo and issued with NFT badges.

Mint NuvoID

The first thing first is to mint your NuvoID in Nuvo! Smash the Mascot and navigate to the NuvoID Minting page. Give your avatar a name and pay with a few Gas Fees (Metis token), and you are all set. The avatar is minted by random so be excited about what your unique avatar will look like!

<Figure 1.2> Unique NuvoPass avatar

Ranking Board

How do you know which is the best engaging Dapp and the most popular Badges in the web3? Nuvo has provided a Ranking Board for your easy reference to browse through the whole list. There are three types of ranking categories.

1. Dapp Ranking

You will see the Top ranking Dapps with the information on how many NFT Badges have been issued, and how many users have claimed the badges.

2. User Ranking

You will see the most engaged user list with the amount of how many NFT Badges they have claimed and how many RP values they have.

3. NFT Badges Ranking

You will see the NFT Badges top ranking list according to the amount of the minted NFT. The more NFTs being minted the more users get engaged.

My NFT Badge Collection and NP

To check my personal NFT badge collection and RP value, by clicking on the NuvoID avatar you can see your current Total Reputation Power, Joined Days, Total Badges, and the list of your claimed Dapp list.

NuvoOne is a place for developers to dive in and create Domain, Dapps, smart contract, and issue the Nuvo Badge. Check out below to find out more

Dashboard

In Nuvo One Dashboard you can grab the information of all your Dapps and get an idea of the Active users, and API calls based on the different periods of time.

Domain

Domain management can let you create a unique domain and associate the domain with the smart contract deployed on multiple chains. Each chain has unique specifications, and contracts on multiple chains have different addresses. Nuvo helps to achieve the feature with Domain management.

A contract associated with a decentralized application can be deployed on multiple chains. Our job is to provide a unique identifier of the contract on any number to manage multiple domains from one central place. Nuvo helps you achieve this feature with domain management options.

• Dapp developers can create a unique domain and associate the domain with a smart contract that has been deployed on multiple domains.

• The created domain can be simply updated to point to a new contract address.

• Other smart contracts can call methods based on the created domain.

• Users can trade domains on the domain marketplace.

1. Searching Global Domain

Global domains are here to help you with APIs and you can use them on the Nuvo platform. You can use global domains to create a decentralized application using the Nuvo dashboard. Global domains are ready to use and provide quick deployment for decentralized apps. Type a keyword in the search box to access the global domain you want in no time.

2. Creating or Editing Domain

Nuvo allows you to create a new domain associated with specific smart contracts. Sign up and log in to your Nuvo account and go to the Domain management section to create a new one.

You can create a new domain by clicking on “Create New Domains” and giving the required information to manage everything in Nuvo. The domain name can be anything and you can set the chain ID and the contract address as well.

There is an option to edit each domain, delete the domain, and apply more settings if needed.

Smart Contract

Developers can use the “Smart Contract” section on the Nuvo platform to manage their smart contracts and register new ones. Here you have two options that you can use to register a new template or search for created templates.

1. Register New Templates

You need your smart contract code and some information to register a new template. Click on the “Register” icon to proceed. You can register your template in the new window by providing the template name, source code, and some other information.

Query Smart Contracts

Querying smart contracts can be done in the “Smart Contract” section. Use the “template name” box to set a name and click on the “Query” icon to proceed.

You can use the “Review Details” button to check the template’s information and customize it to deploy on a specific domain created before.

Production Env

https://api.nuvosphere.io

Staging Env

https://api.staging.nuvosphere.io

Step1 - Initiate authorization

Request for log in

description

Step2 - Receive authorized code

After initiating authorization, Nuvo will return_url and code

The developer will receive url(https://demo.dapp.com/callback), keep the code for the access token use

Step3 - Request Access Token

Request access token

GET /api/v1/oauth2/access_token

Query String: ?appid={appid}&code={code}

code: the code kept from step2

appid: app id that can be acquired from Nuvo One

Request Body

Issue Nuvo Badge

Once we have created Dapp, the next step is to deploy NFT Badges! Navigate to the Deploy NFT, enter the NFT Name, select the Dapp that you just created, start/end date, define 1-5 levels of your badges, and the last step is to upload the image of your badges.

You can find your deployed NFT badge list on the collections and feel free to adjust the information such as NFT badge name, start/end time, badge image, and also Run Promotion for all of the badges.

Set up the Campaign

Once you have created Dapp and successfully deploy NFT Badges, you can keep moving on to set up the campaign for the Badge.

There are three different distribution ways for you to choose from

1. Issue Redemption Code - By choosing this option you will be able to get a series number, you can provide the serial number to your eligible users to go and claim the badges. Figure 1.5

2. Issue Unique Link with QR Code - By choosing this option you will be able to get a QR Code, you can provide the QR Code to your eligible users to go and claim the badges. Figure 1.6

3. White List(wallet address) - By choosing this option you will be able to provide the whitelist through a txt file or manually input the address, eligible users can claim the badges accordingly. Figure 1.7

Get Eth Address with NuvoID

GET /api/v1/oauth2/user/nuvoId/<nuvoId>

Path Parameters

Headers

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.

Get Dapp list

GET /api/v1/oauth2/applications/selects

Query Parameters

Headers

Get Eth Address

GET /api/v1/oauth2/user/<name>

Path Parameters

Headers

Get balance

POST /api/v1/oauth2/balance

Headers

Request Body

Get chain URL

GET /api/v1/oauth2/chainurl

Headers

Request Body

Once we have created an application, we are now ready to issue a Nuvo Badge. Simple go to "NuvoBadge Issuer" menu item on the left navigation menu, and click "+ Issue NuvoBadge".

Now we need to fill in information related to the badge.

• DApp - this is the application that we just created which is going to be associated with the NuvoBadge project, simply select it from the drop-down box.

• Chain - In this case we'll leave the default Goerli test net chain. Note that in production deployment, we should use Metis mainnet (Andromeda).

• Badge levels - You can design a badge and RP scheme to suite your project needs. Please refer to for detailed guide.

• Badge image - upload your badge image (one for each badge level)

Verify wallet pwd

POST /api/v1/oauth2/verify_wallet_pwd

Headers

Request Body

Get latest price

GET /api/v1/cryptocurrency/quotes/<symbol>

Headers

Congratulations on joining Nuvo Power!

Our innovative solution helps brands improve user and employee retention, engagement, and loyalty through gamified rewards. Users are in control of their own data and credentials and gain reputation power through actions and contributions.

Get transfer list

GET /api/v1/oauth2/wallet/sdk/txlist

Save token transfer info

POST api/v1/oauth2/wallet/save_token_tx

Get transaction info

POST api/v1/oauth2/wallet/token_tx_info

Confirm transaction

POST /api/v1/oauth2/confirm_tx

Customer Segments

Segment #1: Web3 Users

Segment #2: Web2 Users

Segment #3: Web2 Businesses

Segment #4: Web3 Businesses

Segment #5: Developers/Partners

Construct Deployment Message

Path

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.

Get token transfer list

GET /api/v1/oauth2/wallet/tokens?chainid=1088

QueryString：?chainid=1088

Headers

Inscription Existence Verification

Path

• GET /:ticker/:id/exist

Description

• Checks if a inscription with a given hash exists for a specific ticker.

Parameters

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

• id: The hash of the transaction that minted the inscription (path parameter).

Request Example

Response Example

Error Responses

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

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

Get transfer list

GET api/v1/oauth2/wallet/token_tx_list?page_no=1&page_size=10

Deploy NFT Badge

POST /api/v1/oauth2/nft/deploy

Get Mint Amount

Path

Initiate transaction

POST /api/v1/oauth2/send_tx

Headers

Request Body

Badge collection

POST /api/v1/oauth2/user/favorite_badge

For user used wallet mint transaction