Conform to existing FAQ structure

Conform to existing FAQ structure, small updates/fixes
This commit is contained in:
jonaswhidden 2016-07-06 20:40:25 -05:00
parent 485b538686
commit cf79e773c3
10 changed files with 40 additions and 41 deletions

View file

@ -2,7 +2,13 @@
title: How do I see the list of API functions I can call, and how do I call them?
---
Here is an example script to get the documentation for the various API calls. To use any of the functions displayed, just provide any specified arguments in a dictionary.
Here is an example script to get the documentation for the various API calls. To use any of the functions displayed, just provide any specified arguments in a dictionary. Many (though not all) of the calls are the same as those for bitcoin core, which are documented [here](https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_calls_list).
If for some reason you can't get lbrycrd-cli working to make these calls, make sure you passed -server when starting lbrycrd. If it still doesn't work, you can use this command if running lbrycrd with -server:
`curl --user USER:PASSWORD --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "COMMAND", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:9245/`
USER and PASSWORD come from the above instructions and can be found in your lbrycrd.conf file ([important directories](https://lbry.io/faq/lbry-directories)), COMMAND can be any of the supported methods like getbalance or getnewaddress. 9245 is the default port used, but if you chose a custom port for the server, you'll need to use that instead. If the command accepts parameters, they can be passed inside the params array [].
Note: the lbry api can only be used while either the app or lbrynet-daemon command line are running

View file

@ -4,10 +4,10 @@ title: How do I specify a web-UI to use?
If the files for the UI you'd like to use are stored locally on your computer, start lbry with the `--ui` flag:
lbrynet-daemon --ui=/full/path/to/ui/files/root/folder
`lbrynet-daemon --ui=/full/path/to/ui/files/root/folder`
Once set with the UI flag, the given UI will be cached by lbry and used as the default going forward. Also, it will only successfully load a UI if it contains a conforming requirements.txt file to specify required lbrynet and lbryum versions. [Here](https://github.com/lbryio/lbry-web-ui/blob/master/dist/requirements.txt) is an example requirements.txt file.
To reset your ui to pull from lbryio, or to try a UI still in development, run lbry with the `--branch` flag:
lbrynet=daemon --branch=master
`lbrynet-daemon --branch=master`

View file

@ -0,0 +1,5 @@
---
title: How do I mine backup my wallet?
---
You can use `lbrycrd-cli backupwallet <pathtobackup>` to back up your wallet, or alternatively you can copy the wallet.dat file manually to anywhere you choose [important directories](https://lbry.io/faq/lbry-directories).

View file

@ -0,0 +1,5 @@
---
title: How do I check my hashrate?
---
You cannot at the present time, but that feature is coming soon (gethashespersec is not implemented for lbrycrd yet).

View file

@ -0,0 +1,5 @@
---
title: How do I check my mining balance?
---
You can use `lbrycrd-cli getbalance`, `lbrycrd-cli getinfo`, or `lbrycrd-cli getwalletinfo` for more detailed information. It takes 100 confirmed blocks (roughly a bit over 4 hours) for mined LBC to show up in your confirmed balance, but you can see these credits in your immature balance in getwalletinfo.

View file

@ -0,0 +1,5 @@
---
title: How do I encrypt my wallet?
---
You can use `lbrycrd-cli encryptwallet <passphrase>` to encrypt your wallet. You can use `lbrycrd-cli walletpassphrase <passphrase> <timeout>` to temporarily unlock the wallet (don't set timeout seconds too low or high).

View file

@ -0,0 +1,5 @@
---
title: How do I check my LBC address?
---
You can generate a new receiving address by using `lbrycrd-cli getnewaddress`. Sending and receiving functionality will eventually be coming to the LBRY UI.

View file

@ -0,0 +1,5 @@
---
title: How do I report bugs?
---
Have a technical problem? If you're having an issue with install of the UI/miner, or something involving an invite code, please join the slack at https://lbry.slack.com and in channel #bugs post a SINGLE detailed note with what exactly is going on. If you can get to the LBRY UI after installing, but can't watch a video or have another problem, please click the three horizontal lines in the top right hand corner of the LBRY UI, click Help, then click the Send Us a Bug Report link.

View file

@ -2,4 +2,4 @@
title: Where are all the behind the scenes files?
---
On linux, the relevant directories are `~/.lbrynet`, `~/.lbrycrd`, and `~/.lbryum`, depending on which wallets you've used. On OS X, the folders of interest are `~/Library/Application Support/LBRY`, `~/.lbrycrd` and `~/.lbryum`, also depending on which wallets you've used.
On linux, the relevant directories are `~/.lbrynet`, `~/.lbrycrd`, and `~/.lbryum`, depending on which wallets you've used. On OS X, the folders of interest are `~/Library/Application Support/LBRY`, `~/Library/Application Support/lbrycrd` `~/.lbrycrd` and `~/.lbryum`, also depending on which wallets you've used.

View file

@ -24,40 +24,3 @@ LBRY binaries are out for OS X and Ubuntu. Others may try compiling from source.
## Compiling
LBRY can be compiled quite similarly to Bitcoin. Pester @jackrobison on Slack to fill this in!
## FAQ
###Q. How many coins do I get per block mined?
**A.** For the first 5000 blocks, the reward was 1 LBC. In the current phase, blocks 5100 to 55000, the reward per block goes up by 1 every hundred blocks, so the reward per block = ceiling((blocknumber-5100)/100) + 1, maxing out at 500 after roughly 90 days from block 5100. After block 55000, the reward will decrease towards 0 logarithmically over 20 years.
###Q. Is there an explorer?
**A.** Yes, visit https://explorer.lbry.io
###Q. How do I check my balance?
**A.** You can use `lbrycrd-cli getbalance`, `lbrycrd-cli getinfo`, or `lbrycrd-cli getwalletinfo` for more detailed information. It takes 100 confirmed blocks (roughly a bit over 4 hours) for mined LBC to show up in your confirmed balance, but you can see these credits in your immature balance in getwalletinfo.
###Q. How do I check my address?
**A.** You can use `lbrycrd-cli getnewaddress` to generate a new receiving address.
###Q. How do I backup my wallet?
**A.** You can use `lbrycrd-cli backupwallet <pathtobackup>` to back up your wallet, or alternatively you can copy the wallet.dat file manually from `~/Library/Application\ Support\lbrycrd` to anywhere you choose.
###Q. How do I encrypt my wallet?
**A.** You can use `lbrycrd-cli encryptwallet <passphrase>` to encrypt your wallet. You can use `lbrycrd-cli walletpassphrase <passphrase> <timeout>` to temporarily unlock the wallet (don't set timeout seconds too low or high).
###Q. What are some other commands available?
**A.** lbrycrd is forked from bitcoin core, so many (but not all) of the available commands for the original client can be passed via lbrycrd-cli, like those above. Here is a list: https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_calls_list
###Q. I can't get lbrycrd-cli to work, is there another way?
**A.** If you cannot get the cli to work, first check that you passed -server when starting lbrycrdd. If it still can't connect, you can try running this command:
`curl --user USER:PASSWORD --data-binary '{"jsonrpc": "1.0", "id":"curltest", "method": "COMMAND", "params": [] }' -H 'content-type: text/plain;' http://127.0.0.1:9245/`
USER and PASSWORD come from the above instructions and can be found in `~/Library/Application\ Support/lbrycrd/lbrycrd.conf`, COMMAND can be any of the above methods like getbalance or getnewaddress. 9245 is the default port used, but if you chose a custom port for the server, you'll need to use that instead. If the command accepts parameters, they can be passed inside the params array [].
###Q. Can I check my hashrate?
**A.** Not at the present time, but that feature is coming soon (gethashespersec is not implemented for lbrycrd yet).
## Technical Problems
Have a technical problem? If you're having an issue with install of the UI/miner, or something involving an invite code, please join the slack at https://lbry.slack.com and in channel #bugs post a SINGLE detailed note with what exactly is going on. If you can get to the LBRY UI after installing, but can't watch a video or have another problem, please click the three horizontal lines in the top right hand corner of the LBRY UI, click Help, then click the Send Us a Bug Report link.