diff --git a/DApp-Dev-Guid.rst b/DApp-Dev-Guid.rst new file mode 100644 index 0000000..e503efc --- /dev/null +++ b/DApp-Dev-Guid.rst @@ -0,0 +1,20 @@ +================== +DApp-Dev-Guid +================== + +How to develop a block explorer +================================= + +152525 + +How to develop a game on blockchain +===================================== + +14552 + + + +How to develop a web based wallet +======================================= + +415252154 \ No newline at end of file diff --git a/DApp-Dev-Reference.rst b/DApp-Dev-Reference.rst new file mode 100644 index 0000000..40b1516 --- /dev/null +++ b/DApp-Dev-Reference.rst @@ -0,0 +1,369 @@ +==================== +DApp-Dev-Reference +==================== + +Bitconch-web3j +=============== + + ++---------------------------------------------------------------------------------------------------------------+ +| *The interface descriptions of bitconch web3j* | ++==========================+======================+===========================================+=================+ +| FileName | ClassName | Components | Type | ++--------------------------+----------------------+-------------------------------------------+-----------------+ +| bus-account.js | BusAccout | _keypair | property | +| | +-------------------------------------------+-----------------+ +| | | pubkey | property | +| | +-------------------------------------------+-----------------+ +| | | privatekey | property | +| | +-------------------------------------------+-----------------+ +| | | constructor | variable | ++--------------------------+----------------------+-------------------------------------------+-----------------+ +| bus-blockhash.js | | Blockhash | variable | ++--------------------------+----------------------+-------------------------------------------+-----------------+ +| bpfcontroller-loader.js | BpfControllerLoader | contraollerId | property | +| | +-------------------------------------------+-----------------+ +| | | load | method | ++--------------------------+----------------------+-------------------------------------------+-----------------+ +| budget-controller.js | | SignatureCond | variable | +| | +-------------------------------------------+-----------------+ +| | | TimestampCond | variable | +| | +-------------------------------------------+-----------------+ +| | | Payment | variable | +| | +-------------------------------------------+-----------------+ +| | | BudgetCond | variable | +| | +-------------------------------------------+-----------------+ +| | | serializePayment | method | +| | +-------------------------------------------+-----------------+ +| | | serializeDate | method | +| | +-------------------------------------------+-----------------+ +| | | iso | method | +| | +-------------------------------------------+-----------------+ +| | | serializeCond | method | +| +----------------------+-------------------------------------------+-----------------+ +| | BudgetController | controllerId | property | +| | +-------------------------------------------+-----------------+ +| | | size | property | +| | +-------------------------------------------+-----------------+ +| | | datetimeCond | method | +| | +-------------------------------------------+-----------------+ +| | | signatureCond | method | +| | +-------------------------------------------+-----------------+ +| | | pay | method | +| | +-------------------------------------------+-----------------+ +| | | payOnAll | method | +| | +-------------------------------------------+-----------------+ +| | | sealWithDatetime | method | +| | +-------------------------------------------+-----------------+ +| | | sealWithSignature | method | ++--------------------------+----------------------+-------------------------------------------+-----------------+ +| connection.js | | RpcReq | variable | +| | +-------------------------------------------+-----------------+ +| | | NodeInfo | variable | +| | +-------------------------------------------+-----------------+ +| | | createRpcReq | method | +| | +-------------------------------------------+-----------------+ +| | | FetchBalanceRpcResult | variable | +| | +-------------------------------------------+-----------------+ +| | | jsonRpcResult | method | +| | +-------------------------------------------+-----------------+ +| | | AccountDetailResult | variable | +| | +-------------------------------------------+-----------------+ +| | | fetchAccountDetailRpcResult | variable | +| | +-------------------------------------------+-----------------+ +| | | AccountNoticeResult | variable | +| | +-------------------------------------------+-----------------+ +| | | ControllerAccountDetailResult | variable | +| | +-------------------------------------------+-----------------+ +| | | ControllerAccountNoticeResult | variable | +| | +-------------------------------------------+-----------------+ +| | | ConfmTxnRpcResult | variable | +| | +-------------------------------------------+-----------------+ +| | | FetchRoundLeader | variable | +| | +-------------------------------------------+-----------------+ +| | | FetchClusterNodes | variable | +| | +-------------------------------------------+-----------------+ +| | | FetchSignatureStateRpcResult | variable | +| | +-------------------------------------------+-----------------+ +| | | FetchTxnAmountRpcResult | variable | +| | +-------------------------------------------+-----------------+ +| | | FetchRecentBlockhash | variable | +| | +-------------------------------------------+-----------------+ +| | | ReqDroneRpcResult | variable | +| | +-------------------------------------------+-----------------+ +| | | SendTxnRpcResult | variable | +| | +-------------------------------------------+-----------------+ +| | | AccountDetail | variable | +| | +-------------------------------------------+-----------------+ +| | | KeyedAccountDetail | variable | +| | +-------------------------------------------+-----------------+ +| | | AccountChangeCallback | variable | +| | +-------------------------------------------+-----------------+ +| | | AccountSubscriptionDetail | variable | +| | +-------------------------------------------+-----------------+ +| | | ControllerAccountChangeCallback | variable | +| | +-------------------------------------------+-----------------+ +| | | ControllerAccountSubscriptionDetail | variable | +| | +-------------------------------------------+-----------------+ +| | | SignaturePass | variable | +| | +-------------------------------------------+-----------------+ +| | | TxnErr | variable | +| +----------------------+-------------------------------------------+-----------------+ +| | Connection | _rpcReq | property | +| | +-------------------------------------------+-----------------+ +| | | _rpcWebSock | property | +| | +-------------------------------------------+-----------------+ +| | | _rpcWebSockConnected | property | +| | +-------------------------------------------+-----------------+ +| | | _blockhashInfo | property | +| | +-------------------------------------------+-----------------+ +| | | _disableBlockhashCaching | property | +| | +-------------------------------------------+-----------------+ +| | | _accountChangeSubscriptionCounter | property | +| | +-------------------------------------------+-----------------+ +| | | _controllerAccountChangeSubscription | property | +| | +-------------------------------------------+-----------------+ +| | |_controllerAccountChangeSubscriptionCounter| property | +| | +-------------------------------------------+-----------------+ +| | | constructor | variable | +| | +-------------------------------------------+-----------------+ +| | | fetchAccountBalance | method | +| | +-------------------------------------------+-----------------+ +| | | fetchAccountDetail | method | +| | +-------------------------------------------+-----------------+ +| | | confmTxn | method | +| | +-------------------------------------------+-----------------+ +| | | fetchRoundLeader | method | +| | +-------------------------------------------+-----------------+ +| | | fetchClusterNodes | method | +| | +-------------------------------------------+-----------------+ +| | | fetchSignatureState | method | +| | +-------------------------------------------+-----------------+ +| | | fetchTxnAmount | method | +| | +-------------------------------------------+-----------------+ +| | | fetchRecentBlockhash | method | +| | +-------------------------------------------+-----------------+ +| | | reqDrone | method | +| | +-------------------------------------------+-----------------+ +| | | sendTxn | method | +| | +-------------------------------------------+-----------------+ +| | | fullnodeExit | method | +| | +-------------------------------------------+-----------------+ +| | | sendNativeTxn | method | +| | +-------------------------------------------+-----------------+ +| | | _wsOnOpen | method | +| | +-------------------------------------------+-----------------+ +| | | _wsOnErr | method | +| | +-------------------------------------------+-----------------+ +| | | _wsOnClose | method | +| | +-------------------------------------------+-----------------+ +| | | _updateSubscription | method | +| | +-------------------------------------------+-----------------+ +| | | _wsOnAccountNotice | method | +| | +-------------------------------------------+-----------------+ +| | | onAccountChange | method | +| | +-------------------------------------------+-----------------+ +| | | removeListenerOfAccountChange | method | +| | +-------------------------------------------+-----------------+ +| | | _wsOnControllerAccountNotice | method | +| | +-------------------------------------------+-----------------+ +| | | onControllerAccountChange | method | +| | +-------------------------------------------+-----------------+ +| | | removeControllerAccountChangeListener | method | ++--------------------------+----------------------+-------------------------------------------+-----------------+ +| typelayout.js | | pubKey | property | +| | +-------------------------------------------+-----------------+ +| | | uint64 | property | +| | +-------------------------------------------+-----------------+ +| | | rustString | property | ++--------------------------+----------------------+-------------------------------------------+-----------------+ +| controller-loader.js | ControllerLoader | chunkSize | property | +| | +-------------------------------------------+-----------------+ +| | | load | method | ++--------------------------+----------------------+-------------------------------------------+-----------------+ +|nativecontroller-loader.js|NativeControllerLoader| controllerId | property | +| | +-------------------------------------------+-----------------+ +| | | load | method | ++--------------------------+----------------------+-------------------------------------------+-----------------+ +| pubkey.js | PubKey | _bn | property | +| | +-------------------------------------------+-----------------+ +| | | constructor | variable | +| | +-------------------------------------------+-----------------+ +| | | isPubKey | method | +| | +-------------------------------------------+-----------------+ +| | | equals | method | +| | +-------------------------------------------+-----------------+ +| | | toBase58 | method | +| | +-------------------------------------------+-----------------+ +| | | toBuffer | method | +| | +-------------------------------------------+-----------------+ +| | | toString | method | ++--------------------------+----------------------+-------------------------------------------+-----------------+ +| system-controller.js | SystemController | controllerId | property | +| | +-------------------------------------------+-----------------+ +| | | createNewAccount | method | +| | +-------------------------------------------+-----------------+ +| | | transfer | method | +| | +-------------------------------------------+-----------------+ +| | | assign | method | ++--------------------------+----------------------+-------------------------------------------+-----------------+ +| timing.js | | NUM_TICKS_PER_SEC | variable | +| | +-------------------------------------------+-----------------+ +| | | DEFAULT_TICKS_PER_ROUND | variable | ++--------------------------+----------------------+-------------------------------------------+-----------------+ +| token-controller.rs | TokenCount | toBuffer | method | +| | +-------------------------------------------+-----------------+ +| | | fromBuffer | method | +| | +-------------------------------------------+-----------------+ +| | | TokenDetail | variable | +| | +-------------------------------------------+-----------------+ +| | | TokenDetailLayout | variable | +| | +-------------------------------------------+-----------------+ +| | | TokenAccountDetail | variable | +| | +-------------------------------------------+-----------------+ +| | | TokenAccountDetailLayout | variable | +| | +-------------------------------------------+-----------------+ +| | | TokenAndPubKey | variable | +| | +-------------------------------------------+-----------------+ +| | | SYSTEM_TOKEN_CONTROLLER_ID | variable | +| +----------------------+-------------------------------------------+-----------------+ +| | Token | connection | property | +| | +-------------------------------------------+-----------------+ +| | | token | property | +| | +-------------------------------------------+-----------------+ +| | | controllerId | property | +| | +-------------------------------------------+-----------------+ +| | | constructor | variable | +| | +-------------------------------------------+-----------------+ +| | | createNewToken | method | +| | +-------------------------------------------+-----------------+ +| | | createNewAccount | method | +| | +-------------------------------------------+-----------------+ +| | | fetchTokenDetail | method | +| | +-------------------------------------------+-----------------+ +| | | fetchAccountDetail | method | +| | +-------------------------------------------+-----------------+ +| | | transfer | method | +| | +-------------------------------------------+-----------------+ +| | | approve | method | +| | +-------------------------------------------+-----------------+ +| | | revoke | method | +| | +-------------------------------------------+-----------------+ +| | | setOwner | method | +| | +-------------------------------------------+-----------------+ +| | | transferOperation | method | +| | +-------------------------------------------+-----------------+ +| | | approveOperation | method | +| | +-------------------------------------------+-----------------+ +| | | revokeOperation | method | +| | +-------------------------------------------+-----------------+ +| | | setOwnerOperation | method | ++--------------------------+----------------------+-------------------------------------------+-----------------+ +| transaction-controller.rs| | TxnSignature | variable | +| +----------------------+-------------------------------------------+-----------------+ +| | | PACKET_DATA_SIZE | variable | +| +----------------------+-------------------------------------------+-----------------+ +| | | TxnInstructionControlFields | variable | +| +----------------------+-------------------------------------------+-----------------+ +| | TxOperation | keys | property | +| | +-------------------------------------------+-----------------+ +| | | controllerId | property | +| | +-------------------------------------------+-----------------+ +| | | data | property | +| | +-------------------------------------------+-----------------+ +| | | SignaturePubKeyPair | variable | +| | +-------------------------------------------+-----------------+ +| | | TxnControlFields | variable | +| +----------------------+-------------------------------------------+-----------------+ +| | Transaction | signatures | property | +| | +-------------------------------------------+-----------------+ +| | | signature | property | +| | +-------------------------------------------+-----------------+ +| | | operations | property | +| | +-------------------------------------------+-----------------+ +| | | recentPackagehash | property | +| | +-------------------------------------------+-----------------+ +| | | constructor | variable | +| | +-------------------------------------------+-----------------+ +| | | add | method | +| | +-------------------------------------------+-----------------+ +| | | _fetchSignData | method | +| | +-------------------------------------------+-----------------+ +| | | sign | method | +| | +-------------------------------------------+-----------------+ +| | | signPartial | method | +| | +-------------------------------------------+-----------------+ +| | | addSigner | method | +| | +-------------------------------------------+-----------------+ +| | | serialize | method | +| | +-------------------------------------------+-----------------+ +| | | keys |Deprecated method| +| | +-------------------------------------------+-----------------+ +| | | controllerId() |Deprecated method| +| | +-------------------------------------------+-----------------+ +| | | data |Deprecated method| +| | +-------------------------------------------+-----------------+ +| | | from | method | ++--------------------------+----------------------+-------------------------------------------+-----------------+ +| src/util/send-and-confm- | | sendAndConfmNativeTxn | method | +| original-tx.js | | | | ++--------------------------+----------------------+-------------------------------------------+-----------------+ +| src/util/send-and-confm- | | sendAndConfmTxn | method | +| tx.js | | | | ++--------------------------+----------------------+-------------------------------------------+-----------------+ +| src/util/shortvec- | | decodeLength | method | +| encoding.js | +-------------------------------------------+-----------------+ +| | | encodeLength | method | ++--------------------------+----------------------+-------------------------------------------+-----------------+ +| src/util/sleep.js | | sleep | method | ++--------------------------+----------------------+-------------------------------------------+-----------------+ + + ++----------------------------+ +| RpcRequest method | ++----------------------------+ +| getDif | ++----------------------------+ +| requestDif | ++----------------------------+ +| getSignatureState | ++----------------------------+ +| sendTxn | ++----------------------------+ +| getAccountInfo | ++----------------------------+ +| confirmTxn | ++----------------------------+ +| getRoundLeader | ++----------------------------+ +| getClusterNodes | ++----------------------------+ +| getTxnCnt | ++----------------------------+ +| getLastestBlockhash | ++----------------------------+ +| fullnodeQuit | ++----------------------------+ + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Installation.rst b/Installation.rst new file mode 100644 index 0000000..447bcfa --- /dev/null +++ b/Installation.rst @@ -0,0 +1,44 @@ + +====================== +Installation +====================== + +How to setup the testnet-node service +====================================== +something here.. + + +How to setup the blockexplorer +================================= +something here .. + +How to setup the faucet-wallet +================================ +something there + + +How to setup the web-based game +================================== +somethig here + + +How to create an account and get some tokens +============================================== +something here + +How to create a token (technical) +========================================= +something here + + +How to issue a toekn (non-technical) +===================================== +something here + + +How to create an DApp on Bitconch mainnet(technical) +====================================================== + something here + + + diff --git a/conf.py b/conf.py new file mode 100644 index 0000000..88a8519 --- /dev/null +++ b/conf.py @@ -0,0 +1,64 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'Bitconch' +copyright = '2019, cc' +author = 'Caesar Chad' + +# The full version, including alpha/beta/rc tags +release = '1.2' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = 'zh_CN' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +import sphinx_rtd_theme +html_theme = "sphinx_rtd_theme" +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +#html_static_path = ['_static'] \ No newline at end of file diff --git a/index.rst b/index.rst index 77020de..0060e8a 100644 --- a/index.rst +++ b/index.rst @@ -3,10 +3,15 @@ Bitconch .. image:: logo.svg :width: 120px - :alt: Solidity logo + :alt: Bitconch logo :align: center -Something about Bitconch +With 100000 TPSs, Bitconch is the fastest basic public chain in the world, +dedicated to building a truly decentralized network and infrastructure for it. +Based on the orginal POR reputation consensus algorithm, Bitconch develops +Bit-R reputation quantification anti-centralization node governance system +and Blaze zero delay ledger access technology, which effectively solves the +incompatibility of "high speed, security and decentralization". .. warning:: @@ -27,9 +32,9 @@ Language Documentation :ref:`security_considerations` section. If you have any questions, you can try searching for answers or asking on the -`Ethereum Stackexchange `_, or our `gitter channel `_. +`Bitconch Documentation `_, or our `Technical Manual `_. -Ideas for improving Solidity or this documentation are always welcome, read our :doc:`contributors guide ` for more details. +Ideas for improving Bitconch or this documentation are always welcome, read our :doc:`contributors guide ` for more details. .. _translations: @@ -41,7 +46,7 @@ They have varying degrees of completeness and up-to-dateness. The English version stands as a reference. * `Simplified Chinese `_ (in progress) -* `Korean `_ (in progress) +* `English `_ (in progress) Contents @@ -51,5 +56,6 @@ Contents .. toctree:: :maxdepth: 2 - How-to-setup-the-testnet-node-service.rst - How-to-setup-the-blockexplorer.rst + Installation.rst + DApp-Dev-Guid.rst + DApp-Dev-Reference.rst \ No newline at end of file diff --git a/logo.svg b/logo.svg new file mode 100644 index 0000000..ad5ffbf --- /dev/null +++ b/logo.svg @@ -0,0 +1,2965 @@ + + + + +