Developers Guide (Tutorials)

This section intended to collect “How To” steps information to show some examples to perform a process.

INFORMATOPN :: BitShares Core Coding Style Guide (DRAFT)

---

Accounts

• How can I register an account by using CLI?

• How can I change a Cloud Wallet Password?

• How can I import a GUI-wallet account into CLI-wallet?

Vesting Balance

• How can I check a Vesting Balances?

• How can I claim a Vesting Balance?

• Vesting Balance Operation

  • vesting_balance_create_operation

  • vesting_balance_withdraw_operation

API

• How an Exchange can integrate their services to the BitShares UI Wallet - Gateway Integration Requirements : from BitShares UI wiki

• How can I enable RPC Logging?

• How to script Websockets by Python

Assets

• Read: User Guide BitShartes Assets Tokens

  1. User Issued Assets (UIAs)

  2. Market Pegged Assets (MPAs)

  3. Exchange Backed Assets (EBA)

  4. Privatized BitAssets - Feed Producer

  5. Fee Backed Asset

  6. Prediction Markets

• How can I create a new UIA by using GUI?

• How can I create a UIA manually (CLI)?

• How can I create a MPA manually (CLI)?

• How can I update/change an existing UIA (CLI)?

• How can I publish a price feed (CLI)?

• How to use Whitelists and Blacklists?

Prediction Market

• What is a prediction market?

• How can I create a Prediction Market (CLI)?

• How can I close/settle a Prediction Market (CLI)?

BitShares Decentralized Exchange (DEX)

• Read: User Guide : Dex

  1. Trading

  2. Short Selling BitAssets

  3. MarginCall Mechanics

• How can I run own Decentralized Exchange (DEX)?

• How can I prepare BitShares Exchange? (Single Node Edition)

BitShares Explorer

• How can I use BitShares APIs?

  • Try BitShares Explorer APIs!

• How can I install BitShares Explorer REST API? - Installation Guide

Committee Guide

• How can I create a New Committee Member?

• How to create a Proposal to change a fee?

• How to approve/disapprove a Proposal

• How to Propose Committee Actions

Delegated Proof of Stake

• Read” User Guide (DPOS)

Keys

• How can I import a GUI-wallet account into CLI-wallet?

• Where are public/private keys? GUI

• How to Generate Key Pairs

Monitoring

• How to monitor Account Deposits - Python

• How to monitor Balance History of an Account - NodeJS

Node

• How can a Let’s Encrypt certificate be used with an API node to provide a secure web socket (wss) connection

• How to configure a witness_node as a delayed_node

• How to connect to your own Full Node (GUI)

• How to change the Signing Key of your Witness

• What is System Requirements

• How to Run and Use a Full Node

• How to run Node in the background by using GNU screen

• How to run a BitShares API Node

Node (Block Producer - Witness)

• How to Become a Block Producer

• How to verify Block Production

• How to Backup a server

• How witness Price Feeds work

• BitShares Block Production Monitor

Performance

• How to run the Performance Test

Plugin

• Type of BitShares Plugins: Github ReadMe

• ElasticSearch Plugin

  • How to store account history data into an elasticsearch database.

• Memory Reduction for Nodes

  • Help to reduce RAM usage significantly by using witness_node executable options.

• Plugin Template - (create a demo API hello)

• Discussion: “Create plugin script” (#1302)

Python - BitShares

• Python-Bitshares Documentation

• Python Library for BitShares: GitHub

  • Fully featured client-side library for the BitShares Blockchain - written entirely in python.

• uptick: Python-based CLI tool set for BitShares blockchain

• How to Set up Python Library for the Public Testnet

  • How to Create MPAs/UIAs with Python

• Faucet - Tapin

  • Tapin is a python-based faucet for Graphene-based blockchains (e.g. BitShares).

• Monitoring Account Deposits - Python - (How to setup)

• Websockets Scripting Support

  • Ptython - websocket-client interact with the Core API

Smart Contracts

• Example: Graphene Smart Contract

Testnets

• Code Coverage Testing (wiki)

• How to set up a Public Testnet

• How to set up a Private Testnet

• How to set up a Public Testnet

• How to set up Python Library

• How to do a code coverage testing

• How to set up Faucet

• How to set up Nignx

Transfer / Transactions

• What is the average size in Bytes of a Bitshares transaction?

• What transaction types are natively supported?

• How Multi-signature’ works

• How to use the CLI wallet to perform Confidential Transfers

• Hot to Construct Any Transaction - Manually

• How to Crafting, Proposing, and Approving a Transaction - Proposed Transaction

• How to use the CLI wallet to Perform Stealth Transfers in BitShares (wiki)

• Proposed Transaction and Multi-Signature

Use Cases

• For Exchanges, Bridges, and Gateways

• For Merchants

• For Traders

Wallet / CLI

• How to Set a password and Unlock a Cli Wallet

• How to connect and use the CLI-Wallet

• How to setup Network and Wallet Configuration

• How to transferring Funds by using the CLI-Wallet

• How to import a GUI-Wallet Account into CLI-Wallet

• Where to find BitShares Public Full Nodes

Worker

• How to Create a Worker

• How to find claim Worker Pay

• How the Blockchain Worker System work? (*open a doxygen documentation)

Migration (from BitShares1.0)

• Migrating from BitShares 1.0 to BitShares 2.0

• Explore Your Wallet

• Improve Your Wallet

• Migration Remarks

---