Peerplays_Blockchain/peerplays_migrated
1
0
Fork 0
Code Issues 35 Pull requests 4 Projects Releases 20 Packages Wiki Activity Actions

Tweaks to README.md

Browse source
This commit is contained in:
Nathan Hourt 2015-06-08 13:08:55 -04:00
parent 0a945b0257
commit 185f3a4ffc
1 changed files with 10 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -9,9 +9,6 @@ Starting Graphene
git clone https://gitlab.bitshares.org/dlarimer/graphene
cd graphene
git submodule update --init --recursive
TODO: Are recursive flags needed for submodules?
cmake -DCMAKE_BUILD_TYPE=Debug .
make
./programs/witness_node/witness_node
@ -72,16 +69,14 @@ How to use fc async to do recurring tasks
Stuff to know about the code
----------------------------
`static_variant<t1, t2>` is a *union type* which says "this variable may be either t1 or t2." It is serializable if t1 and t2 are both serializable (TODO: Is this accurate?)
`static_variant<t1, t2>` is a *union type* which says "this variable may be either t1 or t2." It is serializable if t1 and t2 are both serializable.
The 'operations.hpp` documents the available operations, and `database_fixture.hpp` shows the way to do many things.
The file `operations.hpp` documents the available operations, and `database_fixture.hpp` is a good reference for building and submitting transactions for processing.
Tests also show the way to do many things, but are often cluttered with code that generates corner cases to try to break things in every possible way.
Visitors are at the end of `operations.hpp` after the large typedef for `operation` as a `static_variant`. TODO: They should be refactored into a separate header.
When using `modify()`, you can pass in either an `object_id` or an `object`. Passing in an `object` is faster as it avoids a lookup.
Downcasting stuff
-----------------
@ -99,11 +94,15 @@ Debugging FC exceptions with GDB
- `catch throw`
TODO: Questions
Questions
---------------
This section contains questions for more experienced developers to answer.
- Is there a way to generate help with parameter names and method descriptions?
Is there a way to generate help with parameter names and method descriptions?
Yes. Documentation of the code base, including APIs, can be generated using Doxygen. Simply run `doxygen` in this directory.
Is there a way to allow external program to drive `cli_wallet` via websocket, JSONRPC, or HTTP?# graphene
- Is there a way to allow external program to drive `cli_wallet` via websocket, JSONRPC, or HTTP?
Yes. External programs may connect to the CLI wallet and make its calls over a websockets API. To do this, run the wallet in
server mode, i.e. `cli_wallet -s "127.0.0.1:9999"` and then have the external program connect to it over the specified port
(in this example, port 9999).