npm - @xandeum/web3.js - Versions diffs - 1.1.0 - Mend

@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

package/LICENSE +51 -0
package/README.md +164 -0
package/dist/armageddon.d.ts +10 -0
package/dist/armageddon.js +77 -0
package/dist/bigbang.d.ts +8 -0
package/dist/bigbang.js +70 -0
package/dist/const.d.ts +1 -0
package/dist/const.js +4 -0
package/dist/copyPath.d.ts +13 -0
package/dist/copyPath.js +86 -0
package/dist/createDirectory.d.ts +12 -0
package/dist/createDirectory.js +84 -0
package/dist/createFile.d.ts +13 -0
package/dist/createFile.js +85 -0
package/dist/exists.d.ts +20 -0
package/dist/exists.js +84 -0
package/dist/getInfo.d.ts +12 -0
package/dist/getInfo.js +77 -0
package/dist/getMetadata.d.ts +23 -0
package/dist/getMetadata.js +87 -0
package/dist/index.d.ts +14 -0
package/dist/index.js +35 -0
package/dist/listDirectoryEntery.d.ts +21 -0
package/dist/listDirectoryEntery.js +85 -0
package/dist/peek.d.ts +15 -0
package/dist/peek.js +88 -0
package/dist/poke.d.ts +14 -0
package/dist/poke.js +93 -0
package/dist/removeDirectory.d.ts +12 -0
package/dist/removeDirectory.js +82 -0
package/dist/removeFile.d.ts +12 -0
package/dist/removeFile.js +82 -0
package/dist/renamePath.d.ts +13 -0
package/dist/renamePath.js +85 -0
package/dist/sanitizePath.d.ts +14 -0
package/dist/sanitizePath.js +60 -0
package/dist/webSocket.d.ts +47 -0
package/dist/webSocket.js +90 -0
package/docs/.nojekyll +1 -0
package/docs/assets/hierarchy.js +1 -0
package/docs/assets/highlight.css +22 -0
package/docs/assets/icons.js +18 -0
package/docs/assets/icons.svg +1 -0
package/docs/assets/main.js +60 -0
package/docs/assets/navigation.js +1 -0
package/docs/assets/search.js +1 -0
package/docs/assets/style.css +1640 -0
package/docs/functions/armageddon.html +6 -0
package/docs/functions/bigbang.html +4 -0
package/docs/functions/copyPath.html +14 -0
package/docs/functions/createDirectory.html +14 -0
package/docs/functions/createFile.html +16 -0
package/docs/functions/exists.html +8 -0
package/docs/functions/getMetadata.html +10 -0
package/docs/functions/listDirectoryEntry.html +9 -0
package/docs/functions/peek.html +18 -0
package/docs/functions/poke.html +18 -0
package/docs/functions/removeDirectory.html +14 -0
package/docs/functions/removeFile.html +14 -0
package/docs/functions/renamePath.html +15 -0
package/docs/functions/subscribeResult.html +17 -0
package/docs/functions/unsubscribeResult.html +6 -0
package/docs/hierarchy.html +1 -0
package/docs/index.html +2 -0
package/docs/markdown/.nojekyll +0 -0
package/docs/markdown/README.md +5 -0
package/docs/markdown/functions/armageddon.md +35 -0
package/docs/markdown/functions/bigbang.md +27 -0
package/docs/markdown/functions/copyPath.md +49 -0
package/docs/markdown/functions/createDirectory.md +49 -0
package/docs/markdown/functions/createFile.md +50 -0
package/docs/markdown/functions/exists.md +37 -0
package/docs/markdown/functions/getMetadata.md +39 -0
package/docs/markdown/functions/listDirectoryEntry.md +38 -0
package/docs/markdown/functions/peek.md +57 -0
package/docs/markdown/functions/poke.md +56 -0
package/docs/markdown/functions/removeDirectory.md +44 -0
package/docs/markdown/functions/removeFile.md +44 -0
package/docs/markdown/functions/renamePath.md +50 -0
package/docs/markdown/functions/subscribeResult.md +60 -0
package/docs/markdown/functions/unsubscribeResult.md +34 -0
package/docs/markdown/globals.md +23 -0
package/docs/modules.html +1 -0
package/package.json +26 -0
package/src/armageddon.ts +36 -0
package/src/bigbang.ts +29 -0
package/src/const.ts +1 -0
package/src/copyPath.ts +51 -0
package/src/createDirectory.ts +47 -0
package/src/createFile.ts +47 -0
package/src/exists.ts +46 -0
package/src/getMetadata.ts +49 -0
package/src/index.ts +15 -0
package/src/listDirectoryEntery.ts +50 -0
package/src/peek.ts +52 -0
package/src/poke.ts +59 -0
package/src/removeDirectory.ts +43 -0
package/src/removeFile.ts +44 -0
package/src/renamePath.ts +50 -0
package/src/sanitizePath.ts +69 -0
package/src/webSocket.ts +118 -0
package/tsconfig.json +14 -0
package/typedoc.json +27 -0

package/docs/markdown/functions/subscribeResult.md ADDED Viewed

@@ -0,0 +1,60 @@
+[**Xandeum Web3 Library v9.2.0**](../README.md)
+***
+[Xandeum Web3 Library](../globals.md) / subscribeResult
+# Function: subscribeResult()
+> **subscribeResult**(`tx`, `wsUrl`, `onResult`, `onError?`, `onClose?`): `void`
+Defined in: [webSocket.ts:38](https://github.com/Xandeum/test_web3/blob/main/src/webSocket.ts#L38)
+Opens a WebSocket connection and subscribes to the result of a transaction
+via the custom `xandeumResultSubscribe` method.
+This is useful for receiving asynchronous results tied to an on-chain operation,
+such as file creation, modification, or deletion.
+The subscription sends a JSON-RPC request with:
+- `method`: "xandeumResultSubscribe"
+- `params`: [txId, { commitment: "finalized" }]
+The WebSocket listens for result messages and invokes the `onResult` callback
+if a valid result with `fsid`, `status`, or `data` is received.
+## Parameters
+### tx
+`string`
+The transaction ID you want to listen for results from.
+### wsUrl
+`string`
+The full WebSocket endpoint (e.g., `wss://...`) to connect to.
+### onResult
+(`value`) => `void`
+Callback to handle incoming result messages. Triggered when a valid response is received.
+### onError?
+(`err`) => `void`
+(Optional) Callback triggered if a WebSocket error occurs.
+### onClose?
+() => `void`
+(Optional) Callback triggered when the WebSocket connection closes.
+## Returns
+`void`

package/docs/markdown/functions/unsubscribeResult.md ADDED Viewed

@@ -0,0 +1,34 @@
+[**Xandeum Web3 Library v9.2.0**](../README.md)
+***
+[Xandeum Web3 Library](../globals.md) / unsubscribeResult
+# Function: unsubscribeResult()
+> **unsubscribeResult**(`subscriptionId`, `wsUrl`): `void`
+Defined in: [webSocket.ts:93](https://github.com/Xandeum/test_web3/blob/main/src/webSocket.ts#L93)
+Sends a WebSocket JSON-RPC message to unsubscribe from a previously subscribed transaction result
+using the `xandeumResultUnsubscribed` method (note: custom method, ensure server-side implementation matches).
+This function automatically closes the WebSocket connection after sending the unsubscribe request.
+## Parameters
+### subscriptionId
+`string`
+The ID of the active subscription you want to cancel.
+### wsUrl
+`string`
+The WebSocket endpoint (e.g., `wss://...`) to connect to for unsubscribing.
+## Returns
+`void`

package/docs/markdown/globals.md ADDED Viewed

@@ -0,0 +1,23 @@
+[**Xandeum Web3 Library v9.2.0**](README.md)
+***
+# Xandeum Web3 Library v9.2.0
+## Functions
+- [armageddon](functions/armageddon.md)
+- [bigbang](functions/bigbang.md)
+- [copyPath](functions/copyPath.md)
+- [createDirectory](functions/createDirectory.md)
+- [createFile](functions/createFile.md)
+- [exists](functions/exists.md)
+- [getMetadata](functions/getMetadata.md)
+- [listDirectoryEntry](functions/listDirectoryEntry.md)
+- [peek](functions/peek.md)
+- [poke](functions/poke.md)
+- [removeDirectory](functions/removeDirectory.md)
+- [removeFile](functions/removeFile.md)
+- [renamePath](functions/renamePath.md)
+- [subscribeResult](functions/subscribeResult.md)
+- [unsubscribeResult](functions/unsubscribeResult.md)

package/docs/modules.html ADDED Viewed

@@ -0,0 +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"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"></ul><h1>Xandeum Web3 Library - v9.0.0</h1></div><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Functions"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h2>Functions</h2></summary><dl class="tsd-member-summaries"><dt class="tsd-member-summary" id="armageddon"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/armageddon.html">armageddon</a><a href="#armageddon" 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></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="bigbang"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/bigbang.html">bigbang</a><a href="#bigbang" 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></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="copypath"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/copyPath.html">copyPath</a><a href="#copypath" 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></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="createdirectory"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/createDirectory.html">createDirectory</a><a href="#createdirectory" 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></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="createfile"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/createFile.html">createFile</a><a href="#createfile" 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></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="exists"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/exists.html">exists</a><a href="#exists" 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></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="getmetadata"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/getMetadata.html">getMetadata</a><a href="#getmetadata" 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></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="listdirectoryentry"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/listDirectoryEntry.html">listDirectoryEntry</a><a href="#listdirectoryentry" 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></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="peek"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/peek.html">peek</a><a href="#peek" 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></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="poke"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/poke.html">poke</a><a href="#poke" 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></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="removedirectory"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/removeDirectory.html">removeDirectory</a><a href="#removedirectory" 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></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="removefile"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/removeFile.html">removeFile</a><a href="#removefile" 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></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="renamepath"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/renamePath.html">renamePath</a><a href="#renamepath" 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></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="subscriberesult"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/subscribeResult.html">subscribeResult</a><a href="#subscriberesult" 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></span></dt><dd class="tsd-member-summary"></dd><dt class="tsd-member-summary" id="unsubscriberesult"><span class="tsd-member-summary-name"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><a href="functions/unsubscribeResult.html">unsubscribeResult</a><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></span></dt><dd class="tsd-member-summary"></dd></dl></details></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><details open class="tsd-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Functions"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Functions</summary><div><a href="#armageddon"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>armageddon</span></a><a href="#bigbang"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>bigbang</span></a><a href="#copypath"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>copy<wbr/>Path</span></a><a href="#createdirectory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>create<wbr/>Directory</span></a><a href="#createfile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>create<wbr/>File</span></a><a href="#exists"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>exists</span></a><a href="#getmetadata"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>get<wbr/>Metadata</span></a><a href="#listdirectoryentry"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>list<wbr/>Directory<wbr/>Entry</span></a><a href="#peek"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>peek</span></a><a href="#poke"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>poke</span></a><a href="#removedirectory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>remove<wbr/>Directory</span></a><a href="#removefile"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>remove<wbr/>File</span></a><a href="#renamepath"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>rename<wbr/>Path</span></a><a href="#subscriberesult"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>subscribe<wbr/>Result</span></a><a href="#unsubscriberesult"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Function"><use href="assets/icons.svg#icon-64"></use></svg><span>unsubscribe<wbr/>Result</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current">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/package.json ADDED Viewed

@@ -0,0 +1,26 @@
+{
+  "name": "@xandeum/web3.js",
+  "version": "1.1.0",
+  "description": "Xandeum javascript api",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "deploy-docs": "typedoc && gh-pages -d docs"
+  },
+  "author": "",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@solana/web3.js": "^1.98.2",
+    "ws": "^8.18.2"
+  },
+  "devDependencies": {
+    "@types/bn.js": "^5.1.6",
+    "gh-pages": "^6.3.0",
+    "typedoc": "^0.28.4",
+    "typedoc-plugin-markdown": "^4.6.3"
+  }
+}

package/src/armageddon.ts ADDED Viewed

@@ -0,0 +1,36 @@
+import { Transaction, TransactionInstruction, PublicKey } from '@solana/web3.js'
+import BN from 'bn.js'
+import { programId } from './const.js'
+/**
+ * Constructs a Solana transaction that triggers the "armageddon" instruction
+ * on the specified file system (fsid).
+ *
+ * @param fsid - A stringified integer representing the file system ID to be used in the instruction.
+ * @param wallet - The public key of the wallet that will sign and authorize the transaction.
+ * @returns A Promise that resolves to a Solana `Transaction` object containing the armageddon instruction.
+ */
+export async function armageddon (
+  fsid: string,
+  wallet: PublicKey
+): Promise<Transaction> {
+  const instructionData = Buffer.concat([
+    Buffer.from(Int8Array.from([1]).buffer),
+    Buffer.from(Uint8Array.of(...new BN(fsid).toArray('le', 8)))
+  ])
+  const instruction = new TransactionInstruction({
+    keys: [
+      {
+        pubkey: wallet,
+        isSigner: true,
+        isWritable: true
+      }
+    ],
+    programId: new PublicKey(programId),
+    data: instructionData
+  })
+  const tx = new Transaction().add(instruction)
+  return tx
+}

package/src/bigbang.ts ADDED Viewed

@@ -0,0 +1,29 @@
+import { Transaction, TransactionInstruction, PublicKey } from '@solana/web3.js'
+import { programId } from './const'
+/**
+ * Constructs a Solana transaction that triggers the "bigbang" instruction and create new file system.
+ *
+ * @param wallet - The public key of the wallet that will sign and authorize the transaction.
+ * @returns A Promise that resolves to a Solana `Transaction` object containing the bigbang instruction.
+ */
+export async function bigbang (wallet: PublicKey): Promise<Transaction> {
+  const instructionData = Buffer.concat([
+    Buffer.from(Int8Array.from([0]).buffer)
+  ])
+  const instruction = new TransactionInstruction({
+    keys: [
+      {
+        pubkey: wallet,
+        isSigner: true,
+        isWritable: true
+      }
+    ],
+    programId: new PublicKey(programId),
+    data: instructionData
+  })
+  const tx = new Transaction().add(instruction)
+  return tx
+}

package/src/const.ts ADDED Viewed

	@@ -0,0 +1 @@
1	+ export const programId="xSHLJPXU8QW3A9kGiRoL94bksJ7ZZPY4dUwJPAT8CVK";

package/src/copyPath.ts ADDED Viewed

@@ -0,0 +1,51 @@
+import { Transaction, TransactionInstruction, PublicKey } from '@solana/web3.js'
+import BN from 'bn.js'
+import { programId } from './const'
+import { sanitizePath } from './sanitizePath'
+/**
+ * Constructs a Solana transaction to copy a file or directory from one  path to another.
+ *
+ * @param fsid - The unique numeric identifier representing the target file system.
+ * @param srcPath - The source path to copy from (e.g., `/documents/report.txt`).
+ * @param destPath - The destination path to copy to (e.g., `/archive/report.txt`).
+ * @param wallet - The wallet public key used to sign and authorize the transaction.
+ * @returns A Promise that resolves to a Solana `Transaction` object containing the copyPath instruction.
+ * @throws Will throw an error if `srcPath` or `destPath` contains invalid characters.
+ *
+ */
+export async function copyPath (
+  fsid: string,
+  srcPath: string,
+  destPath: string,
+  wallet: PublicKey
+): Promise<Transaction> {
+  // Validate path: only letters, numbers, and /
+  sanitizePath(srcPath)
+  sanitizePath(destPath)
+  const rest = Buffer.from(`${srcPath}\0${destPath}`, 'utf-8')
+  const instructionData = Buffer.concat([
+    Buffer.from(Int8Array.from([9]).buffer),
+    Buffer.from(Uint8Array.of(...new BN(fsid).toArray('le', 8))),
+    rest
+  ])
+  const instruction = new TransactionInstruction({
+    keys: [
+      {
+        pubkey: wallet,
+        isSigner: true,
+        isWritable: true
+      }
+    ],
+    programId: new PublicKey(programId),
+    data: instructionData
+  })
+  const tx = new Transaction().add(instruction)
+  return tx
+}

package/src/createDirectory.ts ADDED Viewed

@@ -0,0 +1,47 @@
+import { Transaction, TransactionInstruction, PublicKey } from '@solana/web3.js'
+import BN from 'bn.js'
+import { programId } from './const'
+import { sanitizePath } from './sanitizePath'
+/**
+ * Constructs a Solana transaction to create a new directory within a  file system.
+ *
+ * @param fsid - A numeric filesystem identifier used to scope the directory creation.
+ * @param path - The parent path where the directory should be created (e.g., `/documents`).
+ * @param name - The name of the new directory (e.g., `reports`).
+ * @param wallet - The signer’s public key that authorizes the transaction.
+ * @returns A Promise that resolves to a Solana `Transaction` object containing the createDirectory instruction.
+ * @throws 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).
+ */
+export async function createDirectory (
+  fsid: string,
+  path: string,
+  name: string,
+  wallet: PublicKey
+): Promise<Transaction> {
+  // Validate path: only letters, numbers, and /
+  let combinedPath = path + '/' + name
+  sanitizePath(combinedPath)
+  const rest = Buffer.from(`${path}\0${name}`, 'utf-8')
+  const instructionData = Buffer.concat([
+    Buffer.from(Int8Array.from([6]).buffer),
+    Buffer.from(Uint8Array.of(...new BN(fsid).toArray('le', 8))),
+    rest
+  ])
+  const instruction = new TransactionInstruction({
+    keys: [
+      {
+        pubkey: wallet,
+        isSigner: true,
+        isWritable: true
+      }
+    ],
+    programId: new PublicKey(programId),
+    data: instructionData
+  })
+  const tx = new Transaction().add(instruction)
+  return tx
+}

package/src/createFile.ts ADDED Viewed

@@ -0,0 +1,47 @@
+import { Transaction, TransactionInstruction, PublicKey } from '@solana/web3.js'
+import BN from 'bn.js'
+import { programId } from './const'
+import { sanitizePath } from './sanitizePath'
+/**
+ * Constructs a Solana transaction to create a new file
+ * within a file system, identified by a file system ID (`fsid`).
+ *
+ * @param fsid - A stringified integer representing the file system ID where the file is to be created.
+ * @param path - The absolute or relative path within the file system where the file should be created.
+ * @param name - The name of the new file or directory to be created.
+ * @param wallet - The public key of the wallet that will sign and authorize the transaction.
+ * @returns A Promise that resolves to a Solana `Transaction` object containing the createFile instruction.
+ * @throws Will throw an error if `path` or `name` contains invalid characters.
+ */
+export async function createFile (
+  fsid: string,
+  path: string,
+  name: string,
+  wallet: PublicKey
+): Promise<Transaction> {
+  let combinedPath = path + '/' + name
+  sanitizePath(combinedPath);
+  const rest = Buffer.from(`${path}\0${name}`, 'utf-8')
+  const instructionData = Buffer.concat([
+    Buffer.from(Int8Array.from([2]).buffer),
+    Buffer.from(Uint8Array.of(...new BN(fsid).toArray('le', 8))),
+    rest
+  ])
+  const instruction = new TransactionInstruction({
+    keys: [
+      {
+        pubkey: wallet,
+        isSigner: true,
+        isWritable: true
+      }
+    ],
+    programId: new PublicKey(programId),
+    data: instructionData
+  })
+  const tx = new Transaction().add(instruction)
+  return tx
+}

package/src/exists.ts ADDED Viewed

@@ -0,0 +1,46 @@
+import { Connection } from "@solana/web3.js"
+export interface RpcRequest {
+  jsonrpc: string
+  id: number
+  method: string
+  params: any[]
+}
+/**
+ * Sends a JSON-RPC request to the Xandeum RPC endpoint to check if a file or directory exists.
+ *
+ * This function calls the custom RPC method `isExist`, which should be implemented
+ * by the backend to validate the existence of metadata (files/directories) at a given path.
+ * @param connection - The solana web3 connection with Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
+ * @param path - The filesystem path to check (e.g., `/documents/myfile.txt`).
+ *
+ * @returns A `Promise<any>` resolving to the RPC response JSON, typically including a `result` field
+ *          indicating existence (e.g., `true` or `false`), or `null` if not found.
+ *
+ */
+  export async function exists (connection: Connection,path: string): Promise<any> {
+  const url = connection.rpcEndpoint;
+  const requestBody: RpcRequest = {
+    jsonrpc: '2.0',
+    id: 1,
+    method: 'isExist',
+    params: [path]
+  }
+  const response = await fetch(url, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    body: JSON.stringify(requestBody)
+  })
+  if (!response.ok) {
+    throw new Error(`HTTP error! Status: ${response.status}`)
+  }
+  const data = await response.json()
+  return data
+}

package/src/getMetadata.ts ADDED Viewed

@@ -0,0 +1,49 @@
+import { Connection } from "@solana/web3.js"
+export interface RpcRequest {
+  jsonrpc: string
+  id: number
+  method: string
+  params: any[]
+}
+/**
+ * Sends a JSON-RPC request to the Xandeum RPC endpoint to retrieve metadata
+ * about a file or directory at the given path.
+ *
+ * This function calls the custom RPC method `getMetadata`, which is implemented
+ * by the backend to return metadata such as type (file or directory), size,
+ * timestamps etc.
+ *
+ * @param connection - The solana web3 connection with Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
+ * @param path - The filesystem path to query metadata for (e.g., `/documents/myfile.txt`).
+ *
+ * @returns A `Promise<any>` resolving to the parsed JSON response from the RPC server,
+ *          typically containing a `result` object with metadata fields.
+ *
+ */
+export async function getMetadata (connection: Connection,path: string): Promise<any> {
+  const url = connection.rpcEndpoint;
+  const requestBody: RpcRequest = {
+    jsonrpc: '2.0',
+    id: 1,
+    method: 'getMetadata',
+    params: [path]
+  }
+  const response = await fetch(url, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    body: JSON.stringify(requestBody)
+  })
+  if (!response.ok) {
+    throw new Error(`HTTP error! Status: ${response.status}`)
+  }
+  const data = await response.json()
+  return data
+}

package/src/index.ts ADDED Viewed

@@ -0,0 +1,15 @@
+export { bigbang } from "./bigbang";
+export * from './webSocket';
+export  *  from "./armageddon";
+export  *  from "./removeFile";
+export  * from "./renamePath";
+export  * from "./createFile";
+export  * from "./createDirectory";
+export * from "./peek";
+export * from "./poke";
+export * from "./removeDirectory";
+export * from "./copyPath";
+export {exists } from "./exists";
+export {listDirectoryEntry} from "./listDirectoryEntery";
+export {getMetadata} from "./getMetadata";

package/src/listDirectoryEntery.ts ADDED Viewed

@@ -0,0 +1,50 @@
+import { Connection } from "@solana/web3.js"
+export interface RpcRequest {
+  jsonrpc: string
+  id: number
+  method: string
+  params: any[]
+}
+/**
+ * Sends a JSON-RPC request to the Xandeum RPC endpoint to list all entries (files and subdirectories)
+ * within a specified path.
+ *
+ * This function calls the custom RPC method `listDirs`, which is  return an array of
+ * directory entry metadata — names, types etc.
+ *
+ * @param connection - The solana web3 connection with Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
+ * @param path - The  filesystem path representing the directory to list (e.g., `/documents`).
+ *
+ * @returns A `Promise<any>` resolving to the parsed JSON response from the RPC server,
+ *          typically including a `result` array containing directory entry objects.
+ */
+export async function listDirectoryEntry (
+  connection: Connection,
+  path: string,
+): Promise<any> {
+  const url = connection.rpcEndpoint;
+  const requestBody: RpcRequest = {
+    jsonrpc: '2.0',
+    id: 1,
+    method: 'listDirs',
+    params: [path]
+  }
+  const response = await fetch(url, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    body: JSON.stringify(requestBody)
+  })
+  if (!response.ok) {
+    throw new Error(`HTTP error! Status: ${response.status}`)
+  }
+  const data = await response.json()
+  return data
+}

package/src/peek.ts ADDED Viewed

@@ -0,0 +1,52 @@
+import { Transaction, TransactionInstruction, PublicKey } from '@solana/web3.js'
+import BN from 'bn.js'
+import { programId } from './const'
+import { sanitizePath } from './sanitizePath'
+/**
+ * Constructs a Solana transaction to perform a "peek" operation on a file within a file system.
+ *
+ * The peek operation reads data between two byte offsets within a specified file path.
+ *
+ * @param fsid - A stringified integer representing the file system ID in which the file resides.
+ * @param path - The path to the file to be peeked.
+ * @param startPosition - The starting byte offset (inclusive) to begin reading from.
+ * @param endPosition - The ending byte offset (exclusive) to stop reading at.
+ * @param wallet - The public key of the wallet that will sign and authorize the transaction.
+ * @returns A Promise that resolves to a Solana `Transaction` object containing the peek instruction.
+ * @throws Will throw an error if the `path` contains invalid characters.
+ */
+export async function peek (
+  fsid: string,
+  path: string,
+  startPosition: number,
+  endPosition: number,
+  wallet: PublicKey
+): Promise<Transaction> {
+  sanitizePath(path)
+  const rest = Buffer.from(`${path}`, 'utf-8')
+  const instructionData = Buffer.concat([
+    Buffer.from(Int8Array.from([3]).buffer),
+    Buffer.from(Uint8Array.of(...new BN(fsid).toArray('le', 8))),
+    Buffer.from(Uint8Array.of(...new BN(startPosition).toArray('le', 8))),
+    Buffer.from(Uint8Array.of(...new BN(endPosition).toArray('le', 8))),
+    rest
+  ])
+  const instruction = new TransactionInstruction({
+    keys: [
+      {
+        pubkey: wallet,
+        isSigner: true,
+        isWritable: true
+      }
+    ],
+    programId: new PublicKey(programId),
+    data: instructionData
+  })
+  const tx = new Transaction().add(instruction)
+  return tx
+}