Publish Information About an Asset
Last updated
Was this helpful?
Last updated
Was this helpful?
When you issue an asset, it’s crucial to provide clear information about it represents. On Bantu, you do that by linking your issuing account to a home domain, publishing a bantu.toml
file on that domain, and making sure that file is complete.
The most successful asset issuers give exchanges, wallets, and potential buyers lots of information about themselves in order to establish trust. More information in your bantu.toml
will mean:
Your asset gets more exposure, and is listed on more exchanges
Your asset holders are more confident in you and the assets you issue.
Your project will most likely be more successful!
The Bantu ticker, which is the source of market data for sites like CoinMarketCap, only includes assets with valid bantu.toml
files. Trading interfaces use bantu.toml
files to populate their listings, and to decide if and how to present assets to their users. Any and all ecosystem integrations that allow for interoperability — from buds to in-app deposit and withdrawal — rely on information in your bantu.toml
detailing your Bantu setup.
Completing your bantu.toml
is not a step you can skip.
The bantu.toml
file is a common place where the Internet can find information about your organization’s Bantu integration. You write it in TOML, a simple and widely used configuration file format designed to be readable by both humans and machines, and publish it at https://YOUR_DOMAIN/.well-known/bantu.toml
.
That way, everyone knows where to find it, anyone can look it up, and it proves that the owner of the HTTPS domain hosting the bantu.toml claims responsibility for the accounts and assets listed in it.
Using a operation, you can link your Bantu account to the domain that hosts your bantu.toml
, thereby creating a definitive on-chain connection between this information and that account.
Bantu Ecosystem Proposals are open protocols for building on top of Bantu, and the very first SEP, aptly named , specifies everything you could ever want to include in a bantu.toml
file. This guide, which is targeted toward asset issuers, won’t cover the Validator Information
section (that’s covered in the ), and may omit some details relevant to your use case.
The goal here is to walk through the sections of that directly relate to asset issuers, so you should use this guide in conjunction with that SEP to make sure you complete your bantu.toml
correctly. The four sections we’ll cover:
General Information
Organization Documentation
Point of Contact Documentation
Currency Documentation
For each of those sections, we’ll let you know which fields are required, meaning all asset issuers must include them to be listed by exchanges and wallets, and which fields are suggested. Completing suggested fields is a good way to make your asset stand out.
There is one field in the General Information section required for all token issuers:
ACCOUNTS
: A list of public keys for all the Bantu accounts associated with your asset.
Basic information about your organization goes into a TOML table called [DOCUMENTATION]
. Organization Documentation is your chance to inform exchanges and buyers about your business, and to demonstrate that your business is legitimate and trustworthy.
ORG_NAME
The legal name of your organization, and if your business has one, its official ORG_DBA
.
ORG_URL
The HTTPS URL of your organization's official website. In order to prove the website is yours, you must host your bantu.toml on the same domain you list here. That way, exchanges and buyers can view the SSL certificate on your website, and feel reasonably confident that you are who you say you are.
ORG_LOGO
A URL to a company logo, which will show up next to your organization on exchanges. This image should be a square aspect ratio transparent PNG, ideally of size 128x128. If you fail to provide a logo, the icon next to your organization will appear blank on many exchanges.
ORG_PHYSICAL_ADDRESS
The physical address of your organization. We understand you might want to keep your work address private. At the very least, you should put the city and country in which you operate. A street address is ideal and provides a higher level of trust and transparency to your potential asset holders.
ORG_OFFICIAL_EMAIL
The best contact email address for you organization. This should be hosted at the same domain as your official website.
ORG_GITHUB
Your organization's official Github account.
ORG_KEYBASE
Your organization's official Keybase account. Your Keybase account should contain proof of ownership of any public online accounts you list here, including your organization's domain.
ORG_TWITTER
Your organization's official Twitter handle.
ORG_DESCRIPTION
A description of your organization. This is fairly open-ended, and you can write as much as you want. It's a great place to distinguish yourself by describing what it is that you do.
Issuers that list verified information including phone/address attestations and Keybase verifications are prioritized by Bantu clients.
name
The name of the primary contact.
email
The primary contact's official email address. This should be hosted at the same domain as your organization's official website.
github
The personal Github account of the point of contact.
twitter
The personal Twitter handle of the point of contact.
keybase
The personal Keybase account for the point of contact. This account should contain proof of ownership of any public online accounts listed here and may contain proof of ownership of your organization's domain.
code
The asset code. This is one of two key pieces of information that identify your token. Without it, your token cannot be listed anywhere.
issuer
The Bantu public key of the issuing account. This is the second key piece of information that identifies your token. Without it, your token cannot be listed anywhere.
is_asset_anchored
An indication of whether your token is anchored or native: true
if your token can be redeemed for an asset outside the Bantu network, false
if it can’t. Exchanges use this information to sort tokens by type in listings. If you fail to provide it, your token is unlikely to show up in filtered market views.
If you're issuing anchored (tethered, stablecoin, asset-backed) tokens, there are several additional required fields:
anchor_asset_type
The type of asset your token represents. The possible categories are fiat
, crypto
, stock
, bond
, commodity
, realestate
, and other
.
anchor_asset
The name of the asset that serves as the anchor for your token.
redemption_instructions
Instructions to redeem your token for the underlying asset.
desc
A description of your token and what it represents. This is a good place to clarify what your token does, and why someone might want to own it.
conditions
Any conditions you place on the redemption of your token.
image
A URL to a PNG or GIF image with a transparent background representing your token. Without it, your token will appear blank on many exchanges.
After you've followed the steps above to complete your bantu.toml, post it at the following location:
https://YOUR_DOMAIN/.well-known/bantu.toml
Access-Control-Allow-Origin: *
Set a text/plain
content type so that browsers render the contents, rather than prompting for a download. ‘content-type: text/plain’
You should also use the set_options
operation to set the home domain on your issueing account.
Note: it's a good idea to keep the sections in the order presented in [SEP-1](, which is also the order they're presented here. TOML requires arrays to be at the end, so if you move scramble the order, you may cause errors for TOML parsers
Listing your public keys lets users confirm that you, in fact, own them. For example, when hosts a bantu.toml file, users can be sure that only the accounts listed on it belong to Google. If someone then says, "You need to pay your Google bill this month, send payment to address GIAMGOOGLEIPROMISE", but that key is not listed on Google's bantu.toml, then users know to not trust it.
In addition, there are several fields where you list information about your Bantu integration to aid in discoverability. If you are an anchor service, and you have to interoperate with wallets and allow for in-app deposit and withdrawal of assets, make sure to include the locations of your servers on your bantu.toml file so those wallets know where to find relevant endpoints to query. In particular, list your:
TRANSFER_SERVER_SEP0024
, which is where wallets find endpoints to initiate interactive deposit and withdrawal based on the spec
WEB_AUTH_ENDPOINT
, which is where wallets initiate user authentication sessions based on the spec
If you support other Bantu Ecosystem Proposals — such as buds or delegated signing — or host a public Expansion instance that other people can use to query the ledger, you should also add the location of those resources to so they're discoverable.
Information about the primary point(s) of contact for your organization goes into a TOML called [[PRINCIPALS]]
. You need to put contact information for at least one person at your organization. If you don't, exchanges can't verify your offering, and it is unlikely that buyers will be interested. Multiple principals can be added with additional [[PRINCIPALS]]
entries.
Information about the asset(s) you issue goes into a TOML called [[CURRENCIES]]
. If you issue multiple assets, you can include them all in one bantu.toml. Each asset should have its own [[CURRENCIES]]
entry.
Enable so people can access this file from other sites, and set the following header for an HTTP response for a /.well-known/bantu.toml
file request.