BitShares - a Collection of Developers Guide, FAQs, Tutorials & more

Learn from BitShares Documentation website

---

These are simply listed collection of BitShares Documentation website contents (Development Guide, FAQs, Tutorials, Integration Guide, Blockchain Interaction, Network and Wallet Configuration, and other reading materials).

BitShares Documentation website has variety of information but sometimes we miss to find them. I have collected manually and grouped the contents by similar categories and added links to a page or an anchor. You would get the information page (docs.bitshares.eu) by clicking links.

---

Reading materials

• White Paper
• Delegated Proof of Stake (DPOS)
• Decentralized Exchange(DEX)
  • Trading
  • Short Selling BitAssets
  • Margincall mecanics
• Distributed Access to the BitShares Decentralised Exchange (DEX)
  BitShares node setup, Create a New User, Install Nginx, Install letsencrypt, Add SSL to Nginx settings
• How to Trade in the DEX

---

---

General

Address structure, Format, block, time, etc

• What is the standard Bitshares address structure and format?
• What is the format of the block header?
• What is the maximum bitshares block size?
• Are there any sharding mechanics currently deployed?
• How are SPV clients handled?
• How is time addressed in the blockchain? Is NTP used or some other protocol?
• How do new clients bootstrap into the network?
• What is the average block time?
• How is accounting addressed in Bitshares? Is it a Nxt style accounting model or like Bitcoin’s UTXO

Protocol

• Are there any special affordances made for privacy?
• Does the protocol provide mechanisms for overlay protocols to interact such as OR_RETURN?
• Is this done via a gossip protocol or through a federate relay?

Data structures

• What data structures are used in the blockchain?

Public key system

• What public key system is used? If elliptic curve, then what is the curve?

Scriping language?

• Is there a specification for Bitshares scripting language? (assuming there is one)
• Is the scripting language turing complete?

---

Account

• Account Registration (developer)

Vesting Balance

• List Vesting Balances
• Claiming A Vesting Balance

Voting

• Voting

---

Assets

• Creating a new UIA
• Creating a UIA manually
• Creating a MPA manually
• Update/Change an existing UIA
• Publishing a Feed
• Can I change x after creation of the asset
• What about Parent and Child assets?
• Changing the issuer
• What happens to the asset creation fee?

Fee Pool

• What is the fee pool all about?
• What to do if the fee pool is empty?
• What is Fee Pool Draining?

Prediction Market

• Creating a Prediction Market
• Closing/Settling a Prediction Market

Market Fees

• What happens if I enable Market fees?
• How to claim accumulated fees?
• What if two different market fees are involved in a trade?
• What are Asset Flags and Permissions?
• What are the Permissions?
• What are the Flags?

Market Pegged Assets

• Can I use the same flags/permissions as for UIAs?
• What are market-pegged-asset-specific parameters?

Transfer/Transactions

• What transaction types are natively supported?
• What is the average size in Bytes of a Bitshares transaction?
• How are transactions validated?
• Manually Construct Any Transaction
• Proposing a Transaction
• Confidential Transfers

---

Integration Guide

• How to Run and Use a Full Node
• General Network and Wallet Configuration
• Secure Network and Wallet Configuration
• Howto prepare a CLI wallet for trading
• Monitoring Account Deposits with Python
• NodeJS Example
• Python Module for the DEX / General Python Library
  pybitshares.com offers a Trading module specifically for the decentralized exchange (DEX). It is well documented and has it’s own documentation page.

---

Blockchain Interaction

• Remote Procedure Calls
• Websocket Calls & Notifications
• Full Node
• Delayed Full Node
• CLI Wallet
• Web Wallet
• API Guide
• Blockchain API
  • Database API
  • Account History API
  • Crypto API
  • Network Broadcast API
  • Network Nodes API
• Wallet API Calls
• Often used API Calls
• Namespaces
  • Graphene::App
  • Graphene::Chain
  • Graphene::Wallet

---

Network and Wallet Configuration

• Network and Wallet Configuration
  • General Network and Wallet Configuration
  • Secure Network and Wallet Configuration

---

CLI Wallet - FAQ

• How to Run and Use the CLI-Wallet
• How to prepare a CLI wallet for Trading
• Transfering Funds using the CLI-Wallet
• Why does the CLI client crash immediately when I try to run it for the first time?
• How can I close the CLI client in a clean way?
• How can I import to my CLI client a wallet originally created in the web GUI?
• How can I transfer a single account to a cli wallet

Create lifetime membership

• How can I create, register and upgrade an account to Lifetime Membership?

---

Witness - FAQ

• How to Run a Block-producing Witness
• How to Become an Active Witness
• Change the Signing Key of your Witness
• What is the best way to interact with the witness node?
• How do I check whether the witness node is already synceed?
• How can I close the witness node in a clean way?
• Is it safe to delete logs stored in witness_node_data_dirlogsp2p?
• If it seems to be unable to sync beyond a certain date
• Whose private key is [“BTS6MRyAjQ..”,”5KQwrPbwdL..”]? Why is it predefined ion the config.ini?
• What is the meaning of all those different text colors in the witness node console?

Price Feeds

• Price Feeds
  Besides producing new blocks another very important task of the witness is to feed ACCURATE prices into the blockchain. Educational material on how this can be implemented is available in scripts/pricefeed at github (//xeroc/python-graphenelib/)together with the corresponding documentation.

Public & private testnet differences

• What is the difference between public and private testnet?

---

Committee Guide

• Creating a New Committee Member
• How to Propose Committee Actions
• How to Approve/Disapprove a Committee Proposal
• How Committee Proposes a Change in Fee

---

Worker Guide

• How to Create a Worker
• Claim Worker Pay

---

---

I am planing to make more information lists to share. My hope is to reduce information searching time and make easier to look through the BitShares Documentation contents.

My previous posts

• BitShares - Github Repositories - code|issues - wiki Links
• BitShares - Foundation & Communication Links
• BitShares Light wallet? or Web wallet?
• How to fund your first BTS - BlockTrades - Direct Exchange Service.

Thank you.