Getting Started

1. Request Vessel Account Setup

Ask your account manager to grant you access to Vessel in the AppLovin dashboard.

2. Create an Ethereum Studio Wallet

Use Metamask or another ERC-20 wallet company to create an Ethereum-based wallet. Once you have created your wallet, let your Vessel account manager know the wallet address. Your wallet will be connected to the account and used to make API calls and receive royalties from transactions.

3. Create a New Game

Once you have access to Vessel, login into the Staging Dashboard and click ADD GAME to begin adding your game to Vessel.

Here's a breakdown of the required information on the Create New Game form:

4. Create a New Token Collection Template

Click the name of your newly created game, then click + ADD COLLECTION TEMPLATE in the COLLECTION TEMPLATES tab to begin the process of creating a new token collection template:

The following table explains the fields you need to enter on the Create collection template form:

5. Deploy a Token Collection

Deploy your newly created token collection template to the blockchain by clicking DEPLOY.

You can see your newly deployed collection in the DEPLOYED COLLECTIONS tab. It may take a few seconds after you click DEPLOY before the collection appears in this tab.

You can also create and deploy a token collection by making an API POST request:

POST /collections/manage/{fqGn}/create HTTP/1.1
Host: game-api.openvessel.io
Content-Type: application/json
Accept: */*
Content-Length: 118

{
  "displayName": "New year cards",
  "description": "Super game new year cards",
  "imageUrl": "Collection image",
  "qCn": "cards"
}

{
  "response": {
    "txHash": "text",
    "description": "text",
    "details": {}
  }
}

6. Create a New Token Template

A token template governs how to mint tokens for the users of your game. To begin the process of creating a new token template, you need to do the following: 1. Click the FQCN (Fully Qualified Collection Name) of the newly created collection in the DEPLOYED COLLECTIONS list.

2. Once you're in the Deployed Collections section, click on CREATE TOKEN TEMPLATE.

Here's a breakdown of the required information on the Create Token Template form:

7. Deploy Your Token Template

To deploy your newly created token template to the blockchain, first click DEPLOY under Actions. Then, in the Deploy tokens pop-up that appears, enter an amount, and then finalize your amount by clicking DEPLOY.

You can see your deployed token template in the DEPLOYED TOKENS tab. It may take a few seconds after you click DEPLOY before your template appears in this tab.

You can also create and deploy a token template by making an API POST request:

POST /tokens/manage/create HTTP/1.1
Host: game-api.openvessel.io
Content-Type: application/json
Accept: */*
Content-Length: 412

{
  "fqTn": "com.studio.game.cards.1",
  "displayName": "Card #1",
  "description": "Card #1 increases your luck",
  "properties": {
    "ANY_ADDITIONAL_PROPERTY": {
      "displayName": "text",
      "value": "text",
      "propertyOrder": 1
    }
  },
  "mutableProperties": {
    "ANY_ADDITIONAL_PROPERTY": {
      "displayName": "text",
      "value": "text",
      "propertyOrder": 1
    }
  },
  "amount": 1,
  "to": "0xcafe000102030405060708090a0b0c0d0e0fbeef",
  "displayInDiscovery": true,
  "imageUrl": "jpg, png"
}

{
  "response": {
    "txHash": "text",
    "description": "text",
    "details": {}
  }
}

8. Mint a Token for a User

Make a POST request to the Mint API to mint a new token into any wallet on the Vessel blockchain:

POST /tokens/manage/{fqTn}/mint HTTP/1.1
Host: game-api.openvessel.io
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "to": "0xcafe000102030405060708090a0b0c0d0e0fbeef",
  "amount": 1
}

{
  "response": {
    "txHash": "text",
    "description": "text",
    "details": {}
  }
}

Here’s a sample request:

curl -X "POST" "https://game-api.openvessel.io/tokens/manage/com.teststudio.gamename.ratefinds.raresword/mint" \
     -H 'Content-Type: application/json' \
     -H 'X-Auth-Key: <YOUR WALLET PRIVATE KEY>' \
     -d $'{
  "to": "<TARGET USER WALLET ADDRESS>",
  "amount": 1
}'

You can also clone a token (create a new token based on an existing one) by making a POST request to the Clone API:

POST /tokens/manage/{fqTn}/clone HTTP/1.1
Host: game-api.openvessel.io
Content-Type: application/json
Accept: */*
Content-Length: 211

{
  "to": "0xcafe000102030405060708090a0b0c0d0e0fbeef",
  "mutableProperties": {
    "ANY_ADDITIONAL_PROPERTY": {
      "displayName": "text",
      "value": "text",
      "propertyOrder": 1
    }
  },
  "cloneMutableProperties": true,
  "displayInDiscovery": true
}

{
  "response": {
    "txHash": "text",
    "description": "text",
    "details": {
      "fqTn": "text"
    }
  }
}

9. Query a User’s Tokens

Make a GET request to the User Token List API to query all tokens that belong to a user:

GET /user/{address}/tokens/{fqGn}/ HTTP/1.1
Host: game-api.openvessel.io
Accept: */*

{
  "response": [
    {
      "fqTn": "text",
      "totalSupply": 1,
      "amount": 1
    }
  ]
}

GET /user/{address}/tokens/{fqGn}/{qCn}/ HTTP/1.1
Host: game-api.openvessel.io
Accept: */*

{
  "response": [
    {
      "fqTn": "text",
      "totalSupply": 1,
      "amount": 1
    }
  ]
}

Here’s a sample request:

curl "https://game-api.openvessel.io/user/<TARGET USER WALLET ADDRESS>/tokens/com.teststudio.gamename/" \
     -H 'Content-Type: application/json'

10. Integrate the SDK to Connect Your Game

Follow the SDK Integration guide to connect your game to your Vessel Wallet and to retrieve wallet addresses for your users:

Vessel also has a demo Unity project which you can check out.