Add exchange integration docs #10054
Conversation
CriesofCarrots
force-pushed
the
add-exchange-doc
branch
from
f09dbc2 to
ee0c675
Compare
docs/src/integrations/exchange.md
Outdated
|
|
||
| Optional parameters to consider: | ||
| - `--limit-ledger-size` specifies how many ledger shreds to retain on disk. If you do not include this parameter, the ledger will keep the entire ledger until it runs out of disk space. A larger value like `--limit-ledger-size 250000000000` is good for a couple days | ||
| - `--trusted-validator` can protect you from booting from a malicious snapshot. [More on the value of booting with trusted validators](../running-validator/validator-start.md#trusted-validators) |
There was a problem hiding this comment.
For avoid missing parts of the ledger, I think we should mention --no-snapshot-fetch. Maybe have a whole section on ledger continuity?
There was a problem hiding this comment.
Added. Let me know if you have suggestions to make it more clear.
| If you need more information about the transaction type or other specifics, you | ||
| can request the block in binary format, and parse it using either our | ||
| [Rust SDK](https://github.com/solana-labs/solana/tree/master/sdk) or | ||
| [Javascript SDK](https://github.com/solana-labs/solana-web3.js). |
There was a problem hiding this comment.
FYI the javascript SDK doesn't support fetching binary blocks / transactions, but it does support decoding binary transactions
There was a problem hiding this comment.
I reworded the clause above to separate the request from the parsing. Let me know if that seems more clear.
| some SOL, they exist. To set up a deposit account for your exchange, simply | ||
| generate a Solana keypair using any of our [wallet tools](../wallet-guide/cli.md). | ||
|
|
||
| We recommend using a unique deposit account for each of your users. |
There was a problem hiding this comment.
We should mention that deposit accounts will be charged rent on first deposit and on epoch boundaries. Also, with eager rent collection, we will probably need a way to detect rent collections on accounts
There was a problem hiding this comment.
Related issue for listening to rent changes for accounts: #10085
There was a problem hiding this comment.
I'll mention rent. I don't think rent is collected strictly on epoch boundaries, incidentally, but I don't think the current state of rent is documented anywhere :(
It would be nice to have to link to from this section.
There was a problem hiding this comment.
Ugh, how about just creating a placeholder doc for rent that you can link to here, then a github issue for filling it in later
There was a problem hiding this comment.
Rent seemed like a natural continuation from app/README.md, so I put it first under that section, but doesn't seem consistent with the other pages in that menu. Open to other suggestions.
CriesofCarrots
force-pushed
the
add-exchange-doc
branch
from
f3e0394 to
e6239f9
Compare
CriesofCarrots
force-pushed
the
add-exchange-doc
branch
from
e6239f9 to
abcd11e
Compare
CriesofCarrots
force-pushed
the
add-exchange-doc
branch
3 times, most recently
from
9b6649e to
854bd6a
Compare
CriesofCarrots
force-pushed
the
add-exchange-doc
branch
from
854bd6a to
6927ece
Compare
|
yep, this is a great start, thanks |
* Add exchange integration doc * Round 1 review comments * Add rent stub doc * Pretty-print some things * Rework blockhash info, move offline signing * Add something to test section * Update blockhash/last-valid-slot info (cherry picked from commit 7d42d52)
* Add exchange integration doc * Round 1 review comments * Add rent stub doc * Pretty-print some things * Rework blockhash info, move offline signing * Add something to test section * Update blockhash/last-valid-slot info (cherry picked from commit 7d42d52)
* Add exchange integration doc * Round 1 review comments * Add rent stub doc * Pretty-print some things * Rework blockhash info, move offline signing * Add something to test section * Update blockhash/last-valid-slot info
Problem
Now that we have some integrations online, it would be helpful to collect our accrued knowledge and make it actionable for future integration projects.
Summary of Changes
Add integrations section, and exchange integration page
Would appreciate some feedback on content and format: @mvines @jstarry
Are the rpc and cli examples useful or clutter? I largely skimmed over the JS sdk; should I be more explicit there?
@garious @mvines , it sounded like you had some ideas for the Testing section. Could you let me know what you were thinking?