Skip to content

Commit

Permalink
docs: Update API.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@scorpiotzh
scorpiotzh committed May 8, 2023
1 parent ee15a8e commit 0aad09a
Showing 1 changed file with 6 additions and 32 deletions.
38 changes: 6 additions & 32 deletions API.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,12 @@

Please familiarize yourself with the meaning of some common parameters before reading the API list:

| param | description |
| :------------------------- | :------------------------------------------------------------------ |
| type | Filled with "blockchain" for now |
| coin\_type <sup>[1](https://github.com/satoshilabs/slips/blob/master/slip-0044.md)</sup> | 60: eth, 195: trx, 9006: bsc, 966: matic |
| chain\_id <sup>[2](https://github.com/ethereum-lists/chains)</sup> | 1: eth, 56: bsc, 137: polygon; 5: goerli, 97: bsct, 80001: mumbai |
| account | Contains the suffix `.bit` in it |
| key | Generally refers to the blockchain address for now |

_You can provide either `coin_type` or `chain_id`. The `coin_type` will be used, if you provide both_
| param | description |
| :------------------------- |:---------------------------------------------------|
| type | Filled with "blockchain" for now |
| coin\_type <sup>[1](https://github.com/satoshilabs/slips/blob/master/slip-0044.md)</sup> | 60: eth, 195: trx, 9006: bsc, 966: matic, 3: doge |
| account | Contains the suffix `.bit` in it |
| key | Generally refers to the blockchain address for now |

### Get Config Info

Expand Down Expand Up @@ -75,7 +72,6 @@ _You can provide either `coin_type` or `chain_id`. The `coin_type` will be used,
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111...",
"category": 6
}
Expand All @@ -96,15 +92,13 @@ _You can provide either `coin_type` or `chain_id`. The `coin_type` will be used,
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111..."
}
},
"manager": {
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111..."
}
},
Expand Down Expand Up @@ -145,15 +139,13 @@ _You can provide either `coin_type` or `chain_id`. The `coin_type` will be used,
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111..."
}
},
"manager": {
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111..."
}
},
Expand Down Expand Up @@ -203,7 +195,6 @@ _You can provide either `coin_type` or `chain_id`. The `coin_type` will be used,
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111..."
},
"keyword": "",
Expand Down Expand Up @@ -231,15 +222,13 @@ _You can provide either `coin_type` or `chain_id`. The `coin_type` will be used,
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111..."
}
},
"manager": {
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111..."
}
},
Expand All @@ -266,7 +255,6 @@ _You can provide either `coin_type` or `chain_id`. The `coin_type` will be used,
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111..."
},
"account": ""
Expand Down Expand Up @@ -309,7 +297,6 @@ _You can provide either `coin_type` or `chain_id`. The `coin_type` will be used,
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111..."
},
"account": "",
Expand Down Expand Up @@ -339,7 +326,6 @@ _You can provide either `coin_type` or `chain_id`. The `coin_type` will be used,
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111..."
}
}
Expand All @@ -363,7 +349,6 @@ _You can provide either `coin_type` or `chain_id`. The `coin_type` will be used,
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111..."
},
"status": 1,
Expand All @@ -386,7 +371,6 @@ _You can provide either `coin_type` or `chain_id`. The `coin_type` will be used,
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111"
},
"account": "",
Expand Down Expand Up @@ -416,7 +400,6 @@ _You can provide either `coin_type` or `chain_id`. The `coin_type` will be used,
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111..."
}
}
Expand Down Expand Up @@ -460,7 +443,6 @@ _You can provide either `coin_type` or `chain_id`. The `coin_type` will be used,
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111..."
},
"account": "",
Expand All @@ -470,15 +452,13 @@ _You can provide either `coin_type` or `chain_id`. The `coin_type` will be used,
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111..."
}
},
"manager": {
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111..."
}
},
Expand Down Expand Up @@ -564,7 +544,6 @@ _You can provide either `coin_type` or `chain_id`. The `coin_type` will be used,
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111..."
},
"action": "enable_sub_account",
Expand Down Expand Up @@ -652,7 +631,6 @@ _You can provide either `coin_type` or `chain_id`. The `coin_type` will be used,
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111..."
},
"account": "test.bit",
Expand Down Expand Up @@ -753,7 +731,6 @@ _You can provide either `coin_type` or `chain_id`. The `coin_type` will be used,
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111..."
},
"account": "tzh2022070601.bit"
Expand All @@ -779,7 +756,6 @@ _You can provide either `coin_type` or `chain_id`. The `coin_type` will be used,
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111..."
},
"account": "tzh2022070601.bit"
Expand Down Expand Up @@ -808,7 +784,6 @@ _You can provide either `coin_type` or `chain_id`. The `coin_type` will be used,
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111"
},
"account": "",
Expand Down Expand Up @@ -837,7 +812,6 @@ _You can provide either `coin_type` or `chain_id`. The `coin_type` will be used,
"type": "blockchain",
"key_info": {
"coin_type": "60",
"chain_id": "1",
"key": "0x111..."
}
}
Expand Down

0 comments on commit 0aad09a

Please sign in to comment.