@xandeum/web3.js 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (103) hide show
  1. package/LICENSE +51 -0
  2. package/README.md +164 -0
  3. package/dist/armageddon.d.ts +10 -0
  4. package/dist/armageddon.js +77 -0
  5. package/dist/bigbang.d.ts +8 -0
  6. package/dist/bigbang.js +70 -0
  7. package/dist/const.d.ts +1 -0
  8. package/dist/const.js +4 -0
  9. package/dist/copyPath.d.ts +13 -0
  10. package/dist/copyPath.js +86 -0
  11. package/dist/createDirectory.d.ts +12 -0
  12. package/dist/createDirectory.js +84 -0
  13. package/dist/createFile.d.ts +13 -0
  14. package/dist/createFile.js +85 -0
  15. package/dist/exists.d.ts +20 -0
  16. package/dist/exists.js +84 -0
  17. package/dist/getInfo.d.ts +12 -0
  18. package/dist/getInfo.js +77 -0
  19. package/dist/getMetadata.d.ts +23 -0
  20. package/dist/getMetadata.js +87 -0
  21. package/dist/index.d.ts +14 -0
  22. package/dist/index.js +35 -0
  23. package/dist/listDirectoryEntery.d.ts +21 -0
  24. package/dist/listDirectoryEntery.js +85 -0
  25. package/dist/peek.d.ts +15 -0
  26. package/dist/peek.js +88 -0
  27. package/dist/poke.d.ts +14 -0
  28. package/dist/poke.js +93 -0
  29. package/dist/removeDirectory.d.ts +12 -0
  30. package/dist/removeDirectory.js +82 -0
  31. package/dist/removeFile.d.ts +12 -0
  32. package/dist/removeFile.js +82 -0
  33. package/dist/renamePath.d.ts +13 -0
  34. package/dist/renamePath.js +85 -0
  35. package/dist/sanitizePath.d.ts +14 -0
  36. package/dist/sanitizePath.js +60 -0
  37. package/dist/webSocket.d.ts +47 -0
  38. package/dist/webSocket.js +90 -0
  39. package/docs/.nojekyll +1 -0
  40. package/docs/assets/hierarchy.js +1 -0
  41. package/docs/assets/highlight.css +22 -0
  42. package/docs/assets/icons.js +18 -0
  43. package/docs/assets/icons.svg +1 -0
  44. package/docs/assets/main.js +60 -0
  45. package/docs/assets/navigation.js +1 -0
  46. package/docs/assets/search.js +1 -0
  47. package/docs/assets/style.css +1640 -0
  48. package/docs/functions/armageddon.html +6 -0
  49. package/docs/functions/bigbang.html +4 -0
  50. package/docs/functions/copyPath.html +14 -0
  51. package/docs/functions/createDirectory.html +14 -0
  52. package/docs/functions/createFile.html +16 -0
  53. package/docs/functions/exists.html +8 -0
  54. package/docs/functions/getMetadata.html +10 -0
  55. package/docs/functions/listDirectoryEntry.html +9 -0
  56. package/docs/functions/peek.html +18 -0
  57. package/docs/functions/poke.html +18 -0
  58. package/docs/functions/removeDirectory.html +14 -0
  59. package/docs/functions/removeFile.html +14 -0
  60. package/docs/functions/renamePath.html +15 -0
  61. package/docs/functions/subscribeResult.html +17 -0
  62. package/docs/functions/unsubscribeResult.html +6 -0
  63. package/docs/hierarchy.html +1 -0
  64. package/docs/index.html +2 -0
  65. package/docs/markdown/.nojekyll +0 -0
  66. package/docs/markdown/README.md +5 -0
  67. package/docs/markdown/functions/armageddon.md +35 -0
  68. package/docs/markdown/functions/bigbang.md +27 -0
  69. package/docs/markdown/functions/copyPath.md +49 -0
  70. package/docs/markdown/functions/createDirectory.md +49 -0
  71. package/docs/markdown/functions/createFile.md +50 -0
  72. package/docs/markdown/functions/exists.md +37 -0
  73. package/docs/markdown/functions/getMetadata.md +39 -0
  74. package/docs/markdown/functions/listDirectoryEntry.md +38 -0
  75. package/docs/markdown/functions/peek.md +57 -0
  76. package/docs/markdown/functions/poke.md +56 -0
  77. package/docs/markdown/functions/removeDirectory.md +44 -0
  78. package/docs/markdown/functions/removeFile.md +44 -0
  79. package/docs/markdown/functions/renamePath.md +50 -0
  80. package/docs/markdown/functions/subscribeResult.md +60 -0
  81. package/docs/markdown/functions/unsubscribeResult.md +34 -0
  82. package/docs/markdown/globals.md +23 -0
  83. package/docs/modules.html +1 -0
  84. package/package.json +26 -0
  85. package/src/armageddon.ts +36 -0
  86. package/src/bigbang.ts +29 -0
  87. package/src/const.ts +1 -0
  88. package/src/copyPath.ts +51 -0
  89. package/src/createDirectory.ts +47 -0
  90. package/src/createFile.ts +47 -0
  91. package/src/exists.ts +46 -0
  92. package/src/getMetadata.ts +49 -0
  93. package/src/index.ts +15 -0
  94. package/src/listDirectoryEntery.ts +50 -0
  95. package/src/peek.ts +52 -0
  96. package/src/poke.ts +59 -0
  97. package/src/removeDirectory.ts +43 -0
  98. package/src/removeFile.ts +44 -0
  99. package/src/renamePath.ts +50 -0
  100. package/src/sanitizePath.ts +69 -0
  101. package/src/webSocket.ts +118 -0
  102. package/tsconfig.json +14 -0
  103. package/typedoc.json +27 -0
package/docs/functions/unsubscribeResult.html ADDED
@@ -0,0 +1,6 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>unsubscribeResult | Xandeum Web3 Library - v9.0.0</title><meta name="description" content="Documentation for Xandeum Web3 Library"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">Xandeum Web3 Library - v9.0.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">unsubscribeResult</a></li></ul><h1>Function unsubscribeResult</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="unsubscriberesult"><span class="tsd-kind-call-signature">unsubscribeResult</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">subscriptionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">wsUrl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#unsubscriberesult" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends a WebSocket JSON-RPC message to unsubscribe from a previously subscribed transaction result
2
+ using the <code>xandeumResultUnsubscribed</code> method (note: custom method, ensure server-side implementation matches).</p>
3
+ <p>This function automatically closes the WebSocket connection after sending the unsubscribe request.</p>
4
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">subscriptionId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the active subscription you want to cancel.</p>
5
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">wsUrl</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The WebSocket endpoint (e.g., <code>wss://...</code>) to connect to for unsubscribing.</p>
6
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Xandeum/test_web3/blob/main/src/webSocket.ts#L86">webSocket.ts:86</a></li></ul></aside></div></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">Xandeum Web3 Library - v9.0.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/hierarchy.html ADDED
@@ -0,0 +1 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Xandeum Web3 Library - v9.0.0</title><meta name="description" content="Documentation for Xandeum Web3 Library"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">Xandeum Web3 Library - v9.0.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>Xandeum Web3 Library - v9.0.0</h1></div><h2>Hierarchy Summary</h2></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">Xandeum Web3 Library - v9.0.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/index.html ADDED
@@ -0,0 +1,2 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Xandeum Web3 Library - v9.0.0</title><meta name="description" content="Documentation for Xandeum Web3 Library"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">Xandeum Web3 Library - v9.0.0</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h1>Xandeum Web3 Library - v9.0.0</h1></div><div class="tsd-panel tsd-typography"><p>#Xandeum Web3.js</p>
2
+ </div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html">Xandeum Web3 Library - v9.0.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/docs/markdown/.nojekyll ADDED
File without changes
package/docs/markdown/README.md ADDED
@@ -0,0 +1,5 @@
1
+ **Xandeum Web3 Library v9.2.0**
2
+
3
+ ***
4
+
5
+ #Xandeum Web3.js
package/docs/markdown/functions/armageddon.md ADDED
@@ -0,0 +1,35 @@
1
+ [**Xandeum Web3 Library v9.2.0**](../README.md)
2
+
3
+ ***
4
+
5
+ [Xandeum Web3 Library](../globals.md) / armageddon
6
+
7
+ # Function: armageddon()
8
+
9
+ > **armageddon**(`fsid`, `wallet`): `Promise`\<`Transaction`\>
10
+
11
+ Defined in: [armageddon.ts:13](https://github.com/Xandeum/test_web3/blob/main/src/armageddon.ts#L13)
12
+
13
+ Constructs a Solana transaction that triggers the "armageddon" instruction
14
+ on the specified file system (fsid).
15
+ ### Requested Fields:
16
+
17
+ ## Parameters
18
+
19
+ ### fsid
20
+
21
+ `string`
22
+
23
+ A stringified integer representing the file system ID to be used in the instruction.
24
+
25
+ ### wallet
26
+
27
+ `PublicKey`
28
+
29
+ The public key of the wallet that will sign and authorize the transaction.
30
+
31
+ ## Returns
32
+
33
+ `Promise`\<`Transaction`\>
34
+
35
+ A Promise that resolves to a Solana `Transaction` object containing the armageddon instruction.
package/docs/markdown/functions/bigbang.md ADDED
@@ -0,0 +1,27 @@
1
+ [**Xandeum Web3 Library v9.2.0**](../README.md)
2
+
3
+ ***
4
+
5
+ [Xandeum Web3 Library](../globals.md) / bigbang
6
+
7
+ # Function: bigbang()
8
+
9
+ > **bigbang**(`wallet`): `Promise`\<`Transaction`\>
10
+
11
+ Defined in: [bigbang.ts:10](https://github.com/Xandeum/test_web3/blob/main/src/bigbang.ts#L10)
12
+
13
+ Constructs a Solana transaction that triggers the "bigbang" instruction and create new file system.
14
+
15
+ ## Parameters
16
+
17
+ ### wallet
18
+
19
+ `PublicKey`
20
+
21
+ The public key of the wallet that will sign and authorize the transaction.
22
+
23
+ ## Returns
24
+
25
+ `Promise`\<`Transaction`\>
26
+
27
+ A Promise that resolves to a Solana `Transaction` object containing the bigbang instruction.
package/docs/markdown/functions/copyPath.md ADDED
@@ -0,0 +1,49 @@
1
+ [**Xandeum Web3 Library v9.2.0**](../README.md)
2
+
3
+ ***
4
+
5
+ [Xandeum Web3 Library](../globals.md) / copyPath
6
+
7
+ # Function: copyPath()
8
+
9
+ > **copyPath**(`fsid`, `srcPath`, `destPath`, `wallet`): `Promise`\<`Transaction`\>
10
+
11
+ Defined in: [copyPath.ts:18](https://github.com/Xandeum/test_web3/blob/main/src/copyPath.ts#L18)
12
+
13
+ Constructs a Solana transaction to copy a file or directory from one path to another.
14
+
15
+ ## Parameters
16
+
17
+ ### fsid
18
+
19
+ `string`
20
+
21
+ The unique numeric identifier representing the target file system.
22
+
23
+ ### srcPath
24
+
25
+ `string`
26
+
27
+ The source path to copy from (e.g., `/documents/report.txt`).
28
+
29
+ ### destPath
30
+
31
+ `string`
32
+
33
+ The destination path to copy to (e.g., `/archive/report.txt`).
34
+
35
+ ### wallet
36
+
37
+ `PublicKey`
38
+
39
+ The wallet public key used to sign and authorize the transaction.
40
+
41
+ ## Returns
42
+
43
+ `Promise`\<`Transaction`\>
44
+
45
+ A Promise that resolves to a Solana `Transaction` object containing the copyPath instruction.
46
+
47
+ ## Throws
48
+
49
+ Will throw an error if `srcPath` or `destPath` contains invalid characters.
package/docs/markdown/functions/createDirectory.md ADDED
@@ -0,0 +1,49 @@
1
+ [**Xandeum Web3 Library v9.2.0**](../README.md)
2
+
3
+ ***
4
+
5
+ [Xandeum Web3 Library](../globals.md) / createDirectory
6
+
7
+ # Function: createDirectory()
8
+
9
+ > **createDirectory**(`fsid`, `path`, `name`, `wallet`): `Promise`\<`Transaction`\>
10
+
11
+ Defined in: [createDirectory.ts:17](https://github.com/Xandeum/test_web3/blob/main/src/createDirectory.ts#L17)
12
+
13
+ Constructs a Solana transaction to create a new directory within a file system.
14
+
15
+ ## Parameters
16
+
17
+ ### fsid
18
+
19
+ `string`
20
+
21
+ A numeric filesystem identifier used to scope the directory creation.
22
+
23
+ ### path
24
+
25
+ `string`
26
+
27
+ The parent path where the directory should be created (e.g., `/documents`).
28
+
29
+ ### name
30
+
31
+ `string`
32
+
33
+ The name of the new directory (e.g., `reports`).
34
+
35
+ ### wallet
36
+
37
+ `PublicKey`
38
+
39
+ The signer’s public key that authorizes the transaction.
40
+
41
+ ## Returns
42
+
43
+ `Promise`\<`Transaction`\>
44
+
45
+ A Promise that resolves to a Solana `Transaction` object containing the createDirectory instruction.
46
+
47
+ ## Throws
48
+
49
+ Will throw an error if `path` or `name` contains invalid characters.@throws Will throw if the combined path is invalid (non-alphanumeric or unsupported characters).
package/docs/markdown/functions/createFile.md ADDED
@@ -0,0 +1,50 @@
1
+ [**Xandeum Web3 Library v9.2.0**](../README.md)
2
+
3
+ ***
4
+
5
+ [Xandeum Web3 Library](../globals.md) / createFile
6
+
7
+ # Function: createFile()
8
+
9
+ > **createFile**(`fsid`, `path`, `name`, `wallet`): `Promise`\<`Transaction`\>
10
+
11
+ Defined in: [createFile.ts:17](https://github.com/Xandeum/test_web3/blob/main/src/createFile.ts#L17)
12
+
13
+ Constructs a Solana transaction to create a new file
14
+ within a file system, identified by a file system ID (`fsid`).
15
+
16
+ ## Parameters
17
+
18
+ ### fsid
19
+
20
+ `string`
21
+
22
+ A stringified integer representing the file system ID where the file is to be created.
23
+
24
+ ### path
25
+
26
+ `string`
27
+
28
+ The absolute or relative path within the file system where the file should be created.
29
+
30
+ ### name
31
+
32
+ `string`
33
+
34
+ The name of the new file or directory to be created.
35
+
36
+ ### wallet
37
+
38
+ `PublicKey`
39
+
40
+ The public key of the wallet that will sign and authorize the transaction.
41
+
42
+ ## Returns
43
+
44
+ `Promise`\<`Transaction`\>
45
+
46
+ A Promise that resolves to a Solana `Transaction` object containing the createFile instruction.
47
+
48
+ ## Throws
49
+
50
+ Will throw an error if `path` or `name` contains invalid characters.
package/docs/markdown/functions/exists.md ADDED
@@ -0,0 +1,37 @@
1
+ [**Xandeum Web3 Library v9.2.0**](../README.md)
2
+
3
+ ***
4
+
5
+ [Xandeum Web3 Library](../globals.md) / exists
6
+
7
+ # Function: exists()
8
+
9
+ > **exists**(`path`, `url`): `Promise`\<`any`\>
10
+
11
+ Defined in: [exists.ts:22](https://github.com/Xandeum/test_web3/blob/main/src/exists.ts#L22)
12
+
13
+ Sends a JSON-RPC request to the Xandeum RPC endpoint to check if a file or directory exists.
14
+
15
+ This function calls the custom RPC method `isExist`, which should be implemented
16
+ by the backend to validate the existence of metadata (files/directories) at a given path.
17
+
18
+ ## Parameters
19
+
20
+ ### path
21
+
22
+ `string`
23
+
24
+ The filesystem path to check (e.g., `/documents/myfile.txt`).
25
+
26
+ ### url
27
+
28
+ `string`
29
+
30
+ The full URL of the Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
31
+
32
+ ## Returns
33
+
34
+ `Promise`\<`any`\>
35
+
36
+ A `Promise<any>` resolving to the RPC response JSON, typically including a `result` field
37
+ indicating existence (e.g., `true` or `false`), or `null` if not found.
package/docs/markdown/functions/getMetadata.md ADDED
@@ -0,0 +1,39 @@
1
+ [**Xandeum Web3 Library v9.2.0**](../README.md)
2
+
3
+ ***
4
+
5
+ [Xandeum Web3 Library](../globals.md) / getMetadata
6
+
7
+ # Function: getMetadata()
8
+
9
+ > **getMetadata**(`path`, `url`): `Promise`\<`any`\>
10
+
11
+ Defined in: [getMetadata.ts:24](https://github.com/Xandeum/test_web3/blob/main/src/getMetadata.ts#L24)
12
+
13
+ Sends a JSON-RPC request to the Xandeum RPC endpoint to retrieve metadata
14
+ about a file or directory at the given path.
15
+
16
+ This function calls the custom RPC method `getMetadata`, which is implemented
17
+ by the backend to return metadata such as type (file or directory), size,
18
+ timestamps etc.
19
+
20
+ ## Parameters
21
+
22
+ ### path
23
+
24
+ `string`
25
+
26
+ The filesystem path to query metadata for (e.g., `/documents/myfile.txt`).
27
+
28
+ ### url
29
+
30
+ `string`
31
+
32
+ The full URL of the Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
33
+
34
+ ## Returns
35
+
36
+ `Promise`\<`any`\>
37
+
38
+ A `Promise<any>` resolving to the parsed JSON response from the RPC server,
39
+ typically containing a `result` object with metadata fields.
package/docs/markdown/functions/listDirectoryEntry.md ADDED
@@ -0,0 +1,38 @@
1
+ [**Xandeum Web3 Library v9.2.0**](../README.md)
2
+
3
+ ***
4
+
5
+ [Xandeum Web3 Library](../globals.md) / listDirectoryEntry
6
+
7
+ # Function: listDirectoryEntry()
8
+
9
+ > **listDirectoryEntry**(`path`, `url`): `Promise`\<`any`\>
10
+
11
+ Defined in: [listDirectoryEntery.ts:22](https://github.com/Xandeum/test_web3/blob/main/src/listDirectoryEntery.ts#L22)
12
+
13
+ Sends a JSON-RPC request to the Xandeum RPC endpoint to list all entries (files and subdirectories)
14
+ within a specified path.
15
+
16
+ This function calls the custom RPC method `listDirs`, which is return an array of
17
+ directory entry metadata — names, types etc.
18
+
19
+ ## Parameters
20
+
21
+ ### path
22
+
23
+ `string`
24
+
25
+ The filesystem path representing the directory to list (e.g., `/documents`).
26
+
27
+ ### url
28
+
29
+ `string`
30
+
31
+ The full URL of the Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
32
+
33
+ ## Returns
34
+
35
+ `Promise`\<`any`\>
36
+
37
+ A `Promise<any>` resolving to the parsed JSON response from the RPC server,
38
+ typically including a `result` array containing directory entry objects.
package/docs/markdown/functions/peek.md ADDED
@@ -0,0 +1,57 @@
1
+ [**Xandeum Web3 Library v9.2.0**](../README.md)
2
+
3
+ ***
4
+
5
+ [Xandeum Web3 Library](../globals.md) / peek
6
+
7
+ # Function: peek()
8
+
9
+ > **peek**(`fsid`, `path`, `startPosition`, `endPosition`, `wallet`): `Promise`\<`Transaction`\>
10
+
11
+ Defined in: [peek.ts:20](https://github.com/Xandeum/test_web3/blob/main/src/peek.ts#L20)
12
+
13
+ Constructs a Solana transaction to perform a "peek" operation on a file within a file system.
14
+
15
+ The peek operation reads data between two byte offsets within a specified file path.
16
+
17
+ ## Parameters
18
+
19
+ ### fsid
20
+
21
+ `string`
22
+
23
+ A stringified integer representing the file system ID in which the file resides.
24
+
25
+ ### path
26
+
27
+ `string`
28
+
29
+ The path to the file to be peeked.
30
+
31
+ ### startPosition
32
+
33
+ `number`
34
+
35
+ The starting byte offset (inclusive) to begin reading from.
36
+
37
+ ### endPosition
38
+
39
+ `number`
40
+
41
+ The ending byte offset (exclusive) to stop reading at.
42
+
43
+ ### wallet
44
+
45
+ `PublicKey`
46
+
47
+ The public key of the wallet that will sign and authorize the transaction.
48
+
49
+ ## Returns
50
+
51
+ `Promise`\<`Transaction`\>
52
+
53
+ A Promise that resolves to a Solana `Transaction` object containing the peek instruction.
54
+
55
+ ## Throws
56
+
57
+ Will throw an error if the `path` contains invalid characters.
package/docs/markdown/functions/poke.md ADDED
@@ -0,0 +1,56 @@
1
+ [**Xandeum Web3 Library v9.2.0**](../README.md)
2
+
3
+ ***
4
+
5
+ [Xandeum Web3 Library](../globals.md) / poke
6
+
7
+ # Function: poke()
8
+
9
+ > **poke**(`fsid`, `path`, `position`, `wallet`, `dataKey`): `Promise`\<`Transaction`\>
10
+
11
+ Defined in: [poke.ts:19](https://github.com/Xandeum/test_web3/blob/main/src/poke.ts#L19)
12
+
13
+ Constructs a Solana transaction to perform a poke\operation, which writes data
14
+ to a file at the specified path and byte position.
15
+
16
+ ## Parameters
17
+
18
+ ### fsid
19
+
20
+ `string`
21
+
22
+ A stringified integer representing the file system ID where the file resides.
23
+
24
+ ### path
25
+
26
+ `string`
27
+
28
+ The path to the file to be written to.
29
+
30
+ ### position
31
+
32
+ `number`
33
+
34
+ The byte offset in the file where data should be written.
35
+
36
+ ### wallet
37
+
38
+ `PublicKey`
39
+
40
+ The public key of the wallet that signs and authorizes the transaction.
41
+
42
+ ### dataKey
43
+
44
+ `PublicKey`
45
+
46
+ A public key of a data account that holds the content to be written to the file.
47
+
48
+ ## Returns
49
+
50
+ `Promise`\<`Transaction`\>
51
+
52
+ A Promise that resolves to a Solana `Transaction` object containing the poke instruction.
53
+
54
+ ## Throws
55
+
56
+ Will throw an error if the `path` contains invalid characters.
package/docs/markdown/functions/removeDirectory.md ADDED
@@ -0,0 +1,44 @@
1
+ [**Xandeum Web3 Library v9.2.0**](../README.md)
2
+
3
+ ***
4
+
5
+ [Xandeum Web3 Library](../globals.md) / removeDirectory
6
+
7
+ # Function: removeDirectory()
8
+
9
+ > **removeDirectory**(`fsid`, `path`, `wallet`): `Promise`\<`Transaction`\>
10
+
11
+ Defined in: [removeDirectory.ts:17](https://github.com/Xandeum/test_web3/blob/main/src/removeDirectory.ts#L17)
12
+
13
+ Constructs a Solana transaction to perform a "remove directory" operation
14
+ in a file system, identified by a file system ID (`fsid`).
15
+
16
+ ## Parameters
17
+
18
+ ### fsid
19
+
20
+ `string`
21
+
22
+ A stringified integer representing the file system ID containing the directory.
23
+
24
+ ### path
25
+
26
+ `string`
27
+
28
+ The full path to the directory that should be removed.
29
+
30
+ ### wallet
31
+
32
+ `PublicKey`
33
+
34
+ The public key of the wallet that will sign and authorize the transaction.
35
+
36
+ ## Returns
37
+
38
+ `Promise`\<`Transaction`\>
39
+
40
+ A Promise that resolves to a Solana `Transaction` object containing the remove directory instruction.
41
+
42
+ ## Throws
43
+
44
+ May throw an error if the `path` fails validation in `sanitizePath`.
package/docs/markdown/functions/removeFile.md ADDED
@@ -0,0 +1,44 @@
1
+ [**Xandeum Web3 Library v9.2.0**](../README.md)
2
+
3
+ ***
4
+
5
+ [Xandeum Web3 Library](../globals.md) / removeFile
6
+
7
+ # Function: removeFile()
8
+
9
+ > **removeFile**(`fsid`, `path`, `wallet`): `Promise`\<`Transaction`\>
10
+
11
+ Defined in: [removeFile.ts:17](https://github.com/Xandeum/test_web3/blob/main/src/removeFile.ts#L17)
12
+
13
+ Constructs a Solana transaction to remove a file from a file system,
14
+ identified by a file system ID (`fsid`) and a UTF-8 encoded file path.
15
+
16
+ ## Parameters
17
+
18
+ ### fsid
19
+
20
+ `string`
21
+
22
+ A stringified integer representing the file system ID in which the file resides.
23
+
24
+ ### path
25
+
26
+ `string`
27
+
28
+ The full path to the file to be deleted.
29
+
30
+ ### wallet
31
+
32
+ `PublicKey`
33
+
34
+ The public key of the wallet that signs and authorizes the transaction.
35
+
36
+ ## Returns
37
+
38
+ `Promise`\<`Transaction`\>
39
+
40
+ A Promise that resolves to a Solana `Transaction` object containing the remove file instruction.
41
+
42
+ ## Throws
43
+
44
+ May throw an error if `path` is invalid per `sanitizePath`.
package/docs/markdown/functions/renamePath.md ADDED
@@ -0,0 +1,50 @@
1
+ [**Xandeum Web3 Library v9.2.0**](../README.md)
2
+
3
+ ***
4
+
5
+ [Xandeum Web3 Library](../globals.md) / renamePath
6
+
7
+ # Function: renamePath()
8
+
9
+ > **renamePath**(`fsid`, `oldPath`, `name`, `wallet`): `Promise`\<`Transaction`\>
10
+
11
+ Defined in: [renamePath.ts:18](https://github.com/Xandeum/test_web3/blob/main/src/renamePath.ts#L18)
12
+
13
+ Constructs a Solana transaction to rename (or move) a file or directory
14
+ within a file system, based on a provided file system ID (`fsid`).
15
+
16
+ ## Parameters
17
+
18
+ ### fsid
19
+
20
+ `string`
21
+
22
+ A stringified integer representing the file system ID where the path exists.
23
+
24
+ ### oldPath
25
+
26
+ `string`
27
+
28
+ The current path of the file or directory to be renamed or moved.
29
+
30
+ ### name
31
+
32
+ `string`
33
+
34
+ The new name to assign to the file or directory.
35
+
36
+ ### wallet
37
+
38
+ `PublicKey`
39
+
40
+ The public key of the wallet that signs and authorizes the transaction.
41
+
42
+ ## Returns
43
+
44
+ `Promise`\<`Transaction`\>
45
+
46
+ A Promise that resolves to a Solana `Transaction` object containing the rename path instruction.
47
+
48
+ ## Throws
49
+
50
+ May throw an error if either `oldPath` or `newPath` is invalid per `sanitizePath`.