Commit Graph

1009 Commits

Author SHA1 Message Date
Callum McIntyre 16381d8f65
[docs] remove incorrect pubkey param from getEpochInfo (#31651)
Co-authored-by: Callum McIntyre <callum.mcintyre@solana.com>
2023-05-16 18:23:30 +00:00
Jordan Sexton 125a18550d
[docs] Add note about txids to signature status RPC method docs (#31628) 2023-05-12 20:16:16 -07:00
Dmitri Makarov c5905f525c
Update on-chain debugging docs following up changes in ledger-tool UI (#31593) 2023-05-12 06:34:51 -04:00
Dmitri Makarov 078304888d
Decommission rbpf-cli, replaced by solana-ledger-tool run subcommand (#31512) 2023-05-05 09:31:38 -07:00
Callum McIntyre 9b547fe9f8
[docs] add that loadedAddresses is undefined when using jsonParsed encoding (#31441)
- Applies to `getTransaction` and `getBlock` RPC calls
- This is intended because `accountKeys` already includes these addresses + lookupTable source. See https://github.com/solana-labs/solana/pull/31392#issuecomment-1527856367
2023-05-02 15:41:23 -05:00
Tyera 7474404539
Fix lockup docs (#31362) 2023-04-28 13:00:47 -06:00
sakridge f2befbb78e
Add note on how cargo build-bpf works (#30938) 2023-04-20 20:30:11 +02:00
Nick Frostbutter 26bec21d05
[docs] clarify logsSubscribe `mentions` param (#31225)
* fix: clarify logsSubscribe mentions param

* Update docs/src/api/websocket/_logsSubscribe.mdx

Co-authored-by: Tyera <teulberg@gmail.com>

* Update docs/src/api/websocket/_logsSubscribe.mdx

Co-authored-by: Tyera <teulberg@gmail.com>

---------

Co-authored-by: Tyera <teulberg@gmail.com>
2023-04-17 18:22:11 +00:00
kirill lykov 592b3ce17e
fix docs blockstore formatting (#31105)
* fix docs blockstore formatting

* Update docs/src/validator/blockstore.md

Co-authored-by: steviez <steven@solana.com>

* fix function signature in replay docs

Co-authored-by: steviez <steven@solana.com>

* update `get_slot_entries` function description in the docs

Co-authored-by: steviez <steven@solana.com>

* fix formatting

* remove new line in a doc

---------

Co-authored-by: steviez <steven@solana.com>
2023-04-14 12:13:28 +00:00
Nick Frostbutter 768405c410
[docs][ci] skip usage doc build for non-deploys (#31063)
* build: skip cli usage doc build for non-deploys

* fix: checking for CI

* chore: removed trailing whitespace

* fix: apease buildkite
2023-04-13 13:26:26 -05:00
Nick Frostbutter ac761dd9c0
[docs] added google analytics to docs (#31141)
* feat: added google analytics to docs

* docs: added comments
2023-04-11 14:35:40 -05:00
DimAn 622141c5eb
doc: typo in geyser plugin doc (#31125)
doc: typo
2023-04-10 17:28:34 -06:00
Charles Edward Gagnon 4a157446ac
Documentation typo in on-chain-programs/deploying.md (#31126)
Doc typo
2023-04-10 11:36:00 -05:00
dependabot[bot] 5f413db04f
Bump webpack from 5.74.0 to 5.78.0 in /docs (#31074)
Bumps [webpack](https://github.com/webpack/webpack) from 5.74.0 to 5.78.0.
- [Release notes](https://github.com/webpack/webpack/releases)
- [Commits](webpack/webpack@v5.74.0...v5.78.0)

---
updated-dependencies:
- dependency-name: webpack
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-04-06 14:27:55 -07:00
Andrew Fitzgerald 3a6d990d4c
[docs]: reduce header level (#31084) 2023-04-06 14:41:55 -05:00
Vide Krajnc d6051ba434
Update install-solana-cli-tools.md (#31080)
Fix typo in the linux asset name.
2023-04-06 11:27:25 -05:00
Nick Frostbutter 4564bcdc1a
[docs] state compression and compressed nfts (#31027)
* feat: added doc for state compression

* feat: added guide for compressed nfts

* fix: updates sidebar for new docs

* fix: added link to example repo

* fix: fixed typos

---------

Co-authored-by: nickfrosty <nick.frostbutter@solana.org>
2023-04-06 08:52:31 -05:00
Madhav Goyal 493efc5169
docs: Linking bankless-leader simd (#30790)
Added the link to simd so it shows up on the solana website if anyone looking to contribute.
2023-03-30 09:20:08 +02:00
Brennan 000b912fc6
Update discord invite links (#30909)
* Update discord invite links

* Point to Stack Exchange for support
2023-03-29 09:14:22 -07:00
Dmitri Makarov 81ef2a0d75
Update references to platform-tools (#30764) 2023-03-22 07:41:40 -07:00
Nick Frostbutter a131163904
fix: fixed and/or removed forum links (#30775)
* fix: fixed and/or removed forum links

Closes #29724

* fix: typo

---------

Co-authored-by: nickfrosty <nick.frostbutter@solana.org>
2023-03-20 13:58:41 -05:00
Nick Frostbutter f528335ac0
docs: prioritization fees (#30138)
* docs: updated prioritization fees docs

* fix: updated wording and removed outdated info

* docs: updated prioritization fees docs

* fix: merge fix

---------

Co-authored-by: nickfrosty <nick.frostbutter@solana.org>
2023-03-14 13:31:41 -05:00
mvines 94ef881de0
Update discord link in docs (#30670)
Update discord link
2023-03-10 12:09:28 -08:00
Steven Luscher 569c5fd9d6
[docs] Fix `dataSlice` definition (#30648)
* Repair incorrect definition for `dataSlice` in `getAccountInfo`

* Update all other occurrences of `dataSlice` in the docs
2023-03-08 19:54:33 -06:00
Steven Luscher 0c41c8ee1b
docs: fix order of positional `start_slot` and `end_slot` in `getBlocks` API docs (#30351) 2023-03-08 15:53:38 -08:00
Julien Catalano 4f3b71e173
[docs] Fix typos (#30640) 2023-03-08 13:25:23 +01:00
Dmitri Makarov 807f90ee8e
Document debugging on-chain programs (#30632) 2023-03-07 20:56:01 -05:00
Ikko Eltociear Ashimine 7ac3505b30
Fix typo in ledger.md (#30537)
explictly -> explicitly
2023-02-27 12:37:51 -08:00
Tao Zhu 66ea750182
add compute budget instruction to set loaded accounts data size limit (#30377)
* add compute budget instruction to set accounts data size limit

* changes names to explicitly for loaded accounts data size
2023-02-24 09:27:49 -06:00
Yihau Chen 17369dc8f0
ci: extract vercel scope as an env (#30441) 2023-02-23 11:58:08 +08:00
Andrew Fitzgerald 045b9fec11
Add --allow-private-addr to bootstrap-validator.sh (#30163)
* Add --allow-private-addr to bootstrap-validator.sh

* Remove --allow-private-addr argument option since it is default

* fix bench-tps docs, remove option for private-addr (default)
2023-02-22 09:54:15 -08:00
Trent Nelson 0487a4bd60
hide commonly misused `--no-port-check` validator arg (#30306) 2023-02-16 13:34:45 -07:00
steviez a09b044aa2
docs: Update on --limit-ledger-size and ledger disk usage (#30002)
The current documentation fails to call out that some items go under the
ledger directory by default. If this is the case, then the stated 500 GB
number will most certainly be exceeded.
2023-02-16 10:37:10 -06:00
Proph3t b9b7178f1f
TPU and TVU docs changes (#30301)
* docs: add tpu and tvu to terminology

* docs: add brief description to tvu doc
2023-02-15 17:34:32 -07:00
Tyera a020f3eb60
Add clarifying comments to SamplePerformanceService (#30296)
* Add clarifying comment

* Make jsonrpc docs more explicit
2023-02-15 10:02:53 -07:00
Nick Frostbutter 2dbe36e82a
docs - smaller logo image (#29775)
fix: smaller logo image
2023-02-13 17:21:31 -06:00
Nick Frostbutter 54416451f6
docs - new homepage (#29793)
* refactor: new home page

* refactor: line lengths and meta description

* docs: removed text section

* refactor: links label and comments

* chore: removed comment

* refactor: removed page
2023-02-13 17:00:11 -06:00
Trent Nelson 2decc5275c
Proposal for off-chain message signing (#26915)
docs: add proposal for off-chain message signing
2023-02-13 11:16:21 -07:00
Nick Frostbutter 4a10ebdf0b
[docs] style: prettier force line length to 80 chars (#30133) 2023-02-09 03:23:21 +00:00
Nick Frostbutter ae59195ed0
[docs] fix: rpc api redirect (#30212) 2023-02-08 20:40:05 -06:00
omahs 70d6614b50
Fix: typos (#30141) 2023-02-06 10:04:46 -07:00
Brennan b29a50a55e
Exclude loopback from valid IP addresses (#29992)
Excludes loopback IP addresses from being valid IP addresses unless private addresses are explicitly allowed
2023-02-01 11:16:15 -08:00
steviez 9b13b90066
Add backwards compatibility clarification on CLI tooling output (#29961)
Json output should remain consistent to avoid breaking automation;
however, we want to be free to update human-reader-centric output to
remove output as it becomes deprecated.
2023-01-30 12:14:25 -06:00
Brennan c1aac6d430
Update turbine documentation (#29906)
* Update turbine text, fix typos, shuffle organization, update diagrams, and fix error rate calculations
2023-01-27 08:09:41 -08:00
Nick Frostbutter 9b270020f6
[docs] new JSON RPC API docs format (#29772)
* feat: added api page

* fix: api redirects

* feat: websocket page and partials

* feat: deprectated partials

* feat: http method partials

* fix: more deprecated partials

* feat: codeblock component and styles

* feat: api http methods page

* feat: sidebar

* refactor: proposal api links

* refactor: internal linking

* refactor: more internal links

* refactor: internal link and note cards

* refactor: local links

* refactor: local links and auto save prettier

* feat: added numNonVoteTransaction data details

* fix: updated getRecentPrioritizationFees

* fix: corrected wording

* fix: version typo

* fix: commitment links

* fix: parsed response links

* fix: dangling links

* refactor: filter criteria

* docs: removed jsonrpc-api.md file

* fix: dangling links

* style: removed whitespaces for CI

* style: removed whitespace

* style: fixed whitespaces
2023-01-26 17:14:47 -06:00
aditya-solana 62312f95a9
Mention that the document is stale. (#29769) 2023-01-19 07:37:17 -08:00
Illia Bobyr 6e4ecc6758
RPC getPerformanceSamples: Add `numNonVoteTransaction` (#29388)
Allow interested parties to see both total and non-vote transaction
counts in each performance sample.

Fixes https://github.com/solana-labs/solana/issues/29159
2023-01-18 00:22:47 -08:00
Nick Frostbutter 29ed19c5e0
docs: updated readme (#29561) 2023-01-17 22:14:05 -06:00
Nick Frostbutter 1345e89507
docs: update Docusaurus to v2.2 (#29563)
* build: update docusaurus

* fix: algolia keys

* fix: frontmatter keywords array

* build: clsx version

* fix: card layout and pages

* fix: invalid internal link
2023-01-17 22:13:10 -06:00
Tao Zhu 1d88654116
Revert "Cap accounts data a transaction can load by its requested limit" (#29373)
Revert "Cap accounts data a transaction can load by its requested limit (#27840)"

This reverts commit 81dc2e56ac.
2023-01-17 11:34:18 +01:00
Tyera 05594c6996
getRecentPrioritizationFees docs: make clear that fee is per compute-unit (#29702)
Make clear that fee is per compute-unit
2023-01-13 13:25:55 -07:00
Tyera 451fbfee2e
Update getRecentPrioritizationFees json-rpc docs (#29666)
* Update getRecentPrioritizationFees json-rpc docs

* Address review feedback

* Remove minimum
2023-01-11 23:17:32 -07:00
kirill lykov 5d18a5c738
replaced ./cargo with cargo in build docs (#29375) 2022-12-28 00:52:49 +01:00
Nick Frostbutter d8da242e5e
docs: transactions fees/confirmation and deploying programs (#28895)
docs: adds and updates
2022-12-21 22:51:49 -06:00
Nick Frostbutter 12de7637f1
[docs] Updated transactions overview page (#29345)
fix: added broad overview
2022-12-21 22:38:47 -06:00
Nick Frostbutter 5918d6f09d
[docs] updating the "writing programs" section (#29197)
* docs: added limitations page

* fix: updated deprecated cargo test-bpf

* docs: moved content off of overview

* fix: added compute budget description

* fix: updated compute buddget

* fix: rearranged sections

* fix: update code snippet

* docs: overview page and links
2022-12-21 22:27:10 -06:00
gr8den a0b655b72b
fix typo in runtime docs (#29314) 2022-12-17 11:01:46 -07:00
Brooks Prumo 426be3d82d
docs: Accounts must be rent exempt (#29256) 2022-12-16 13:14:01 -05:00
Brooks Prumo 94b04935c8
docs: Wraps to 80 characters (#29259) 2022-12-14 15:14:59 -05:00
Tyera 28d8b072c9
Update filter docs, v1.11 -> v1.14 (#29017)
v1.11 -> v1.14
2022-12-01 15:55:58 -07:00
Alexander Meißner 73e55a184b
Adjusts docs about changing the data, size and balance of accounts. (#29007) 2022-12-01 19:42:34 +01:00
Jacob Creech 57798fae9c
Docs: Removed Serum RPC mention (#28854) 2022-11-17 12:45:21 -06:00
Brooks Prumo c1e440acb6
Warping calculates and sets new EAH (#28809) 2022-11-15 23:16:38 -05:00
Brooks Prumo d798e751a0
Disables EAH with short epochs (#28803) 2022-11-15 13:26:19 -05:00
Brooks Prumo 503da50f2c
Verifies EAH in SnapshotHash (#28775) 2022-11-14 16:02:08 -05:00
Tao Zhu 81dc2e56ac
Cap accounts data a transaction can load by its requested limit (#27840)
- Add new compute-budget instruction to set transaction-wide accounts data size limit
- Set default accounts data limit to 10MB, and max to 100MB, per transaction;
- Add getters to make changing default and/or max values easier in the future with feature gates;
- added error counter for transactions exceed data size limit
2022-11-14 10:29:35 -06:00
Dmitri Makarov 34865d032c chore: update Solana docs and code comments that specify "BPF" to "SBF" 2022-10-31 14:14:25 -04:00
Brooks Prumo 76598dbddb
proposal: Epoch Accounts Hash (#27801) 2022-10-28 10:16:35 -04:00
bji c0f1ffb9d3
Minor typo fix. (#28583) 2022-10-26 09:07:35 -10:00
HaoranYi 74bd87d847
Add vote section in reward proposal (#28587)
* add vote section in reward proposal

* edits

* Update docs/src/proposals/partitioned-inflationary-rewards-distribution.md

Co-authored-by: Trent Nelson <trent.a.b.nelson@gmail.com>

* Update docs/src/proposals/partitioned-inflationary-rewards-distribution.md

Co-authored-by: Trent Nelson <trent.a.b.nelson@gmail.com>

Co-authored-by: Trent Nelson <trent.a.b.nelson@gmail.com>
2022-10-25 16:34:53 -05:00
Nick Frostbutter 2090ad0c2e
[docs] corrected use of confirmTransaction in examples (#28547)
fix: updated method calls
2022-10-24 16:49:47 -05:00
Ikko Ashimine ff18bb3a06
Fix typo in restart-cluster.md (#28538)
occurence -> occurrence
2022-10-22 04:02:07 +08:00
sakridge b6f5cc6ebf
Update TVU with transaction status service (#28505)
There is no storage stage
2022-10-21 14:37:30 +02:00
sakridge 580b4f81bf
Fix optimistic concurrency control link (#28534) 2022-10-21 14:26:58 +02:00
Justin Starry 199398d5c4
Rename transaction v2 proposal (#28508)
Rename transactions v2 proposal to clear up versioning
2022-10-21 09:29:22 +08:00
bji a2e1228c1f
proposal: Added timely vote credits proposal. (#28162)
Added timely vote credits proposal.
2022-10-20 22:46:47 +00:00
Steven Luscher 7146220539
chore: update Docusaurus deps to latest available (#28514) 2022-10-20 13:54:26 -07:00
Justin Starry 58e27d45dc
RPC: respect data slice config if account parsing fails (#28387)
* RPC: respect data slice config if account parsing fails

* Remove check_slice_and_encoding method
2022-10-19 16:49:12 +08:00
Brahma f58c6c7c76
docs: improve transaction fee documentation (#28425)
* docs: clean up transaction fee page

- fix a few typos & sentence fragments
- try to simplify the explanation around burned fees

* more semantic optimization
2022-10-18 15:47:57 +00:00
Justin Starry 438d96e499
RPC: Return the data length for get account requests (#28421) 2022-10-18 01:56:04 +08:00
Justin Starry 70445b7402
Refactor: Rename `max_invoke_depth` to `max_invoke_stack_height` (#28427)
Refactor: Rename max_invoke_depth to max_invoke_stack_height
2022-10-17 23:54:56 +08:00
Alexey Skibin 108a02cfd4
Add off-chain messages support (#27456) 2022-10-17 11:19:12 -04:00
Satyam Bansal c5e59a081c
Fix Grammatical mistake on Get Started documentation page (#28347)
Fix Grammatical mistake

Fix Grammatical mistake on Get started page
2022-10-12 16:50:19 +00:00
Yihau Chen 4cbf59a5dd
docs: fix exchanges integration (#28315)
* fix description

* get blocks use devnet data
2022-10-10 05:03:44 +00:00
Dmitri Makarov f4dd24491f Migrate SDK from BPF to SBF 2022-10-07 08:57:06 -04:00
Yihau Chen c10c2f80d0
docs: use devnet blocks and transactions as v0 transaction examples (#28288) 2022-10-07 08:53:04 +00:00
HaoranYi 6eeedaec4f
[Proposal ]Partitioned Inflationary Rewards Distribution (#27455)
* add epoch-boundary-stake-reward proposal

* 80 col

* clarify rewarding interval selection for skipping slots

* update proposal with reward credit based on jeff's comments

* Update docs/src/proposals/epoch-boundary-stake-reward.md

Co-authored-by: Trent Nelson <trent.a.b.nelson@gmail.com>

* Update docs/src/proposals/epoch-boundary-stake-reward.md

Co-authored-by: Trent Nelson <trent.a.b.nelson@gmail.com>

* rename

* update proposal with more feedbacks

* revise

* update with carl's feedback

* use mathmatic notation to clarify interval boundaries

* more feedbacks

* remove parenthesis

* update snapshot paragraph

* update with reward calc service

* more feedbacks

* update with more feedbacks

* more feedbacks from carllin

Co-authored-by: Trent Nelson <trent.a.b.nelson@gmail.com>
2022-10-06 14:26:47 -05:00
Michael Vines eea1d3a088
Update restart guide to include the use of `solana-ledger-tool latest-optimistic-slots` (#28267) 2022-10-06 10:54:39 -07:00
Jon Cinque 0aea2da091
docs: Update node build version to v16 (#28264) 2022-10-06 19:25:18 +02:00
Kartik Soneji c7c67f010b
docs: Better install command for Windows (#28138)
Pass install command to `cmd` on Windows
2022-10-06 12:38:48 +02:00
Abraar 8d3e924dd2
Fix typo in Versioned Transactions (#28213) 2022-10-04 08:29:24 +00:00
acheron 83f9c14d5c
docs: Rewrite the Quick Start guide to rely exclusively on playground (#28101)
* Update hello world docs client part

* Sign the transaction with playground wallet keypair

* Remove unused explorer image
2022-10-03 20:52:50 -05:00
Michael Vines df5f9f698f Surface the getVoteAccounts.epochCredits max-length constant in rpc-client-api 2022-09-26 21:58:19 -07:00
Nick Frostbutter c893f92508
[docs] versioned transactions and lookup tables (#28060)
* feat: added versioned transaction and ALT docs

* fix: relocated links and fixed sidebar parser
2022-09-27 07:16:18 +08:00
Alexander Meißner 71aee4fcaf
Feature: Explicitly limit `TransactionContext::instruction_trace_capacity` (#27938)
* Renames instruction_stack_capacity => instruction_stack_capacity.

* Replaces number_of_instructions_at_transaction_level by instruction_trace_capacity.

* Adds MaxInstructionTraceLengthExceeded.

* Adjusts TransactionContext::new() parameter.

* Adds feature gate limit_max_instruction_trace_length.

* Adds test_max_instruction_trace_length().
2022-09-26 10:47:16 +02:00
steviez 0a0d31e5fb
Add missing rootSlot documentation (#27709) 2022-09-22 14:59:31 -05:00
Justin Starry 91d556dc66
docs: Add versioned tx info to exchange integration guide (#27564)
* docs: Add versioned tx info to exchange integration guide

* feedback, extra tips, formatting
2022-09-22 14:19:36 +08:00
Tyera Eulberg fa0550da32
Add missing fields to JSON-RPC docs (#27964)
* Add docs for computeUnitsConsumed field

* Add confirmationStatus to getSignaturesForAddress response docs

* Make field-type formatting consistent
2022-09-21 11:59:30 -06:00
Will Hickey 8f96a39e73
Remove markdown file update from version increment-cargo-version.sh (#27851)
* Remove markdown file update from version increment-cargo-version.sh
* Update doc version numbers that were incorrectly advanced by increment-cargo-version.sh
* Revert incorrect doc change based on review feedback
2022-09-19 16:37:50 -05:00
Brian Anderson 0c1ff7c63d
Document the pubsub client APIs. (#27188)
* Document the pubsub client APIs.

* Apply suggestions from code review

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>

* Update client/src/nonblocking/pubsub_client.rs

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>

* Update pubsub_client docs

* Link pubsub docs to solana-rpc docs

* fmt

* Update solana_client references

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>
Co-authored-by: Tyera Eulberg <tyera@solana.com>
2022-09-15 16:39:16 -06:00