Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
HeesungB committed Aug 3, 2023
1 parent 092dcbc commit c45a01d
Showing 1 changed file with 49 additions and 5 deletions.
54 changes: 49 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,53 @@
# Smart contract registry
# Guidelines for Submitting CW20 token to Keplr Extension

Index of existing and deployed smart contract for tracking existing code and promotong reusability
This page outlines the basic information that is required for registering CW20 token to Keplr Extension add token list. Keplr team will go through a minimal verification process to see if there is any security issues or missing information.

Inspired by [Chain Registry](https://github.com/chainapsis/keplr-chain-registry)
Once approved, Keplr Extension will show CW20 token in token add page, with the information you've submitted.

See the examples for information on the schema in order to contribute.
## App Registration Directory Structure
Here’s an overview of the structure of the directory. Please provide the information and files complying with the requirements.
```
.
├── cosmos
│ ├── juno # Chain Identifier Name
│ │ ├── base.json # Information about chain
│ │ └── tokens
│ │ ├── juno10gthz...8q4864xy.json # CW20 token's contract address
│ │ └── juno10vgf2...mqaw95ux.json
│ ├── secret
│ └── ...
├── images
│ ├── juno
│ │ ├── bjuno.png # CW20 token's symbol
│ │ └── pepe.png
│ ├── secret
│ └── ...
└── ...
```

#### Guidelines, testing scripts, automatic checks and UI are coming later
## CW20 Token Information JSON File Form (Example)
Please note that you need to comply with our requirements when filling out the form. See the next section to learn the details.
```json
{
"contractAddress": "juno1epxnvge53c4hkcmqzlxryw5fp7eae2utyk6ehjcfpwajwp48km3sgxsh9k",
"imageUrl": "https://raw.githubusercontent.com/chainapsis/keplr-contract-registry/main/images/juno/pepec.png",
"metadata": {
"name": "PEPE on Cosmos",
"symbol": "PEPE",
"decimals": 6
}
}

```

### CW20 Token Information Details
- `contractAddress`: Enter the contract address of the CW20 token you want to add.
- `imageUrl`: Enter the link of the image you added.
- `metadata`
- `name`: Name of the registered CW token.
- `name`: Symbol of the registered CW token.
- `name`: Decimals of the registered CW token.

## NOTE:
- Please double-check if the app information file is in JSON format.
- Please also note that the images will be automatically cropped into a circle to be displayed on Keplr.

0 comments on commit c45a01d

Please sign in to comment.