You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 23, 2023. It is now read-only.
When you issue an asset, it’s crucial to provide clear information about what it represents. On Stellar, you do that by linking your issuing account to a home domain, publishing a `stellar.toml`file on that domain, and making sure that file is complete and accurate.
9
+
When you issue an asset, it’s crucial to provide clear information about what it represents. On Stellar, you do that by linking your issuing account to a home domain, publishing a [Stellar info file](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0001.md) on that domain, and making sure that file is complete and accurate.
10
10
11
-
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 `stellar.toml` will mean:
11
+
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 Stellar Info File will mean:
12
12
13
13
- Your asset gets _more_ exposure, and is listed on _more_ exchanges.
14
14
- Your asset holders are _more_ confident in you and the assets you issue.
15
15
- Your project will most likely be _more_ successful!
16
16
17
-
The Stellar ticker, which is the source of market data for sites like CoinMarketCap, only includes assets with valid `stellar.toml`files. Trading interfaces like StellarX, Stellarport, and StellarTerm and wallets like Lobstr and Solar use `stellar.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 federation to in-app deposit and withdrawal — rely on information in your `stellar.toml` detailing your Stellar setup.
17
+
The Stellar ticker, which is the source of market data for sites like CoinMarketCap, only includes assets with valid Stellar info files. Trading interfaces like StellarX, Stellarport, and StellarTerm and wallets like Lobstr and Solar use Stellar info 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 federation to in-app deposit and withdrawal — rely on information in your Stellar info detailing your Stellar setup.
18
18
19
-
Completing your `stellar.toml` is not a step you can skip.
19
+
Completing your Stellar info file is not a step you can skip.
20
20
21
-
## What is a stellar.toml?
21
+
## What is a Stellar info file?
22
22
23
-
The `stellar.toml` file is a common place where the Internet can find information about your organization’s Stellar 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/stellar.toml`.
23
+
The Stellar info file is a common place where the Internet can find information about your organization’s Stellar 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/stellar.toml`.
24
24
25
25
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 stellar.toml claims _responsibility_ for the accounts and assets listed in it.
26
26
27
-
Using a [`set_options`](../start/list-of-operations.mdx#set-options) operation, you can link your Stellar account to the domain that hosts your `stellar.toml`, thereby creating a definitive on-chain connection between this information and that account.
27
+
Using a [`set_options`](../start/list-of-operations.mdx#set-options) operation, you can link your Stellar account to the domain that hosts your Stellar info file, thereby creating a definitive on-chain connection between this information and that account.
28
28
29
29
## How to complete your stellar.toml
30
30
31
-
Stellar Ecosystem Proposals are open protocols for building on top of Stellar, and the very first SEP, aptly named [SEP-1](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0001.md), specifies everything you could ever want to include in a `stellar.toml` file. This guide, which is targeted toward asset issuers, won’t cover the `Validator Information` section (that’s covered in the [Run a Core Node section](../run-core-node/index.mdx)), and may omit some details relevant to your use case.
31
+
Stellar Ecosystem Proposals are open protocols for building on top of Stellar, and the very first SEP, aptly named [SEP-1: Stellar Info File](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0001.md), specifies everything you could ever want to include in a Stellar info file. This guide, which is targeted toward asset issuers, won’t cover the `Validator Information` section (that’s covered in the [Run a Core Node section](../run-core-node/index.mdx)), and may omit some details relevant to your use case.
32
32
33
-
The goal here is to walk through the sections of [SEP-1](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0001.md) that directly relate to asset issuers, so you should use this guide in conjunction with that SEP to make sure you complete your `stellar.toml` correctly. The four sections we’ll cover:
33
+
The goal here is to walk through the sections of [SEP-1: Stellar Info File](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0001.md) that directly relate to asset issuers, so you should use this guide in conjunction with that SEP to make sure you complete your `stellar.toml` correctly. The four sections we’ll cover:
34
34
35
35
- General Information
36
36
- Organization Documentation
@@ -41,7 +41,7 @@ For each of those sections, we’ll let you know which fields are **required**,
41
41
42
42
<Alert>
43
43
44
-
Note: it's a good idea to keep the sections in the order presented in [SEP-1](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0001.md), which is also the order they're presented here. TOML requires arrays to be at the end, so if you scramble the order, you may cause errors for TOML parsers.
44
+
Note: it's a good idea to keep the sections in the order presented in [SEP-1: Stellar Info File](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0001.md), which is also the order they're presented here. TOML requires arrays to be at the end, so if you scramble the order, you may cause errors for TOML parsers.
45
45
46
46
</Alert>
47
47
@@ -55,8 +55,11 @@ Listing your public keys lets users confirm that you, in fact, own them. For exa
55
55
56
56
In addition, there are several fields where you list information about your Stellar integration to aid in discoverability. If you are an anchor service, and you have [set up infrastructure](../anchoring-assets/enabling-deposit-and-withdrawal/index.mdx) 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 stellar.toml file so those wallets know where to find relevant endpoints to query. In particular, list your:
57
57
58
-
-`TRANSFER_SERVER_SEP0024`, which is where wallets find endpoints to initiate interactive deposit and withdrawal based on the [SEP-24](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md) spec
59
-
-`WEB_AUTH_ENDPOINT`, which is where wallets initiate user authentication sessions based on the [SEP-10](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md) spec
58
+
-`TRANSFER_SERVER` if you support [SEP-6: Deposit and Withdrawal API](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0006.md)
59
+
-`TRANSFER_SERVER_SEP0024`if you support [SEP-24: Interactive Deposit and Withdrawal](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0024.md)
60
+
-`KYC_SERVER` if you support [SEP-12: KYC API](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0012.md)
61
+
-`WEB_AUTH_ENDPOINT` if you support [SEP-10: Stellar Web Authentication](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0010.md)
62
+
-`DIRECT_PAYMENT_SERVER` if you support [SEP-31: Cross-Border Payments API](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0031.md)
60
63
61
64
If you support other Stellar Ecosystem Proposals — such as federation or delegated signing — or host a public Horizon instance that other people can use to query the ledger, you should also add the location of those resources to [General Information](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0001.md#general-information) so they're discoverable.
62
65
@@ -70,7 +73,8 @@ Basic information about your organization goes into a TOML **table** called `[DO
70
73
-`ORG_URL` The HTTPS URL of your organization's official website. In order to prove the website is yours, _you must host your stellar.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.
71
74
-`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.
72
75
-`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.
73
-
-`ORG_OFFICIAL_EMAIL` The best contact email address for your organization. This should be hosted at the same domain as your official website.
76
+
-`ORG_OFFICIAL_EMAIL` The best business email address for your organization. This should be hosted at the same domain as your official website.
77
+
-`ORG_SUPPORT_EMAIL` The best email for support requests.
74
78
75
79
#### Suggested
76
80
@@ -113,16 +117,17 @@ If you're issuing anchored (tethered, stablecoin, asset-backed) tokens, there ar
113
117
-`anchor_asset_type` The type of asset your token represents. The possible categories are `fiat`, `crypto`, `stock`, `bond`, `commodity`, `realestate`, and `other`.
114
118
-`anchor_asset` The name of the asset that serves as the anchor for your token.
115
119
-`redemption_instructions` Instructions to redeem your token for the underlying asset.
120
+
-`attestation_of_reserve` A URL to attestation or other proof, evidence, or verification of reserves, such as third-party audits, which all issuers of stablecoins should offer to adhere to best practices.
116
121
117
122
#### Suggested
118
123
119
124
-`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.
120
125
-`conditions` Any conditions you place on the redemption of your token.
121
126
-`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.
122
127
123
-
## How to publish your stellar.toml
128
+
## How to publish your Stellar info file
124
129
125
-
After you've followed the steps above to complete your stellar.toml, post it at the following location:
130
+
After you've followed the steps above to complete your Stellar info file, post it at the following location:
0 commit comments