bitshares / docs.bitshares.org

Please check the new repository https://github.com/bitshares/how.bitshares.works. This repository contains the OLD sources (and the build in a different branch) for docs.bitshares.org

This repository is deprecated. The new repository is https://github.com/bitshares/how.bitshares.works

Requirements

• doxygen (run doxygen in the graphene source to generate required files)
• graphviz
• sphinx (http://sphinx-doc.org)
• breathe (https://github.com/michaeljones/breathe)

Quick Install in OSX

It's easy to get started on OSX using brew and easy_install.

brew install doxygen
brew install graphviz

easy_install sphinx
easy_install breathe

Building

make html

Output

The resulting html files will be writen to build/html.

Deployment

The Makefile can automatically deploy to several domains. Currently, a deployment installs the page simultanisouly at

• docs.bitshares.org
• docs.bitshares.eu

git remote set-url origin github:BitSharesEurope/docs.bitshares.eu 
git remote     add org    github:BitSharesEurope/docs.bitshares.org
make deploy

Updating doxygen (optional)

in doxygen/ there are filed that have been generated by bitshares/graphene C++ code using doxygen. If you want to update them, run doxygen in bitshares and move over the xml folder in doxygen/.

docs.bitshares.org's Issues

Description of a private testnet is missing

@xeroc
After the recent updates, you've replaced the previous content regarding private testnet with a description which is devoted entirely to the existing public testnet.

I agree that a private network is just a special case of a more general public one, nevertheless I think most developers would want to start with a private one first, as in most cases this is what they need and it is much easier to set up.

So please consider using this description as a complementary guide for those who need only a private network:
https://neura-sx.gitbooks.io/graphene-book/content/book/testnets/tutorial-private-testnet.html

how to get an address

the rule about
address = ‘BTS’+base58(ripemd(sha512(compressed_pub))) (checksum obviated)
doesnt work!
I got key arrays with suggest_brain_key,and I tried to generate keys by golang,and I got correct priv_key but not base58Code.

suggest_brain_key
{
  "brain_priv_key": "STRIP BEHEARS PASTERN HIND CUORIN SPATE BEEISH BETTONG COMELY LOP FREEWAY RUNG TRAMMEL CARABID CLIPEUS TARATAH",
  "wif_priv_key": "5JUxQdUCRv9sT1uvZHZb524z3p5zYR8PgzYSf47VY2fJMYjdUhV",
  "pub_key": "BTS57nastVRTyqBa69Q5vsUjWouiUNYZuoEybaoE5hwymhk7LrVC6"
}

---

func genPrivkey(brainKey string) *btcec.PrivateKey {

	s := brainKey + " 0"
	h := sha512.New()
	h.Write([]byte(s))
	bs := h.Sum(nil)

	h2 := sha256.New()
	h2.Write(bs)
	bss := h2.Sum(nil)

	seed := bss[:32]
	s256 := btcec.S256()
	priv, _ := btcec.PrivKeyFromBytes(s256, seed)

	privKeyWif, _ := btcutil.NewWIF(priv, &chaincfg.MainNetParams, false)

	fmt.Println(privKeyWif.String())//5JUxQdUCRv9sT1uvZHZb524z3p5zYR8PgzYSf47VY2fJMYjdUhV

	return priv
}

---

func genPubkey(privKey *btcec.PrivateKey) string {
	//address = ‘BTS’+base58(ripemd(sha512(compressed_pub))) (checksum obviated) 也不对
	cpk := privKey.PubKey().SerializeCompressed()
	fmt.Println(cpk)
	fmt.Printf("%x\n", cpk)
	sha := sha512.New()
	sha.Write(cpk)
	sha512 := sha.Sum(nil)
	fmt.Println(sha512)
	ripemd := ripemd160.New()
	ripemd.Write(sha512)
	addr := ripemd.Sum(nil)
	fmt.Println(addr)
	b58Code := base58.Encode(addr)
	fmt.Println("base58", b58Code)//4Kx1wmW9xKLkQ21xKDBm7VfHuEvv
	return b58Code
}

Documentation WALLET API CALLS is Disappeared

HTTPS certificate error

https://docs.bitshares.org/ shows NET::ERR_CERT_COMMON_NAME_INVALID.

Correction needed: MPA can be backed by UIA

As mentioned in bitshares/bitshares-ui#1537 (comment):

the 'MPA docs' make no reference to UIA being used as backing collateral - only Bitshares.

Actually according to chain logic, MPA can be backed by UIA, except that the MPA is owned by committee-account, related code is here.

@cedar-book please take a look.

Voting screenshots are out-of-date

They don't appear to have been updated in about 2 years, so the pictures are of the old UI.

Add MUSE and BitShares logo

scrolling problems at some pages.

pointed today in telegram by Joshua Herman:
http://docs.bitshares.org/api/network_broadcast.html

will not let you scroll to the bottom of the content page of the right in some resolutions(1600x900 for example). i think it can be fixed by adding a new newlines at the end of https://github.com/bitshares/docs.bitshares.org/blob/master/source/api/network_broadcast.rst but unsure if this will be the correct way to go. i sent a pull request with some new lines added, need building and testing #28

Minor improvements to the "Private testnet howto" documentation

Partially forwarded from bitshares/bitshares-core#700:
@RuneStone0 wrote:

2) Confusing config.ini configuration and cli_wallet end-point used
I suggest the following changes to config.ini (use port 8090 instead of 11011):

rpc-endpoint = 127.0.0.1:8090
genesis-json = my-genesis.json
enable-stale-production = true

To me it was a bit confusing that the suggested rpc-endpoint port number was 11011 (which is the default port for the p2p network). To avoid this confusion, lets use :8090 instead? This will make it more aligned when the rest of the documentation, when cli_wallet connects to a witness end-point.

Update Whitepaper section

The Whitepaper is now published and the link should be available in the documentation

Documentation whitepaper section: https://github.com/bitshares/docs.bitshares.org/blob/master/source/bitshares/papers/index.rst

Worker proposal: https://www.bitshares.foundation/workers/2018-02-documentation
Resulting Whitepaper: https://www.bitshares.foundation/announcements/2018-06-20-bitsharesblockchainwhitepaper

I do believe the documentation is more detailed than this Whitepaper though...

I would do a pull request, but I am new to the Bitshares community and don't know if there are other updates or how to handle this communication.

contributing with linux

We need to add the steps to install the requirements for linux. ubuntu/debian is the most used and maybe windows will be nice as well. currently only OSX commands are available at http://docs.bitshares.org/meta/contribute-docs.html and https://github.com/bitshares/docs.bitshares.org

Chinese Complex characters

We will examine the Simply version of Chinese translation and convert into a Complex version of Chinese complex character.

Complex character is used in Taiwan, Hong Kong and other Chinese regions.

please inform if its priority to have the Complex Chinese version to be translated.

Suggested improvement to the "enable-stale-production" explanation

I propose to replace the fragment referring to the enable-stale-production flag on this page
http://docs.bitshares.eu/testnet/3-init-blockchain.html
with the following more precise explanation:

When is it safe to stop using the enable-stale-production flag?

The enable-stale-production flag tells the witness node to produce on a chain with zero blocks or very old blocks. It can be specified as a parameter on the command line or directly in the config.ini file.

If you are running your testnet on a single machine, you should keep this flag on at all times. This way you ensure that blocks are generated even if the blockchain has been stuck due to a server crash or something similar.

If you share your testnet with other users and the witness participation is high enough, you can safely switch this flag off. In this case, when starting up, your witness node will connect to another existing witness node over the p2p network, or get the blockchain state from an existing data directory.

Prediction Market Tutorial Issue

As mentioned in bitshares/bitshares-core#460:

http://docs.bitshares.eu/bitshares/tutorials/pm-close-manual.html should also be corrected, as right now it indicates that a price feed must be published for settling a PM.

No need to create committee members in private test net

We already have initial committee members init0 ~ init10, so no need to create more as described in this page: https://github.com/bitshares/docs.bitshares.org/blob/master/source/testnet/5-committee.rst

Basic stuff about multi-sig accounts and proposed transfers

@xeroc
I've created 4 docs regarding multi-sig accounts and proposed transfers in the CLI:

• Creating a multi-sig account
• Updating an account to multi-sig
• Creating a proposed transfer
• Approving a proposed transfer

This is basically the know-how I've learned from you and abit on the forum. Some of it overlaps with "your" docs but I believe I've managed to fill some gaps that exist in "your" description.

If you find any of these docs worth integrating into docs.bitshares.eu, please feel free to do so.

https://github.com/neura-sx/graphene-book/tree/master/book/multi-sig

Most of this stuff has been thoroughly tested on the testnet.

Question about margin call mechanics page

1. This page is in /user path and is not in any category of the TOC. But I think this page is important as margin call is a rather complex process.

2. The page says "In other words, in order to stay safe and not be margin called, the margin position must maintain a collateral ratio higher than MCR * SQPR." However I think you will only be margin called if the collateral ratio is lower than MCR, not MCR * SQPR.

http://docs.bitshares.org/user/dex-margin-mechanics.html

Japanese Translation for Bitshares

My team at Vantage Corp (aka:VANCO) will proceed estimation on Bitshares.org main site translation for Japanese.

Basically there are 6 Main pages to be translated to Japanese:

(1) Main Dashboard page: https://bitshares.org/wallet/#/dashboard
(2) Account overview: https://bitshares.org/wallet/#/account/vantage-co/overview
(3) Transfer wallet: https://bitshares.org/wallet/#/transfer
(4) Exchange Market: https://bitshares.org/wallet/#/market/USD_BTS
(5) Deposit and withdraw: https://bitshares.org/wallet/#/deposit-withdraw/
(6) Setting Area:
-Setting
-Explore
-Help (There are 18 tables of contents)

We need to start initate counting and estimate total words of all 6 areas with direct professional translation. It is estimated to have 30 days for full translations of words.

Will estimate each professional translation and each word will cost between JPY50-100 yen.

Deliverables:
(1) Full professional translation of all 6 main pages and area
(2) Estimated to have full translation in 30 days.
(3) Estimate the budget within 7 days byt the end of August 30th, 2017

Exchange document should be more detailed

This document: http://docs.bitshares.org/integration/exchanges/step-by-step.html has many links to other pages, but hard to get needed info from some of the linked pages.

Can't connect to the socket from the React-native

Hello. I try to connect to the socket using the socket.io-client, but I get only the "SocketRocket: In debug mode. Allowing connection to any root cert." I checked different versions of the library and react-native and nothing happens. I thought that the address of the server is not correct but checked and it works as it should. I also created node js on localhost, connected to it and everything works, but does not connect to the remote server.
url: wss://bitshares.openledger.info/ws
"socket.io-client": "2.0.4",
"react-native": "0.58.3".
Can you say me what library you use for work with socket and version.

Unclear reference to "cli_full_wallet"

http://docs.bitshares.eu/api/rpc.html

Wallet specific commands, such as transfer and market orders, are only available if connecting to cli_wallet or cli_full_wallet and will only execute of the wallet is unlocked.

What do you mean by cli_full_wallet?