fioprotocol / fio-devhub Goto Github PK

Question on: https://github.com/fioprotocol/fio-devhub/tree/master/_docs/integration-guide/index.md

The FIO Core Tech team is looking for a part-time technical writer who has experience with GitHub and writing in Markdown. FIO is the Foundation for Interwallet Operability, a non-profit industry group dedicated to the pursuit of blockchain usability through the FIO Protocol. Learn more about FIO here: https://fioprotocol.io

You will spend 4–6 hours a week working with the FIO Core Tech team to maintain, curate, and expand the content on the FIO Developer Portal (located at https://developers.fioprotocol.io). Content is composed in Markdown and is part of a Jekyll collection. To learn more, check out the public GitHub repository: https://github.com/fioprotocol/fio-devhub

Are you a technical writer who’s familiar with docs-as-code and would like to pick up some extra work? Are you interested in cryptocurrency and learning about the community-governed protocols that are revolutionizing the usability of crypto worldwide? If so, please contact Edward Rotthoff, Software Architect and Senior Blockchain Developer at FIO Protocol, directly on LinkedIn (https://www.linkedin.com/in/edward-rotthoff-84872a86/) or by email ([email protected]).

https://fioprotocol.atlassian.net/wiki/spaces/FD/pages/35488543/FIO+Versioning

https://developers.fioprotocol.io/docs/chain/node-build

Add details on where to find information on BPs and Proxies.

https://www.alohaeos.com/vote/proxy/fiomain
Ledgerwise
graph.fioprotocol.io
etc.

https://gist.github.com/blockpane/d1c076f560d074ca7136e902f2dae1ae

https://github.com/blockpane/fio-search

https://developers.fioprotocol.io/pages/api/fio-api/#post-/get_table_rows

• Developer onboarding page
• Complete fio.devtools documentation

Need to update the node install and upgrade process for wallets and exchanges. This should include either replacing or updating the code at fio.start.

Should not require a private key.

• Clean up error codes (and make generic) some 403s look incorrect.
• Add 202 response to all actions (make this generic). See old site.

If transaction processing is timing out: the nodeos setting that will likely fix that is max-transaction-time = 100 or add --max-transaction-time 100 to startup command

Add information on Discord, telegram, etc.

https://fioprotocol.io/chat

Similar to: https://fioprotocol.atlassian.net/wiki/spaces/FD/pages/17825931/Ecosystem+Integration+Status

See: https://gist.github.com/blockpane/6223e76971bd3e15666793e016eb938d

Create a checklist for integrators that details the functionality and qa checks that should be completed for the different FIO features.

Something like:

Validation using checksum

More rigorous checksum code may also be used to validate a FIO Address. This validation process consists of:

1. Confirming the first three characters of the key are 'FIO'
2. Base58 decoding of the char
3. ...

[NEED TO COMPLETE, include JS and C++ sample code]

Include info on:

• Expiration and burning
• Anyone can renew domains and addresses

Question on: https://github.com/fioprotocol/fio-devhub/tree/master/_docs/chain/node-build.md

Describe the auth checks with OBT and FIO Request. For example, the contract checks that the fio address in the payee (in requests) or payer (in responses) is matched to the pubkey in the transaction's signature

There are several methods for indexing transactions depending on what type of node is being accessed. Need to integrate information from:
https://github.com/fioprotocol/fio-go/tree/master/_example/_blocks
https://github.com/fioprotocol/fiosdk_typescript/tree/master/examples/FioTransactionHistory

High level process that may be of use:

1. call '/chain/get_info' to get the latest irreversible block's heght "last_irreversible_block_num" (which never rolls back)
2. call '/chain/get_block' for each block height with {"block_num_or_id":height} to get "transactions" array, which contains all transactions on the block
3. loop "transactions" array and get "transactions"[i]
4. check whether "transactions"[i]."status" == "executed", if yes go to next step, if no skip this transaction
5. get "transactions"[i]."trx"."transaction"."actions"[0]."data" as "data"
6. check whether "data"."payee_public_key" is our deposit address, if yes then "data"."actor" is the sender address,"data"."amount"/1000000000 is the amount of FIO sent

Need to include note on msig transactions:
If you are running a private node without a history plugin it's still possible, but there is one problem with multi-signature transactions that can complicate things. Any blocks containing a multi-signature transaction will give a different data structure for the transaction, requiring special handling. The msig transactions will not have any structure at all, only a string with the transaction ID. For these it will be necessary to also call the get_transaction API using both the block number (non-history nodes require a block hint) and the transaction ID.

Existing page:

- title: FIO Chain Overview
  url: /pages/chain-overview/

Need better documentation that describes which versions of the chain/contracts/API/SDKs work together.

Requested update to Dev hub:

• We may want a FIP that would allow a FIO public key to not receive tokens. Meaning the blockchain would reject an attempt to send to this public key. It's an edge case, for sure, but here's the scenario: Exchange sets up deposits@exchange for sending out all FIO Requests and each request has individual public addresses for those deposits. If a user sends FIO directly to deposits@exchange, a FIO mapping that can't be removed or changed or it will break the encryption process, they won't know who to send those tokens to and it creates a support headache for them. If, instead, the chain just refused to accept the tokens on that public key, the problem is avoided.
• Wallets: bad idea to ever change the FIO public mapping. It breaks the default encryption scheme by using the wrong public key.
• Exchanges: it can make sense to to allow for mapping changes because there may be two different security models (wallets) in place. One controls individual user account private keys, one controls the FIO side of things (creating mappings, sending FIO requests, etc). In this scenario, they don't want the deposit accounts to own the FIO responsibilities for user1@exchange because then they would need that FIO private key for managing anything related to that FIO public address. As long as they never send a FIO request from user1@exchange (because the lookup of that public key would not map correctly to the on chain actor account for that encrypted request), it should work.

@eric Butz [Dapix] that an okay summary of what we learned on the call? If so, can you update the docs appropriately? I think this nuance is a really important one (Don't change the FIO mapping! ...unless it's okay to do so) for our integration partners to understand because if they don't FIO functionality breaks.

Document the known issues and helpful hints with SDKs, APIs, and chain.

deleted

Question on: https://github.com/fioprotocol/fio-devhub/tree/master/pages/docs.md

Todd : That said I put a couple of things together: https://fio-utils.blockpane.com/index.html#/fees web-based tool using anchor, and a much more complex daemon: https://github.com/blockpane/fio-tools/tree/master/fio-fee-vote

BP pricing tool: https://github.com/fioprotocol/bp-tools

Within the API it would be good to document if the fees are fixed or dynamic, who pays them (BPs, etc).

Document and create a spec for the v1/history API