BitShares Forum

Main => Technical Support => Topic started by: xeroc on November 13, 2015, 12:27:58 pm

Title: Next Documentation Efforts [poll]
Post by: xeroc on November 13, 2015, 12:27:58 pm
Since there are so many things that still need proper documentation, I hereby ask the community to vote for their favorit so I can focus on it.

Please vote!

If something is missing, please add it to the thread


Also note that I will be mostly unavailable next week!
Title: Re: Next Documentation Efforts [poll]
Post by: xeroc on November 16, 2015, 08:54:29 am
*dump*
Title: Re: Next Documentation Efforts [poll]
Post by: Bhuz on November 16, 2015, 11:14:08 am
Voted.

IMO:
I see that there are more requests for Market Engine, API and Exchange documentation, but I think that these very topics should first wait for the upcoming changes that would make a today-documentation old.
As a matter of fact, in BM's proposals there are some changes about:
-the market engine (iirc the margin trading mechanics are going to change, following poloniex's style)
-the api will be refactored and made more user/bot/exchange friendly
-some exchange related details will change too, like fees on order's creation/cancellation and percentage fees on order fulfillment that would also qualify for the referral program
Title: Re: Next Documentation Efforts [poll]
Post by: roadscape on November 19, 2015, 07:43:52 pm
bump
Title: Re: Next Documentation Efforts [poll]
Post by: cube on November 23, 2015, 07:07:36 am
I get feedback from friends when I introduce them bitshares.  It is too complicated to understand, especially about securing bts fund (they are worried about losing their money by viruses/hackers) and using the market.  I think they are the foundation documentation. 
Title: Re: Next Documentation Efforts [poll]
Post by: xeroc on November 23, 2015, 10:20:22 am
Working on the backup/coldstorage/security aspects now

edit: seems that coldstorage infrastructure needs some more time ...
Title: Re: Next Documentation Efforts [poll]
Post by: BTSdac on November 26, 2015, 06:21:15 am
Working on the backup/coldstorage/security aspects now

edit: seems that coldstorage infrastructure needs some more time ...
can brain key consider as a cold-storage way ? 
Title: Re: Next Documentation Efforts [poll]
Post by: xeroc on November 26, 2015, 07:28:24 am
Working on the backup/coldstorage/security aspects now

edit: seems that coldstorage infrastructure needs some more time ...
can brain key consider as a cold-storage way ? 

Yes .. if you have never manually imported a private key .. all your accounts can be recovered via brain key..

you can give it a try an create a new wallet from the brain wallet of your existing wallet
Title: Re: Next Documentation Efforts [poll]
Post by: cube on November 26, 2015, 03:32:39 pm
This thread - ttps://bitsharestalk.org/index.php/topic,20267.0/topicseen.html goes to show a documentation on securing wallet/fund is important and very much needed.
Title: Re: Next Documentation Efforts [poll]
Post by: xeroc on December 03, 2015, 02:41:17 pm
Since my last post here, I made some considerable improvements and wrote some more articles:

15/12/03 Manually Construct Any Transaction, Proposing a Transaction
15/12/03 Tutorials, Confidential Transfers, Committee, Claim Worker Pay, Shareholder, Workers / Budget Items, Often used API Calls, Wallet Merchant Protocol, Wallet Login Protocol
15/11/30 Margin call mechanics
15/11/26 First Steps for End-Users, Things you should know, Assets/Tokens
15/11/23 User Guide updates: Transactions and Operations, Decentralized Exchange, Security
15/11/13 Refactoring, updates for: Integration Guide
15/11/10 Added MUSE blockchain: MUSE

For those that haven't notices .. you can now also reach it via docs.bitshares.ORG!

Cheers
Title: Re: Next Documentation Efforts [poll]
Post by: cube on December 03, 2015, 02:48:29 pm
Since my last post here, I made some considerable improvements and wrote some more articles:

15/12/03 Manually Construct Any Transaction, Proposing a Transaction
15/12/03 Tutorials, Confidential Transfers, Committee, Claim Worker Pay, Shareholder, Workers / Budget Items, Often used API Calls, Wallet Merchant Protocol, Wallet Login Protocol
15/11/30 Margin call mechanics
15/11/26 First Steps for End-Users, Things you should know, Assets/Tokens
15/11/23 User Guide updates: Transactions and Operations, Decentralized Exchange, Security
15/11/13 Refactoring, updates for: Integration Guide
15/11/10 Added MUSE blockchain: MUSE

For those that haven't notices .. you can now also reach it via docs.bitshares.ORG!

Cheers

Nice.  I just took a look. 

I have a question.  Is "add_operation_to_builder_transaction" still valid or is it replaced by "add_operation_to_builder_transaction2"?
Title: Re: Next Documentation Efforts [poll]
Post by: xeroc on December 03, 2015, 03:14:06 pm
Since my last post here, I made some considerable improvements and wrote some more articles:

15/12/03 Manually Construct Any Transaction, Proposing a Transaction
15/12/03 Tutorials, Confidential Transfers, Committee, Claim Worker Pay, Shareholder, Workers / Budget Items, Often used API Calls, Wallet Merchant Protocol, Wallet Login Protocol
15/11/30 Margin call mechanics
15/11/26 First Steps for End-Users, Things you should know, Assets/Tokens
15/11/23 User Guide updates: Transactions and Operations, Decentralized Exchange, Security
15/11/13 Refactoring, updates for: Integration Guide
15/11/10 Added MUSE blockchain: MUSE

For those that haven't notices .. you can now also reach it via docs.bitshares.ORG!

Cheers

Nice.  I just took a look. 

I have a question.  Is "add_operation_to_builder_transaction" still valid or is it replaced by "add_operation_to_builder_transaction2"?
You are mixing up
 * propose_builder_transaction and
 * propose_builder_transaction2 (will be available in a future release)

I never ran across a "add_operation_to_builder_transaction2" .. and it really only puts JSON objects together ... don't see a need to another implementation :)
Title: Re: Next Documentation Efforts [poll]
Post by: cube on December 03, 2015, 03:47:13 pm
Since my last post here, I made some considerable improvements and wrote some more articles:

15/12/03 Manually Construct Any Transaction, Proposing a Transaction
15/12/03 Tutorials, Confidential Transfers, Committee, Claim Worker Pay, Shareholder, Workers / Budget Items, Often used API Calls, Wallet Merchant Protocol, Wallet Login Protocol
15/11/30 Margin call mechanics
15/11/26 First Steps for End-Users, Things you should know, Assets/Tokens
15/11/23 User Guide updates: Transactions and Operations, Decentralized Exchange, Security
15/11/13 Refactoring, updates for: Integration Guide
15/11/10 Added MUSE blockchain: MUSE

For those that haven't notices .. you can now also reach it via docs.bitshares.ORG!

Cheers

Nice.  I just took a look. 

I have a question.  Is "add_operation_to_builder_transaction" still valid or is it replaced by "add_operation_to_builder_transaction2"?
You are mixing up
 * propose_builder_transaction and
 * propose_builder_transaction2 (will be available in a future release)

I never ran across a "add_operation_to_builder_transaction2" .. and it really only puts JSON objects together ... don't see a need to another implementation :)

You are right. My bad. Typo mistake with copy-and-paste too fast. I meant "  Is "propose_builder_transaction" still valid or is it replaced by "propose_builder_transaction2"?"


propose_builder_transaction was mentioned in the document.  Should it be removed if it is no longer valid?
Title: Re: Next Documentation Efforts [poll]
Post by: xeroc on December 03, 2015, 04:02:16 pm
There is an issue about this .. I need to reread the code .. but I think the tutorial is correct ..
https://github.com/cryptonomex/graphene/issues/467
https://github.com/cryptonomex/graphene/commit/7a5c5c476d9762cbba1d745447191523ca5cd601 

The patch is on a different branch, hence propose_builder_transaction2 is not yet available
Title: Re: Next Documentation Efforts [poll]
Post by: clout on December 03, 2015, 04:41:21 pm
@ xeroc, I think it would be most beneficial to provide documentation on how to build a transaction that requires multiple signatures, propose the transaction, and then have it signed by all active authority accounts. Is this something you would be up for?

The most important feature that we are not using right now is multi sig transactions.
Title: Re: Next Documentation Efforts [poll]
Post by: xeroc on December 03, 2015, 05:16:06 pm
@ xeroc, I think it would be most beneficial to provide documentation on how to build a transaction that requires multiple signatures, propose the transaction, and then have it signed by all active authority accounts. Is this something you would be up for?

The most important feature that we are not using right now is multi sig transactions.
absoluteley .. it's on my list ... and I hope to see this also implemented in the GUI soonish :)
Title: Re: Next Documentation Efforts [poll]
Post by: xeroc on December 04, 2015, 06:36:27 am
@ xeroc, I think it would be most beneficial to provide documentation on how to build a transaction that requires multiple signatures, propose the transaction, and then have it signed by all active authority accounts. Is this something you would be up for?

The most important feature that we are not using right now is multi sig transactions.
absoluteley .. it's on my list ...
Title: Re: Next Documentation Efforts [poll]
Post by: xeroc on January 12, 2016, 04:16:51 pm
For those that haven't noticed, there is a bunch of updates (including one big update which I wrote today):

    16/01/12 Assets/Tokens, Creating a UIA manually Creating a MPA manually, Frequently Asked Questions, Privatized BitAssets, Publishing a Feed, Prediction Markets, Creating a Prediction Market, Closing/Settling a Prediction Market
    16/01/07 User Issued Assets, Creating a new UIA, Creating a UIA manually
    16/01/06 Change the Signing Key of your Witness
    15/12/21 Workers / Budget Items, Fee Backed Asset, Funding Your Ideas, BitShares Improvement Proposal
    15/12/18 Whitepapers: Release Candiate for the BitShares: General Overview whitepaper
    15/12/04 Permissions, Proposed Transactions
Title: Re: Next Documentation Efforts [poll]
Post by: abit on January 12, 2016, 10:26:42 pm
Is there a up-to-date white paper of DPOS itself?
It would be useful when comparing to the competitors' E.G. IBM's OpenLedger, Linux Foundation's OpenLedger, Eth and so.
Sorry if this is a stupid question.
Title: Re: Next Documentation Efforts [poll]
Post by: xeroc on January 13, 2016, 07:02:40 am
Is there a up-to-date white paper of DPOS itself?
It would be useful when comparing to the competitors' E.G. IBM's OpenLedger, Linux Foundation's OpenLedger, Eth and so.
Sorry if this is a stupid question.
Not a stupid questions .. and we *STILL* lack this whitepaper ..
Any help/assistance would be greatly appreciated!
Title: Re: Next Documentation Efforts [poll]
Post by: abit on January 13, 2016, 10:40:32 am
Is there a up-to-date white paper of DPOS itself?
It would be useful when comparing to the competitors' E.G. IBM's OpenLedger, Linux Foundation's OpenLedger, Eth and so.
Sorry if this is a stupid question.
Not a stupid questions .. and we *STILL* lack this whitepaper ..
Any help/assistance would be greatly appreciated!
It's sad that bm have no time to write it down. Always rushing on implementing things and/or think about new ideas.
I am not good at writing at all, I can help check/improve if there is a draft.