StellarTerm maintains a manually curated directory file with a listing of well known anchors and assets on the Stellar network. StellarTerm currently does not fetch stellar.toml files to discover assets as a way to prevent phishing. The creators of this file does not endorse any of this information contained in the directory. There may be mistakes in this directory (and historically there have been).
Anchors and assets will only be added to the directory if they seem potentially legitimate (StellarTerm does not endorse any of these assets).
Please gather the 3 things needed first. To list your directory, please create a GitHub issue. To expedite inclusion into the directory, please open a pull request with changes implemented.
Must have a stellar.toml correctly hosted. Information on how to do this is here: https://www.stellar.org/developers/guides/concepts/stellar-toml.html
Also, make sure to configure CORS correctly. Instructions are available in the Stellar Developer docs.
Logo should be in the format as below. Alternatively, you may create a GitHub issue with a high resolution logo and the developers of StellarTerm will adjust it (the process will be slower).
This color is used in the StellarToml asset "cards" for the border. The background of the asset "cards" are lightened.
StellarTerm displays logos of Stellar anchors to make it easier for end users to recognize them and protect themselves against phishing attacks. When a unknown issuer of invalid asset pair is used, an image indicating that the asset is unknown will be shown.
To provide a cleaner user interface, StellarTerm directory logos follow the following guidelines:
logos.json are automatically generated by the scripts
checkBuild.js ensures that the
logos/ end up building the json files that are checked into the git repository. In other words,
checkBuild.js is used to keep the source and built files in sync.
There are two ways you can use this: as a node.js module or as a simple json file.
npm install stellarterm-directory
The package follows semver. Patch versions will mean that content has changed but the structure remains the same
SECURITY NOTE: This could be potentially insecure as an attacker could change the contents either in flight or on the npm repository. A slightly more secure way is to manually get the JSON.
const directory = require('stellarterm-directory'); directory.getAnchor(domain); directory.getAssetByDomain(code, domain); directory.getAssetByAccountId(code, issuer); directory.resolveAssetByAccountId(code, issuer); directory.getAssetBySdkAsset(asset); directory.getDestination(accountId); directory.toJson(); // Should be the same output as directory.json
const DirectoryBuilder = require('stellarterm-directory').DirectoryBuilder; // See DirectoryBuilder.js for usage details directory.addAnchor(details); directory.addAsset(anchorDomain, details); directory.addDestination(accountId, opts); directory.addPair(opts);
This step is arguably safer as you can verify the data yourself. Simply download the
directory.json file from the StellarTerm GitHub repo and paste it into your application. Repeat again when updates are desired.