TrueFi Registry

The TrueFi registry contains public metadata for TrueFi users and participants.

The TrueFi platform utilizes assets from this repository to display detailed information associated with specific entities.

How to add profile data

Profile metadata will be read from a json file corresponding to an entity's active wallet address.

Create a new directory under the correct network profiles/mainnet or profiles/ropsten.

The directory name should be the entity's wallet address used to participate on TrueFi and should contain the entity's profile data in a file titled profile.json with an optional logo file logo.svg.

Profile data should follow the following structure:

{
  "name": "TrueFi Borrower",
  "address": "0x0",
  "website": "https://truefi.io",
  "description": "Freeing money to create more value",
  "logoURI": "https://raw.githubusercontent.com/trusttoken/truefi-registry/main/truefi.svg",
  "explorer": "https://etherscan.io",
  "status": "active",
  "github": "https://github.com",
  "socials": {
    "twitter" : {
      "url": "https://twitter.com",
      "handle": "twUser"
    },
    "medium": {
      "url": "https://medium.com",
      "handle": "medUser"
    },
    "discord": {
      "url": "https://discord.com",
      "handle": "dcUser"
    },
    "telegram": {
      "url": "https://telegram.org/",
      "handle": "tgUser"
    },
    "linkedin": {
      "url": "https://www.linkedin.com/",
      "handle": "lnUser"
    },
    "youtube": {
      "url": "https://youtube.com",
      "handle": "ytUser"
    }
  }
}

Of these fields name and address are required.

If an optional field is not to be included leave it blank with an empty string "".

For social links, all supported platforms are listed above. Each platform is optional, if any are not to be included simply delete them from the list - if no social platforms are to be included enter an empty object for the socials field {}

Adding profiles to the index

Once the profile data has been completed, the entity's address will need to be added to the index.

For mainnet addresses append the address and entity name to profiles/mainnet/index.json the key should be the address and name the value ex.

{
  ...
  "0x83C1B27276108c0F68c52c2319beEd4646061A1F": "TrustToken Test",
  "0x0n3WAddR3ss00000000000000000000000000000": "New Entity"
}