@xandeum/web3.js 0.4.0

package/docs/markdown/functions/createFile.md

@@ -0,0 +1,50 @@
+[**Xandeum Web3 Library v1.12.0**](../README.md)
+
+***
+
+[Xandeum Web3 Library](../globals.md) / createFile
+
+# Function: createFile()
+
+> **createFile**(`fsid`, `path`, `name`, `wallet`): `Promise`\<`Transaction`\>
+
+Defined in: [createFile.ts:17](https://github.com/Xandeum/xandeum-web3.js/blob/master/src/createFile.ts#L17)
+
+Constructs a Solana transaction to create a new file
+within a file system, identified by a file system ID (`fsid`).
+
+## Parameters
+
+### fsid
+
+`string`
+
+A stringified integer representing the file system ID where the file is to be created.
+
+### path
+
+`string`
+
+The absolute or relative path within the file system where the file should be created.
+
+### name
+
+`string`
+
+The name of the new file or directory to be created.
+
+### wallet
+
+`PublicKey`
+
+The public key of the wallet that will sign and authorize the transaction.
+
+## Returns
+
+`Promise`\<`Transaction`\>
+
+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.

package/docs/markdown/functions/exists.md

@@ -0,0 +1,37 @@
+[**Xandeum Web3 Library v1.12.0**](../README.md)
+
+***
+
+[Xandeum Web3 Library](../globals.md) / exists
+
+# Function: exists()
+
+> **exists**(`connection`, `path`): `Promise`\<`any`\>
+
+Defined in: [exists.ts:23](https://github.com/Xandeum/xandeum-web3.js/blob/master/src/exists.ts#L23)
+
+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.
+
+## Parameters
+
+### connection
+
+`Connection`
+
+The solana web3 connection with Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
+
+### path
+
+`string`
+
+The filesystem path to check (e.g., `/documents/myfile.txt`).
+
+## Returns
+
+`Promise`\<`any`\>
+
+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.

package/docs/markdown/functions/getMetadata.md

@@ -0,0 +1,39 @@
+[**Xandeum Web3 Library v1.12.0**](../README.md)
+
+***
+
+[Xandeum Web3 Library](../globals.md) / getMetadata
+
+# Function: getMetadata()
+
+> **getMetadata**(`connection`, `path`): `Promise`\<`any`\>
+
+Defined in: [getMetadata.ts:26](https://github.com/Xandeum/xandeum-web3.js/blob/master/src/getMetadata.ts#L26)
+
+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.
+
+## Parameters
+
+### connection
+
+`Connection`
+
+The solana web3 connection with Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
+
+### path
+
+`string`
+
+The filesystem path to query metadata for (e.g., `/documents/myfile.txt`).
+
+## Returns
+
+`Promise`\<`any`\>
+
+A `Promise<any>` resolving to the parsed JSON response from the RPC server,
+         typically containing a `result` object with metadata fields.

package/docs/markdown/functions/getXandeumResult.md

@@ -0,0 +1,38 @@
+[**Xandeum Web3 Library v1.12.0**](../README.md)
+
+***
+
+[Xandeum Web3 Library](../globals.md) / getXandeumResult
+
+# Function: getXandeumResult()
+
+> **getXandeumResult**(`connection`, `signature`): `Promise`\<`any`\>
+
+Defined in: [getXandeumResult.ts:21](https://github.com/Xandeum/xandeum-web3.js/blob/master/src/getXandeumResult.ts#L21)
+
+Sends a JSON-RPC request to the Xandeum-compatible endpoint to retrieve
+the result of a transaction previously submitted with a specific signature.
+
+This function calls the custom RPC method `getXandeumResult`, which returns
+the result associated with the given transaction signature.
+
+## Parameters
+
+### connection
+
+`Connection`
+
+The Solana web3 connection object pointing to a Xandeum-compatible RPC endpoint.
+
+### signature
+
+`string`
+
+The transaction signature string whose result should be queried.
+
+## Returns
+
+`Promise`\<`any`\>
+
+A `Promise<any>` resolving to the parsed JSON response from the RPC server,
+         which includes the result of the transaction if available.

package/docs/markdown/functions/listDirectoryEntry.md

@@ -0,0 +1,38 @@
+[**Xandeum Web3 Library v1.12.0**](../README.md)
+
+***
+
+[Xandeum Web3 Library](../globals.md) / listDirectoryEntry
+
+# Function: listDirectoryEntry()
+
+> **listDirectoryEntry**(`connection`, `path`): `Promise`\<`any`\>
+
+Defined in: [listDirectoryEntery.ts:24](https://github.com/Xandeum/xandeum-web3.js/blob/master/src/listDirectoryEntery.ts#L24)
+
+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.
+
+## Parameters
+
+### connection
+
+`Connection`
+
+The solana web3 connection with Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
+
+### path
+
+`string`
+
+The  filesystem path representing the directory to list (e.g., `/documents`).
+
+## Returns
+
+`Promise`\<`any`\>
+
+A `Promise<any>` resolving to the parsed JSON response from the RPC server,
+         typically including a `result` array containing directory entry objects.

package/docs/markdown/functions/move.md

@@ -0,0 +1,55 @@
+[**Xandeum Web3 Library v1.12.0**](../README.md)
+
+***
+
+[Xandeum Web3 Library](../globals.md) / move
+
+# Function: move()
+
+> **move**(`fsid`, `srcPath`, `destPath`, `name`, `wallet`): `Promise`\<`Transaction`\>
+
+Defined in: [move.ts:19](https://github.com/Xandeum/xandeum-web3.js/blob/master/src/move.ts#L19)
+
+Constructs a Solana transaction to copy a file or directory from one  path to another.
+
+## Parameters
+
+### fsid
+
+`string`
+
+The unique numeric identifier representing the target file system.
+
+### srcPath
+
+`string`
+
+The source path to copy from (e.g., `/documents`).
+
+### destPath
+
+`string`
+
+The destination path to copy to (e.g., `/archive`).
+
+### name
+
+`string`
+
+The name of the new file or directory at the destination (e.g., `report.txt`).
+
+### wallet
+
+`PublicKey`
+
+The wallet public key used to sign and authorize the transaction.
+
+## Returns
+
+`Promise`\<`Transaction`\>
+
+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.

package/docs/markdown/functions/peek.md

@@ -0,0 +1,57 @@
+[**Xandeum Web3 Library v1.12.0**](../README.md)
+
+***
+
+[Xandeum Web3 Library](../globals.md) / peek
+
+# Function: peek()
+
+> **peek**(`fsid`, `path`, `startPosition`, `endPosition`, `wallet`): `Promise`\<`Transaction`\>
+
+Defined in: [peek.ts:20](https://github.com/Xandeum/xandeum-web3.js/blob/master/src/peek.ts#L20)
+
+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.
+
+## Parameters
+
+### fsid
+
+`string`
+
+A stringified integer representing the file system ID in which the file resides.
+
+### path
+
+`string`
+
+The path to the file to be peeked.
+
+### startPosition
+
+`number`
+
+The starting byte offset (inclusive) to begin reading from.
+
+### endPosition
+
+`number`
+
+The ending byte offset (exclusive) to stop reading at.
+
+### wallet
+
+`PublicKey`
+
+The public key of the wallet that will sign and authorize the transaction.
+
+## Returns
+
+`Promise`\<`Transaction`\>
+
+A Promise that resolves to a Solana `Transaction` object containing the peek instruction.
+
+## Throws
+
+Will throw an error if the `path` contains invalid characters.

package/docs/markdown/functions/poke.md

@@ -0,0 +1,56 @@
+[**Xandeum Web3 Library v1.12.0**](../README.md)
+
+***
+
+[Xandeum Web3 Library](../globals.md) / poke
+
+# Function: poke()
+
+> **poke**(`fsid`, `path`, `position`, `wallet`, `dataKey`): `Promise`\<`Transaction`\>
+
+Defined in: [poke.ts:19](https://github.com/Xandeum/xandeum-web3.js/blob/master/src/poke.ts#L19)
+
+Constructs a Solana transaction to perform a poke\operation, which writes data
+to a file at the specified path and byte position.
+
+## Parameters
+
+### fsid
+
+`string`
+
+A stringified integer representing the file system ID where the file resides.
+
+### path
+
+`string`
+
+The path to the file to be written to.
+
+### position
+
+`number`
+
+The byte offset in the file where data should be written.
+
+### wallet
+
+`PublicKey`
+
+The public key of the wallet that signs and authorizes the transaction.
+
+### dataKey
+
+`PublicKey`
+
+A public key of a data account that holds the content to be written to the file.
+
+## Returns
+
+`Promise`\<`Transaction`\>
+
+A Promise that resolves to a Solana `Transaction` object containing the poke instruction.
+
+## Throws
+
+Will throw an error if the `path` contains invalid characters.

package/docs/markdown/functions/removeDirectory.md

@@ -0,0 +1,44 @@
+[**Xandeum Web3 Library v1.12.0**](../README.md)
+
+***
+
+[Xandeum Web3 Library](../globals.md) / removeDirectory
+
+# Function: removeDirectory()
+
+> **removeDirectory**(`fsid`, `path`, `wallet`): `Promise`\<`Transaction`\>
+
+Defined in: [removeDirectory.ts:17](https://github.com/Xandeum/xandeum-web3.js/blob/master/src/removeDirectory.ts#L17)
+
+Constructs a Solana transaction to perform a "remove directory" operation
+in a  file system, identified by a file system ID (`fsid`).
+
+## Parameters
+
+### fsid
+
+`string`
+
+A stringified integer representing the file system ID containing the directory.
+
+### path
+
+`string`
+
+The full path to the directory that should be removed.
+
+### wallet
+
+`PublicKey`
+
+The public key of the wallet that will sign and authorize the transaction.
+
+## Returns
+
+`Promise`\<`Transaction`\>
+
+A Promise that resolves to a Solana `Transaction` object containing the remove directory instruction.
+
+## Throws
+
+May throw an error if the `path` fails validation in `sanitizePath`.

package/docs/markdown/functions/removeFile.md

@@ -0,0 +1,44 @@
+[**Xandeum Web3 Library v1.12.0**](../README.md)
+
+***
+
+[Xandeum Web3 Library](../globals.md) / removeFile
+
+# Function: removeFile()
+
+> **removeFile**(`fsid`, `path`, `wallet`): `Promise`\<`Transaction`\>
+
+Defined in: [removeFile.ts:17](https://github.com/Xandeum/xandeum-web3.js/blob/master/src/removeFile.ts#L17)
+
+Constructs a Solana transaction to remove a file from a  file system,
+identified by a file system ID (`fsid`) and a UTF-8 encoded file path.
+
+## Parameters
+
+### fsid
+
+`string`
+
+A stringified integer representing the file system ID in which the file resides.
+
+### path
+
+`string`
+
+The full path to the file to be deleted.
+
+### wallet
+
+`PublicKey`
+
+The public key of the wallet that signs and authorizes the transaction.
+
+## Returns
+
+`Promise`\<`Transaction`\>
+
+A Promise that resolves to a Solana `Transaction` object containing the remove file instruction.
+
+## Throws
+
+May throw an error if `path` is invalid per `sanitizePath`.

package/docs/markdown/functions/renamePath.md

@@ -0,0 +1,50 @@
+[**Xandeum Web3 Library v1.12.0**](../README.md)
+
+***
+
+[Xandeum Web3 Library](../globals.md) / renamePath
+
+# Function: renamePath()
+
+> **renamePath**(`fsid`, `oldPath`, `name`, `wallet`): `Promise`\<`Transaction`\>
+
+Defined in: [renamePath.ts:18](https://github.com/Xandeum/xandeum-web3.js/blob/master/src/renamePath.ts#L18)
+
+Constructs a Solana transaction to rename (or move) a file or directory
+within a file system, based on a provided file system ID (`fsid`).
+
+## Parameters
+
+### fsid
+
+`string`
+
+A stringified integer representing the file system ID where the path exists.
+
+### oldPath
+
+`string`
+
+The current path of the file or directory to be renamed or moved.
+
+### name
+
+`string`
+
+The new name to assign to the file or directory.
+
+### wallet
+
+`PublicKey`
+
+The public key of the wallet that signs and authorizes the transaction.
+
+## Returns
+
+`Promise`\<`Transaction`\>
+
+A Promise that resolves to a Solana `Transaction` object containing the rename path instruction.
+
+## Throws
+
+May throw an error if either `oldPath` or `newPath` is invalid per `sanitizePath`.

package/docs/markdown/functions/subscribeResult.md

@@ -0,0 +1,60 @@
+[**Xandeum Web3 Library v1.12.0**](../README.md)
+
+***
+
+[Xandeum Web3 Library](../globals.md) / subscribeResult
+
+# Function: subscribeResult()
+
+> **subscribeResult**(`connection`, `tx`, `onResult`, `onError?`, `onClose?`): `void`
+
+Defined in: [webSocket.ts:40](https://github.com/Xandeum/xandeum-web3.js/blob/master/src/webSocket.ts#L40)
+
+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
+
+### connection
+
+`Connection`
+
+The solana web3 connection with Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
+
+### tx
+
+`string`
+
+The transaction ID you want to listen for results from.
+
+### 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

@@ -0,0 +1,34 @@
+[**Xandeum Web3 Library v1.12.0**](../README.md)
+
+***
+
+[Xandeum Web3 Library](../globals.md) / unsubscribeResult
+
+# Function: unsubscribeResult()
+
+> **unsubscribeResult**(`connection`, `subscriptionId`): `void`
+
+Defined in: [webSocket.ts:103](https://github.com/Xandeum/xandeum-web3.js/blob/master/src/webSocket.ts#L103)
+
+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
+
+### connection
+
+`Connection`
+
+The solana web3 connection with Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
+
+### subscriptionId
+
+`string`
+
+The ID of the active subscription you want to cancel.
+
+## Returns
+
+`void`

package/docs/markdown/globals.md

@@ -0,0 +1,25 @@
+[**Xandeum Web3 Library v1.12.0**](README.md)
+
+***
+
+# Xandeum Web3 Library v1.12.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)
+- [getXandeumResult](functions/getXandeumResult.md)
+- [listDirectoryEntry](functions/listDirectoryEntry.md)
+- [move](functions/move.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/markdown/summary.md

@@ -0,0 +1,44 @@
+# Summary
+
+## Getting Started
+
+* [Introduction](README.md)
+* [Globals](globals.md)
+
+## Core Functions
+
+### File System Management
+
+* [bigbang](functions/bigbang.md)
+* [armageddon](functions/armageddon.md)
+
+### File Operations
+
+* [createFile](functions/createFile.md)
+* [removeFile](functions/removeFile.md)
+* [copyPath](functions/copyPath.md)
+* [renamePath](functions/renamePath.md)
+* [move](functions/move.md)
+
+### Directory Operations
+
+* [createDirectory](functions/createDirectory.md)
+* [removeDirectory](functions/removeDirectory.md)
+* [listDirectoryEntry](functions/listDirectoryEntry.md)
+
+### File Content Operations
+
+* [peek](functions/peek.md)
+* [poke](functions/poke.md)
+
+### Metadata & Utilities
+
+* [exists](functions/exists.md)
+* [getMetadata](functions/getMetadata.md)
+* [getXandeumResult](functions/getXandeumResult.md)
+
+### WebSocket Functions
+
+* [subscribeResult](functions/subscribeResult.md)
+* [unsubscribeResult](functions/unsubscribeResult.md)
+