Skip to content
This repository has been archived by the owner on Feb 26, 2024. It is now read-only.

Improve interactive docs #878

Merged
merged 148 commits into from
Aug 4, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
148 commits
Select commit Hold shift + click to select a range
ef25bbc
add eth_accounts example
eshaben Feb 19, 2021
4f4bdb7
add eth_blockNumber example
eshaben Feb 19, 2021
beecd14
add eth_call example
eshaben Feb 19, 2021
57428fc
add eth_coinbase example
eshaben Feb 19, 2021
cccdf68
update docs after rebase changes
eshaben Feb 26, 2021
79c3260
update eth_call parameter descriptions
eshaben Feb 26, 2021
4c7eb04
add params and example to eth_estimateGas docs
eshaben Feb 26, 2021
9d1d0e8
add example to eth_gasPrice
eshaben Feb 26, 2021
bd27bc2
add returns and example to eth_getBalance
eshaben Feb 26, 2021
1ff6ed2
update hash param description and add example to eth_getBlockByHash
eshaben Feb 26, 2021
1ebc6d8
add example to eth_getBlockByNumber
eshaben Feb 26, 2021
262cf51
add returns description and example to eth_getBlocktransactionCountBy…
eshaben Feb 26, 2021
4eaa085
add returns description and example to eth_getBlocktransactionCountBy…
eshaben Feb 26, 2021
523a67c
add example to eth_getCode
eshaben Feb 26, 2021
5590cf8
add description, return description and example for eth_getCompilers
eshaben Feb 26, 2021
3562e60
add example for eth_newBlockFilter
eshaben Feb 26, 2021
50edc8c
add example for eth_newFilter
eshaben Feb 26, 2021
db835e8
add example for eth_newPendingTransactionFilter
eshaben Feb 26, 2021
00dea61
add example for eth_getFilterChanges
eshaben Feb 26, 2021
ad7907f
add param and example for eth_getFilterLogs
eshaben Feb 26, 2021
dd32673
update params and returns for eth_getStorageAt
eshaben Feb 26, 2021
615cec4
add example for eth_getStorageAt
eshaben Feb 26, 2021
9b0000c
add example for eth_getLogs
eshaben Feb 26, 2021
901a79e
add example for eth_getTransactionByBlockHashAndIndex
eshaben Feb 27, 2021
585e4a0
add returns description and example for eth_getTransactionByBlockNumb…
eshaben Feb 27, 2021
e91bb2b
add returns description for eth_getTransactionByBlockHashAndIndex
eshaben Feb 27, 2021
5440dab
add returns description and example for eth_getTransactionByHash
eshaben Feb 27, 2021
f1e7c22
add address description and example for eth_getTransactionCount
eshaben Feb 27, 2021
c03cc3e
add example for eth_getTransactionReceipt
eshaben Feb 27, 2021
a173657
add example for eth_hashrate
eshaben Feb 27, 2021
7b5178e
add example for eth_mining
eshaben Feb 27, 2021
dcb306f
add example for eth_protocolVersion
eshaben Feb 27, 2021
7967046
add param description for eth_sendRawTransaction
eshaben Feb 27, 2021
50a0261
add param description and example for eth_sendTransaction
eshaben Feb 27, 2021
c19931b
add param descriptions and example for eth_sign
eshaben Mar 2, 2021
d6b2bb7
update returns descriptions for eth_sign
eshaben Mar 2, 2021
5e25f32
add example for eth_signTypedData
eshaben Mar 2, 2021
4659173
add example for eth_submitHashrate
eshaben Mar 2, 2021
a18b769
add example for eth_submitWork
eshaben Mar 2, 2021
88b81be
update param descriptions and add example for eth_subscribe
eshaben Mar 2, 2021
419395c
add example for eth_syncing
eshaben Mar 2, 2021
9f22ceb
add params desc, returns desc, and example for eth_unsubscribe
eshaben Mar 2, 2021
1a5b01f
add example for evm_increaseTime
eshaben Mar 2, 2021
9429baf
add example for evm_lockUnknownAccount
eshaben Mar 2, 2021
fabf524
add example for evm_unlockUnknownAccount
eshaben Mar 2, 2021
555a9d9
remove unnecessary second example from evm_mine
eshaben Mar 2, 2021
2a62cdf
remove unnecessary second example from evm_revert
eshaben Mar 2, 2021
d085336
add example for evm_setAccountNonce
eshaben Mar 2, 2021
c4599b1
create initial entry for evm_setStorageAt
eshaben Mar 2, 2021
91fd45d
add example for evm_setTime
eshaben Mar 2, 2021
3732e64
remove unnecessary second example from evm_snapshot
eshaben Mar 2, 2021
6864c56
add example for web3_clientVersion
eshaben Mar 2, 2021
249979b
add example for web3_sha3
eshaben Mar 2, 2021
5d1a2eb
add basic description for bzz methods
eshaben Mar 2, 2021
5ea2f76
remove console.log
eshaben Mar 2, 2021
de6ff56
create initial example for debug_storageRangeAt
eshaben Mar 2, 2021
dc3cee2
add params and returns description, and example for miner_setEtherbase
eshaben Mar 2, 2021
a2de637
add params and returns description, and example for miner_setExtra
eshaben Mar 2, 2021
0e6d99f
update desc and param desc, add returns desc and example for miner_se…
eshaben Mar 2, 2021
3911da8
add params description and example for miner_start
eshaben Mar 2, 2021
8f246c1
add example for miner_stop
eshaben Mar 2, 2021
6a040df
add example for net_listening
eshaben Mar 2, 2021
ef31978
add example for net_peerCount
eshaben Mar 2, 2021
9993b58
add example for net_version
eshaben Mar 2, 2021
15a9983
add initial entry for rpc_modules
eshaben Mar 2, 2021
3afe12f
add example for personal_listAccounts
eshaben Mar 2, 2021
1043af5
add initial example for personal_newAccount
eshaben Mar 2, 2021
f7b12cf
add example for db_putString
eshaben Mar 3, 2021
57b181e
add example for db_putHex
eshaben Mar 3, 2021
d940ac1
add example for db_getString
eshaben Mar 3, 2021
f8976dd
add example for db_getHex
eshaben Mar 3, 2021
c70d24c
add param descriptions and example for personal_importRawKey
eshaben Mar 3, 2021
58aff79
add params and returns description, and example for personal_lockAccount
eshaben Mar 3, 2021
dae029c
add example for personal_unlockAccount
eshaben Mar 3, 2021
3b34243
clean up and fix typo in personal_newAccount
eshaben Mar 3, 2021
decd98c
add params and returns description, and example for personal_sendTran…
eshaben Mar 3, 2021
0db17f7
add example for shh_newIdentity
eshaben Mar 3, 2021
ca27f2a
add example for shh_addToGroup
eshaben Mar 3, 2021
43d6452
add example for shh_newFilter
eshaben Mar 3, 2021
fc3b0d8
add example for shh_getFilterChanges
eshaben Mar 3, 2021
9512ba8
add example for shh_uninstallFilter
eshaben Mar 3, 2021
fc55a28
add example for shh_getMessages
eshaben Mar 3, 2021
d939f64
add example for shh_hasIdentity
eshaben Mar 3, 2021
7fb7546
add example for shh_post
eshaben Mar 3, 2021
a3b573b
add example for shh_version
eshaben Mar 3, 2021
dda2d2f
add examples for bzz methods
eshaben Mar 3, 2021
8be847a
add returns description and examples for eth_getUncleCountByBlockHash
eshaben Mar 3, 2021
e7816fb
add returns description and examples for eth_getUncleCountByBlockNumber
eshaben Mar 3, 2021
cde915b
add returns description and examples for eth_getUncleByBlockHashAndIndex
eshaben Mar 3, 2021
d91207e
add returns description and examples for eth_getUncleByBlockNumberAnd…
eshaben Mar 3, 2021
8b8660c
add example for eth_getWork
eshaben Mar 3, 2021
e6d88d3
add example for eth_sendRawTransaction
eshaben Mar 3, 2021
c605df8
use consistent capitalization and punctuation
eshaben Mar 3, 2021
bd714af
add more detail to debug_traceTransaction returns description
eshaben Mar 3, 2021
2f53587
fix formatting of transaction call object
eshaben Mar 3, 2021
77be765
fix formatting of return syncing data for eth_syncing
eshaben Mar 3, 2021
66b2692
use consistent object formatting
eshaben Mar 3, 2021
8765b1b
add transaction object and description for returns
eshaben Mar 3, 2021
8c9253f
add block object description
eshaben Mar 3, 2021
e3ce710
add quantity and data tags to eth methods
eshaben Mar 3, 2021
3b29b7c
add block object description in a couple more places
eshaben Mar 3, 2021
16f5312
wrap DATA tags in backticks
eshaben Mar 3, 2021
e1d7cdc
add filter object description
eshaben Mar 3, 2021
c9cb395
fill out returns more thoroughly for eth_getFilterChanges
eshaben Mar 3, 2021
3472db8
create types for data and quantity
eshaben Mar 4, 2021
6c8576b
update api to use data and quantity types
eshaben Mar 4, 2021
7c76d01
keep docs in sync with type changes to api
eshaben Mar 4, 2021
fd9e196
remove types from params
eshaben Mar 4, 2021
9641624
Merge branch 'develop' of github.com:trufflesuite/ganache-core into c…
eshaben Mar 4, 2021
38020f5
keep docs in sync with changes from merge
eshaben Mar 4, 2021
080b8e4
update return type for storageRangeAt
eshaben Mar 4, 2021
03c330d
move trace transaction types to their own file
eshaben Mar 4, 2021
c2fca8f
keep docs in sync with changes to trace transaction return type
eshaben Mar 4, 2021
8ec861f
use consistent formatting in code blocks
eshaben Mar 4, 2021
3d48419
display QUANTITY and DATA for return types
eshaben Mar 5, 2021
0517417
update evm_setStorageAt example
eshaben Mar 5, 2021
b61e61f
fix eth_sendTransaction example
eshaben Mar 5, 2021
177f4ba
update eth_getFilterChanges example
eshaben Mar 5, 2021
6123103
update eth_getLogs and eth_getFilterLogs example
eshaben Mar 5, 2021
aa3b846
add transactionHash description to return logs object
eshaben Mar 5, 2021
a67d75a
fix eth_unsubscribe example
eshaben Mar 5, 2021
a8093f1
update TODOs
eshaben Mar 5, 2021
ce22839
remove unused import
eshaben Mar 5, 2021
2e20caa
display TAG for method signature and args
eshaben Mar 5, 2021
95c23fa
remove console.log
eshaben Mar 5, 2021
057fe83
Merge branch 'develop' of github.com:trufflesuite/ganache-core into c…
eshaben Mar 11, 2021
58f8799
build recent changes so debug_storageRangeAt example now works
eshaben Mar 12, 2021
f7b245c
create mobile first layout
eshaben Mar 19, 2021
22bde5a
Fix eth_estimateGas in interactive docs
MicaiahReid May 27, 2021
5160270
Fix personal namespace issues in interactive docs
MicaiahReid May 28, 2021
c29f579
Merge branch 'develop' into chore/improve-interactive-docs
MicaiahReid May 28, 2021
bef05cf
More merging of develop into chore/improve-interactive-docs
MicaiahReid May 28, 2021
d75236a
Add eth_signTransaction to interactive docs
MicaiahReid Jun 2, 2021
ad4863f
Use signed tx in eth_sendRawTransaction call
MicaiahReid Jun 2, 2021
e8f62fd
Fix evm_revert and evm_snapshot examples
MicaiahReid Jun 2, 2021
9c6e88b
Remove evm_setStorageAt
MicaiahReid Jun 2, 2021
f86bbf2
Add personal_signTransaction
MicaiahReid Jun 2, 2021
2e0ccc5
Remove check on gas for eth_signTransaction
MicaiahReid Jun 3, 2021
ab1f7e4
add gas to eth_sendRawTransaction example
MicaiahReid Jun 3, 2021
780f8ba
Add test for eth_signTransaction
MicaiahReid Jun 3, 2021
be93c54
Add test for personal_signTransaction
MicaiahReid Jun 3, 2021
a1af9cb
Expand tests for eth_sendRawTransaction
MicaiahReid Jun 3, 2021
e221671
Update src/chains/ethereum/ethereum/src/api.ts
MicaiahReid Jun 15, 2021
dacaddd
Update src/chains/ethereum/ethereum/src/api.ts
MicaiahReid Jun 15, 2021
cadb580
Update src/chains/ethereum/ethereum/src/api.ts
MicaiahReid Jun 15, 2021
fb6ec4f
Remove todo
MicaiahReid Jun 15, 2021
55279ed
Merge branch 'develop' into chore/improve-interactive-docs
davidmurdoch Aug 3, 2021
cc89927
.
davidmurdoch Aug 3, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 55 additions & 3 deletions docs/assets/css/main.css
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,24 @@ a:focus {
color: var(--turquoise);
text-decoration: underline;
}
i {
font-size: 1.25em;
cursor: pointer;
}
.sidebar {
display: block;
height: 100%;
width: 100%;
position: fixed;
z-index: 2;
background: var(--main-bg-color);
overflow-x: scroll;
padding-left: 1em;
transition: 0.3s ease-in-out;
}
.hide {
display: none;
}
.small {
font-size: 0.9em;
}
Expand Down Expand Up @@ -107,7 +125,7 @@ a:focus {
padding: 0.25em 0.5em;
cursor: pointer;
border-radius: 0 0 3px 3px;
z-index: 1000;
z-index: 1;
text-transform: uppercase;
box-shadow: 0 1px 5px rgba(0, 0, 0, 0.3);
position: absolute;
Expand All @@ -118,7 +136,7 @@ a:focus {
}
.editor-container {
position: relative;
z-index: 999;
z-index: 0;
}
.editor-container::before {
content: " ";
Expand Down Expand Up @@ -186,6 +204,12 @@ header {
box-shadow: 0 6px 6px rgba(0, 0, 0, 0.25);
z-index: 999;
}
header h1 {
display: inline-block;
}
header span {
padding-left: 1em;
}
main {
display: flex;
overflow: auto;
Expand All @@ -196,7 +220,7 @@ aside {
}
aside ul {
list-style: none;
padding-left: 1.5rem;
padding: 0 0 2rem 0;
margin: 1rem 0;
}
aside ul li {
Expand All @@ -212,3 +236,31 @@ article div.content {
article div.wide-content {
padding: 0 0;
}
article.sidebar-open {
transition: 0.3s ease-in-out;
}
/* medium devices (tablets) */
@media (min-width: 768px) {
.sidebar {
width: 33.3%;
}
article.sidebar-open {
margin-left: 33.3%;
}
}
/* large devices (desktops) */
@media (min-width: 992px) {
header span {
display: none;
}
.sidebar {
width: 25%;
display: block;
}
article {
margin-left: 25%;
}
article.sidebar-open {
margin-left: 25%;
}
}
2 changes: 1 addition & 1 deletion docs/assets/js/ganache/ganache.min.js.map

Large diffs are not rendered by default.

2,247 changes: 1,921 additions & 326 deletions docs/index.html

Large diffs are not rendered by default.

Loading