api.js 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502
  1. module.exports = {
  2. apiSidebar: [
  3. {
  4. type: "link",
  5. href: "/api",
  6. label: "JSON RPC API",
  7. },
  8. {
  9. type: "doc",
  10. id: "api/http",
  11. label: "HTTP Methods",
  12. },
  13. {
  14. type: "doc",
  15. id: "api/websocket",
  16. label: "Websocket Methods",
  17. },
  18. ],
  19. apiHttpMethodsSidebar: [
  20. {
  21. type: "link",
  22. href: "/api",
  23. label: "JSON RPC API",
  24. },
  25. {
  26. type: "doc",
  27. id: "api/websocket",
  28. label: "Websocket Methods",
  29. },
  30. {
  31. type: "category",
  32. link: { type: "doc", id: "api/http" },
  33. label: "HTTP Methods",
  34. collapsed: false,
  35. items: [
  36. {
  37. type: "link",
  38. href: "#getaccountinfo",
  39. label: "getAccountInfo",
  40. },
  41. {
  42. type: "link",
  43. href: "#getbalance",
  44. label: "getBalance",
  45. },
  46. {
  47. type: "link",
  48. href: "#getblockheight",
  49. label: "getBlockHeight",
  50. },
  51. {
  52. type: "link",
  53. href: "#getblock",
  54. label: "getBlock",
  55. },
  56. {
  57. type: "link",
  58. href: "#getblockproduction",
  59. label: "getBlockProduction",
  60. },
  61. {
  62. type: "link",
  63. href: "#getblockcommitment",
  64. label: "getBlockCommitment",
  65. },
  66. {
  67. type: "link",
  68. href: "#getblocks",
  69. label: "getBlocks",
  70. },
  71. {
  72. type: "link",
  73. href: "#getblockswithlimit",
  74. label: "getBlocksWithLimit",
  75. },
  76. {
  77. type: "link",
  78. href: "#getblocktime",
  79. label: "getBlockTime",
  80. },
  81. {
  82. type: "link",
  83. href: "#getclusternodes",
  84. label: "getClusterNodes",
  85. },
  86. {
  87. type: "link",
  88. href: "#getepochinfo",
  89. label: "getEpochInfo",
  90. },
  91. {
  92. type: "link",
  93. href: "#getepochschedule",
  94. label: "getEpochSchedule",
  95. },
  96. {
  97. type: "link",
  98. href: "#getfeeformessage",
  99. label: "getFeeForMessage",
  100. },
  101. {
  102. type: "link",
  103. href: "#getfirstavailableblock",
  104. label: "getFirstAvailableBlock",
  105. },
  106. {
  107. type: "link",
  108. href: "#getgenesishash",
  109. label: "getGenesisHash",
  110. },
  111. {
  112. type: "link",
  113. href: "#gethealth",
  114. label: "getHealth",
  115. },
  116. {
  117. type: "link",
  118. href: "#gethighestsnapshotslot",
  119. label: "getHighestSnapshotSlot",
  120. },
  121. {
  122. type: "link",
  123. href: "#getidentity",
  124. label: "getIdentity",
  125. },
  126. {
  127. type: "link",
  128. href: "#getinflationgovernor",
  129. label: "getInflationGovernor",
  130. },
  131. {
  132. type: "link",
  133. href: "#getinflationrate",
  134. label: "getInflationRate",
  135. },
  136. {
  137. type: "link",
  138. href: "#getinflationreward",
  139. label: "getInflationReward",
  140. },
  141. {
  142. type: "link",
  143. href: "#getlargestaccounts",
  144. label: "getLargestAccounts",
  145. },
  146. {
  147. type: "link",
  148. href: "#getlatestblockhash",
  149. label: "getLatestBlockhash",
  150. },
  151. {
  152. type: "link",
  153. href: "#getleaderschedule",
  154. label: "getLeaderSchedule",
  155. },
  156. {
  157. type: "link",
  158. href: "#getmaxretransmitslot",
  159. label: "getMaxRetransmitSlot",
  160. },
  161. {
  162. type: "link",
  163. href: "#getmaxshredinsertslot",
  164. label: "getMaxShredInsertSlot",
  165. },
  166. {
  167. type: "link",
  168. href: "#getminimumbalanceforrentexemption",
  169. label: "getMinimumBalanceForRentExemption",
  170. },
  171. {
  172. type: "link",
  173. href: "#getmultipleaccounts",
  174. label: "getMultipleAccounts",
  175. },
  176. {
  177. type: "link",
  178. href: "#getprogramaccounts",
  179. label: "getProgramAccounts",
  180. },
  181. {
  182. type: "link",
  183. href: "#getrecentperformancesamples",
  184. label: "getRecentPerformanceSamples",
  185. },
  186. {
  187. type: "link",
  188. href: "#getrecentprioritizationfees",
  189. label: "getRecentPrioritizationFees",
  190. },
  191. {
  192. type: "link",
  193. href: "#getsignaturesforaddress",
  194. label: "getSignaturesForAddress",
  195. },
  196. {
  197. type: "link",
  198. href: "#getsignaturestatuses",
  199. label: "getSignatureStatuses",
  200. },
  201. {
  202. type: "link",
  203. href: "#getslot",
  204. label: "getSlot",
  205. },
  206. {
  207. type: "link",
  208. href: "#getslotleader",
  209. label: "getSlotLeader",
  210. },
  211. {
  212. type: "link",
  213. href: "#getslotleaders",
  214. label: "getSlotLeaders",
  215. },
  216. {
  217. type: "link",
  218. href: "#getstakeactivation",
  219. label: "getStakeActivation",
  220. },
  221. {
  222. type: "link",
  223. href: "#getstakeminimumdelegation",
  224. label: "getStakeMinimumDelegation",
  225. },
  226. {
  227. type: "link",
  228. href: "#getsupply",
  229. label: "getSupply",
  230. },
  231. {
  232. type: "link",
  233. href: "#gettokenaccountbalance",
  234. label: "getTokenAccountBalance",
  235. },
  236. {
  237. type: "link",
  238. href: "#gettokenaccountsbydelegate",
  239. label: "getTokenAccountsByDelegate",
  240. },
  241. {
  242. type: "link",
  243. href: "#gettokenaccountsbyowner",
  244. label: "getTokenAccountsByOwner",
  245. },
  246. {
  247. type: "link",
  248. href: "#gettokenlargestaccounts",
  249. label: "getTokenLargestAccounts",
  250. },
  251. {
  252. type: "link",
  253. href: "#gettokensupply",
  254. label: "getTokenSupply",
  255. },
  256. {
  257. type: "link",
  258. href: "#gettransaction",
  259. label: "getTransaction",
  260. },
  261. {
  262. type: "link",
  263. href: "#gettransactioncount",
  264. label: "getTransactionCount",
  265. },
  266. {
  267. type: "link",
  268. href: "#getversion",
  269. label: "getVersion",
  270. },
  271. {
  272. type: "link",
  273. href: "#getvoteaccounts",
  274. label: "getVoteAccounts",
  275. },
  276. {
  277. type: "link",
  278. href: "#isblockhashvalid",
  279. label: "isBlockhashValid",
  280. },
  281. {
  282. type: "link",
  283. href: "#minimumledgerslot",
  284. label: "minimumLedgerSlot",
  285. },
  286. {
  287. type: "link",
  288. href: "#requestairdrop",
  289. label: "requestAirdrop",
  290. },
  291. {
  292. type: "link",
  293. href: "#sendtransaction",
  294. label: "sendTransaction",
  295. },
  296. {
  297. type: "link",
  298. href: "#simulatetransaction",
  299. label: "simulateTransaction",
  300. },
  301. ],
  302. },
  303. // {
  304. // type: "category",
  305. // label: "Unstable Methods",
  306. // collapsed: true,
  307. // items: [
  308. // {
  309. // type: "link",
  310. // href: "#blocksubscribe",
  311. // label: "blockSubscribe",
  312. // },
  313. // ],
  314. // },
  315. {
  316. type: "category",
  317. label: "Deprecated Methods",
  318. collapsed: true,
  319. items: [
  320. {
  321. type: "link",
  322. href: "#getconfirmedblock",
  323. label: "getConfirmedBlock",
  324. },
  325. {
  326. type: "link",
  327. href: "#getconfirmedblocks",
  328. label: "getConfirmedBlocks",
  329. },
  330. {
  331. type: "link",
  332. href: "#getconfirmedblockswithlimit",
  333. label: "getConfirmedBlocksWithLimit",
  334. },
  335. {
  336. type: "link",
  337. href: "#getconfirmedsignaturesforaddress2",
  338. label: "getConfirmedSignaturesForAddress2",
  339. },
  340. {
  341. type: "link",
  342. href: "#getconfirmedtransaction",
  343. label: "getConfirmedTransaction",
  344. },
  345. {
  346. type: "link",
  347. href: "#getfeecalculatorforblockhash",
  348. label: "getFeeCalculatorForBlockhash",
  349. },
  350. {
  351. type: "link",
  352. href: "#getfeerategovernor",
  353. label: "getFeeRateGovernor",
  354. },
  355. {
  356. type: "link",
  357. href: "#getfees",
  358. label: "getFees",
  359. },
  360. {
  361. type: "link",
  362. href: "#getrecentblockhash",
  363. label: "getRecentBlockhash",
  364. },
  365. {
  366. type: "link",
  367. href: "#getsnapshotslot",
  368. label: "getSnapshotSlot",
  369. },
  370. ],
  371. },
  372. ],
  373. apiWebsocketMethodsSidebar: [
  374. {
  375. type: "link",
  376. href: "/api",
  377. label: "JSON RPC API",
  378. },
  379. {
  380. type: "doc",
  381. id: "api/http",
  382. label: "HTTP Methods",
  383. },
  384. {
  385. type: "category",
  386. link: { type: "doc", id: "api/websocket" },
  387. label: "Websocket Methods",
  388. collapsed: false,
  389. items: [
  390. {
  391. type: "link",
  392. href: "#accountsubscribe",
  393. label: "accountSubscribe",
  394. },
  395. {
  396. type: "link",
  397. href: "#accountunsubscribe",
  398. label: "accountUnsubscribe",
  399. },
  400. {
  401. type: "link",
  402. href: "#logssubscribe",
  403. label: "logsSubscribe",
  404. },
  405. {
  406. type: "link",
  407. href: "#logsunsubscribe",
  408. label: "logsUnsubscribe",
  409. },
  410. {
  411. type: "link",
  412. href: "#programsubscribe",
  413. label: "programSubscribe",
  414. },
  415. {
  416. type: "link",
  417. href: "#programunsubscribe",
  418. label: "programUnsubscribe",
  419. },
  420. {
  421. type: "link",
  422. href: "#rootsubscribe",
  423. label: "rootSubscribe",
  424. },
  425. {
  426. type: "link",
  427. href: "#rootunsubscribe",
  428. label: "rootUnsubscribe",
  429. },
  430. {
  431. type: "link",
  432. href: "#signaturesubscribe",
  433. label: "signatureSubscribe",
  434. },
  435. {
  436. type: "link",
  437. href: "#signatureunsubscribe",
  438. label: "signatureUnsubscribe",
  439. },
  440. {
  441. type: "link",
  442. href: "#slotsubscribe",
  443. label: "slotSubscribe",
  444. },
  445. {
  446. type: "link",
  447. href: "#slotunsubscribe",
  448. label: "slotUnsubscribe",
  449. },
  450. ],
  451. },
  452. {
  453. type: "category",
  454. label: "Unstable Methods",
  455. collapsed: false,
  456. items: [
  457. {
  458. type: "link",
  459. href: "#blocksubscribe",
  460. label: "blockSubscribe",
  461. },
  462. {
  463. type: "link",
  464. href: "#blockunsubscribe",
  465. label: "blockUnsubscribe",
  466. },
  467. {
  468. type: "link",
  469. href: "#slotsupdatessubscribe",
  470. label: "slotsUpdatesSubscribe",
  471. },
  472. {
  473. type: "link",
  474. href: "#slotsupdatesunsubscribe",
  475. label: "slotsUpdatesUnsubscribe",
  476. },
  477. {
  478. type: "link",
  479. href: "#votesubscribe",
  480. label: "voteSubscribe",
  481. },
  482. {
  483. type: "link",
  484. href: "#voteunsubscribe",
  485. label: "voteUnsubscribe",
  486. },
  487. ],
  488. },
  489. // {
  490. // type: "category",
  491. // label: "Deprecated Methods",
  492. // collapsed: true,
  493. // items: [
  494. // {
  495. // type: "link",
  496. // href: "#getconfirmedblock",
  497. // label: "getConfirmedBlock",
  498. // },
  499. // ],
  500. // },
  501. ],
  502. };