Skip to content

Commit

Permalink
Merge pull request Qitmeer#59 from forchain/master
Browse files Browse the repository at this point in the history
restructure wallet API
  • Loading branch information
forchain authored Dec 4, 2020
2 parents 4019921 + a31b5ab commit 84d91fb
Show file tree
Hide file tree
Showing 40 changed files with 121 additions and 100 deletions.
1 change: 1 addition & 0 deletions Document/content/JSON RPC API/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ weight: 5
- [getRawTransaction](getrawtransaction)
- [getUtxo](getutxo)
- [sendRawTransaction](sendrawtransaction)
- [txSign](txSign)



Expand Down
43 changes: 0 additions & 43 deletions Document/content/Wallet JSON RPC API/API List/_index.en.md

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

4 changes: 0 additions & 4 deletions Document/content/Wallet JSON RPC API/Errors/_index.en.md

This file was deleted.

15 changes: 15 additions & 0 deletions Document/content/Wallet JSON RPC API/QitmeerD/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: QitmeerD API
weight: 2
---

## Overview
API for qitmeer daemon

## QitmeerD
- [add](add)
- [del](del)
- [list](list)
- [reset](reset)
- [status](status)
- [update](update)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: qitmeed_add
title: add
weight: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: qitmeed_del
title: del
weight: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: qitmeed_list
title: list
weight: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@

---
title: reset
weight: 3
---
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: qitmeed_status
title: status
weight: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@

---
title: update
weight: 3
---
23 changes: 23 additions & 0 deletions Document/content/Wallet JSON RPC API/UI/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: UI API
weight: 2
---

## Overview
Web UI API

### Note
required `ui` config enabled

```sh
ui=true
```




## UI
- [createWallet](createwallet)
- [makeSeed](makeseed)
- [walletStatus](walletstatus)
- [recoverWallet](recoverwallet)
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: ui_createWallet
title: createWallet
weight: 3
---

## CreateWallet
## ui_createWallet
create wallet by seed

### Parameters
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@

---
title: ui_makeSeed
title: makeSeed
weight: 3
---

## MakeSeed
## ui_makeSeed
make wallet HD seed and mnemonic

### Parameters
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: ui_recoverWallet
title: recoverWallet
weight: 3
---

## RecoverWallet
## ui_recoverWallet
Recover Wallet wallet by mnemonic

### Parameters
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@

---
title: ui_walletStatus
title: walletStatus
weight: 3
---

## WalletStatus
## ui_walletStatus
wallet info

### Parameters
Expand Down
32 changes: 32 additions & 0 deletions Document/content/Wallet JSON RPC API/Wallet/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@

---
title: Wallet API
weight: 2
---

## Overview
wallet services

## Wallet
- [createAccount](createaccount)
- [createAddress](createaddress)
- [importPrivKey](importprivkey)
- [importWIFPrivKey](importwifprivkey)
- [dumpPrivKey](dumpprivkey)

- [sendToAddress](sendtoaddress)
- [sendToAddressByAccount](sendtoaddressbyaccount)
- [sendToMany](sendtomany)

- [getAccountByAddress](getaccountbyaddress)
- [getAccountsAndBalance](getaccountsandbalance)
- [getAddressesByAccount](getaddressesbyaccount)
- [getBalanceByAccount](getbalancebyaccount)
- [getBalanceByAddr](getbalancebyaddr)
- [getBillByAddr](getbillbyaddr)
- [getTxListByAddr](gettxlistbyaddr)
- [getUTXO](getutxo)

- [lock](lock)
- [syncStats](syncstats)
- [unlock](unlock)
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: wallet_createAccount
title: createAccount
weight: 3
---

## CreateAccount
## ui_createAccount
creates the next account and returns its account number. The
name must be unique to the account. In order to support automatic seed
restoring, new accounts may not be created when all of the previous 100
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: wallet_createAddress
title: createAddress
weight: 3
---

## CreateAddress
## ui_createAddress
returns the next external chained address for a wallet.

### Parameters
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: wallet_dumpPrivKey
title: dumpPrivKey
weight: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: wallet_getAccountByAddress
title: getAccountByAddress
weight: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: wallet_getAccountsAndBalance
title: getAccountsAndBalance
weight: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

---
title: wallet_getAddressesByAccount
title: getAddressesByAccount
weight: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: wallet_getBalanceByAccount
title: getBalanceByAccount
weight: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

---
title: wallet_getBalanceByAddr
title: getBalanceByAddr
weight: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: wallet_getBillByAddr
title: getBillByAddr
weight: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: wallet_getTx
title: getTx
weight: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: wallet_getTxListByAddr
title: getTxListByAddr
weight: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: wallet_getUtxo
title: getUtxo
weight: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: wallet_importPrivKey
title: importPrivKey
weight: 3
---

## ImportPrivKey
## ui_importPrivKey
imports a private key to the wallet and writes the new wallet to disk.

**Note**: this private key is in a hex string and you may generate it with `qx wiftopriv` tool from a WIF key, which should be compatible with BTC network (in contrast to dumpPrivKey and importWIFPrivKey, both are incompatible). You may export this WIF key from any wallet service that follows this rule, such as [KAHF](https://kahf.io)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: wallet_importWifPrivKey
title: importWifPrivKey
weight: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: wallet_lock
title: lock
weight: 3
---

### Lock
### ui_lock
lock wallet

#### Parameters
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: wallet_sendToAddress
title: sendToAddress
weight: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: wallet_sendToAddressByAccount
title: sendToAddressByAccount
weight: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: wallet_sendToMany
title: sendToMany
weight: 3
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

---
title: wallet_syncStats
title: syncStats
weight: 3
---

Expand Down
Loading

0 comments on commit 84d91fb

Please sign in to comment.