@xandeum/web3.js 1.2.0 → 1.3.1

package/docs/markdown/functions/assignCoowner.md

@@ -0,0 +1,46 @@
+[**Xandeum Web3 Library v0.8.1**](../README.md)
+
+***
+
+[Xandeum Web3 Library](../globals.md) / assignCoowner
+
+# Function: assignCoowner()
+
+> **assignCoowner**(`fsid`, `path`, `coowner`, `wallet`): `Promise`\<`Transaction`\>
+
+Defined in: [assignCoowner.ts:15](https://github.com/Xandeum/xandeum-web3.js/blob/reinheim/src/assignCoowner.ts#L15)
+
+Constructs a Solana transaction to assign a co-owner to a file or directory
+identified by a file system ID (`fsid`).
+
+## Parameters
+
+### fsid
+
+`string`
+
+A stringified integer representing the file system ID where the co-owner is to be assigned.
+
+### path
+
+`string`
+
+The path within the file system.
+
+### coowner
+
+`PublicKey`
+
+The public key of the co-owner to be assigned.
+
+### 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 assignCoowner instruction.

package/docs/markdown/functions/bigbang.md

@@ -1,4 +1,4 @@
-[**Xandeum Web3 Library v9.2.0**](../README.md)
+[**Xandeum Web3 Library v0.8.1**](../README.md)
 
 ***
 
@@ -6,14 +6,20 @@
 
 # Function: bigbang()
 
-> **bigbang**(`wallet`): `Promise`\<`Transaction`\>
+> **bigbang**(`replica_count`, `wallet`): `Promise`\<`Transaction`\>
 
-Defined in: [bigbang.ts:10](https://github.com/Xandeum/test_web3/blob/main/src/bigbang.ts#L10)
+Defined in: [bigbang.ts:12](https://github.com/Xandeum/xandeum-web3.js/blob/reinheim/src/bigbang.ts#L12)
 
 Constructs a Solana transaction that triggers the "bigbang" instruction and create new file system.
 
 ## Parameters
 
+### replica\_count
+
+`string`
+
+A stringified integer representing the number of replicas for the new file system. Must be 2 or greater. The total number of copies will be replica_count + 1 (one original plus the replicas).
+
 ### wallet
 
 `PublicKey`

package/docs/markdown/functions/copyPath.md

@@ -1,4 +1,4 @@
-[**Xandeum Web3 Library v9.2.0**](../README.md)
+[**Xandeum Web3 Library v0.8.1**](../README.md)
 
 ***
 
@@ -8,7 +8,7 @@
 
 > **copyPath**(`fsid`, `srcPath`, `destPath`, `wallet`): `Promise`\<`Transaction`\>
 
-Defined in: [copyPath.ts:18](https://github.com/Xandeum/test_web3/blob/main/src/copyPath.ts#L18)
+Defined in: [copyPath.ts:18](https://github.com/Xandeum/xandeum-web3.js/blob/reinheim/src/copyPath.ts#L18)
 
 Constructs a Solana transaction to copy a file or directory from one  path to another.
 

package/docs/markdown/functions/createDirectory.md

@@ -1,4 +1,4 @@
-[**Xandeum Web3 Library v9.2.0**](../README.md)
+[**Xandeum Web3 Library v0.8.1**](../README.md)
 
 ***
 
@@ -8,7 +8,7 @@
 
 > **createDirectory**(`fsid`, `path`, `name`, `wallet`): `Promise`\<`Transaction`\>
 
-Defined in: [createDirectory.ts:17](https://github.com/Xandeum/test_web3/blob/main/src/createDirectory.ts#L17)
+Defined in: [createDirectory.ts:17](https://github.com/Xandeum/xandeum-web3.js/blob/reinheim/src/createDirectory.ts#L17)
 
 Constructs a Solana transaction to create a new directory within a  file system.
 

package/docs/markdown/functions/createFile.md

@@ -1,4 +1,4 @@
-[**Xandeum Web3 Library v9.2.0**](../README.md)
+[**Xandeum Web3 Library v0.8.1**](../README.md)
 
 ***
 
@@ -8,7 +8,7 @@
 
 > **createFile**(`fsid`, `path`, `name`, `wallet`): `Promise`\<`Transaction`\>
 
-Defined in: [createFile.ts:17](https://github.com/Xandeum/test_web3/blob/main/src/createFile.ts#L17)
+Defined in: [createFile.ts:17](https://github.com/Xandeum/xandeum-web3.js/blob/reinheim/src/createFile.ts#L17)
 
 Constructs a Solana transaction to create a new file
 within a file system, identified by a file system ID (`fsid`).

package/docs/markdown/functions/exists.md

@@ -1,4 +1,4 @@
-[**Xandeum Web3 Library v9.2.0**](../README.md)
+[**Xandeum Web3 Library v0.8.1**](../README.md)
 
 ***
 
@@ -6,9 +6,9 @@
 
 # Function: exists()
 
-> **exists**(`path`, `url`): `Promise`\<`any`\>
+> **exists**(`connection`, `path`): `Promise`\<`any`\>
 
-Defined in: [exists.ts:22](https://github.com/Xandeum/test_web3/blob/main/src/exists.ts#L22)
+Defined in: [exists.ts:23](https://github.com/Xandeum/xandeum-web3.js/blob/reinheim/src/exists.ts#L23)
 
 Sends a JSON-RPC request to the Xandeum RPC endpoint to check if a file or directory exists.
 
@@ -17,17 +17,17 @@ by the backend to validate the existence of metadata (files/directories) at a gi
 
 ## Parameters
 
-### path
+### connection
 
-`string`
+`Connection`
 
-The filesystem path to check (e.g., `/documents/myfile.txt`).
+The solana web3 connection with Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
 
-### url
+### path
 
 `string`
 
-The full URL of the Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
+The filesystem path to check (e.g., `/documents/myfile.txt`).
 
 ## Returns
 

package/docs/markdown/functions/find.md

@@ -0,0 +1,44 @@
+[**Xandeum Web3 Library v0.8.1**](../README.md)
+
+***
+
+[Xandeum Web3 Library](../globals.md) / find
+
+# Function: find()
+
+> **find**(`connection`, `path`, `query`): `Promise`\<`any`\>
+
+Defined in: [find.ts:25](https://github.com/Xandeum/xandeum-web3.js/blob/reinheim/src/find.ts#L25)
+
+Sends a JSON-RPC request to the Xandeum RPC endpoint to search for a file or directory
+within a specified path.
+
+This function calls the custom RPC method `find`, 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 where the search will be performed (e.g., `/documents`).
+
+### query
+
+`string`
+
+The query to search for (e.g., `'myfile.txt'`).
+
+## 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/getMetadata.md

@@ -1,4 +1,4 @@
-[**Xandeum Web3 Library v9.2.0**](../README.md)
+[**Xandeum Web3 Library v0.8.1**](../README.md)
 
 ***
 
@@ -6,9 +6,9 @@
 
 # Function: getMetadata()
 
-> **getMetadata**(`path`, `url`): `Promise`\<`any`\>
+> **getMetadata**(`connection`, `path`): `Promise`\<`any`\>
 
-Defined in: [getMetadata.ts:24](https://github.com/Xandeum/test_web3/blob/main/src/getMetadata.ts#L24)
+Defined in: [getMetadata.ts:26](https://github.com/Xandeum/xandeum-web3.js/blob/reinheim/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.
@@ -19,17 +19,17 @@ timestamps etc.
 
 ## Parameters
 
-### path
+### connection
 
-`string`
+`Connection`
 
-The filesystem path to query metadata for (e.g., `/documents/myfile.txt`).
+The solana web3 connection with Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
 
-### url
+### path
 
 `string`
 
-The full URL of the Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
+The filesystem path to query metadata for (e.g., `/documents/myfile.txt`).
 
 ## Returns
 

package/docs/markdown/functions/getXandeumResult.md

@@ -0,0 +1,38 @@
+[**Xandeum Web3 Library v0.8.1**](../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/reinheim/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

@@ -1,4 +1,4 @@
-[**Xandeum Web3 Library v9.2.0**](../README.md)
+[**Xandeum Web3 Library v0.8.1**](../README.md)
 
 ***
 
@@ -6,9 +6,9 @@
 
 # Function: listDirectoryEntry()
 
-> **listDirectoryEntry**(`path`, `url`): `Promise`\<`any`\>
+> **listDirectoryEntry**(`connection`, `path`): `Promise`\<`any`\>
 
-Defined in: [listDirectoryEntery.ts:22](https://github.com/Xandeum/test_web3/blob/main/src/listDirectoryEntery.ts#L22)
+Defined in: [listDirectoryEntery.ts:24](https://github.com/Xandeum/xandeum-web3.js/blob/reinheim/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.
@@ -18,17 +18,17 @@ directory entry metadata — names, types etc.
 
 ## Parameters
 
-### path
+### connection
 
-`string`
+`Connection`
 
-The  filesystem path representing the directory to list (e.g., `/documents`).
+The solana web3 connection with Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
 
-### url
+### path
 
 `string`
 
-The full URL of the Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
+The  filesystem path representing the directory to list (e.g., `/documents`).
 
 ## Returns
 

package/docs/markdown/functions/move.md

@@ -0,0 +1,55 @@
+[**Xandeum Web3 Library v0.8.1**](../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/reinheim/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

@@ -1,4 +1,4 @@
-[**Xandeum Web3 Library v9.2.0**](../README.md)
+[**Xandeum Web3 Library v0.8.1**](../README.md)
 
 ***
 
@@ -8,7 +8,7 @@
 
 > **peek**(`fsid`, `path`, `startPosition`, `endPosition`, `wallet`): `Promise`\<`Transaction`\>
 
-Defined in: [peek.ts:20](https://github.com/Xandeum/test_web3/blob/main/src/peek.ts#L20)
+Defined in: [peek.ts:20](https://github.com/Xandeum/xandeum-web3.js/blob/reinheim/src/peek.ts#L20)
 
 Constructs a Solana transaction to perform a "peek" operation on a file within a file system.
 

package/docs/markdown/functions/poke.md

@@ -1,4 +1,4 @@
-[**Xandeum Web3 Library v9.2.0**](../README.md)
+[**Xandeum Web3 Library v0.8.1**](../README.md)
 
 ***
 
@@ -8,7 +8,7 @@
 
 > **poke**(`fsid`, `path`, `position`, `wallet`, `dataKey`): `Promise`\<`Transaction`\>
 
-Defined in: [poke.ts:19](https://github.com/Xandeum/test_web3/blob/main/src/poke.ts#L19)
+Defined in: [poke.ts:19](https://github.com/Xandeum/xandeum-web3.js/blob/reinheim/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.

package/docs/markdown/functions/removeDirectory.md

@@ -1,4 +1,4 @@
-[**Xandeum Web3 Library v9.2.0**](../README.md)
+[**Xandeum Web3 Library v0.8.1**](../README.md)
 
 ***
 
@@ -8,7 +8,7 @@
 
 > **removeDirectory**(`fsid`, `path`, `wallet`): `Promise`\<`Transaction`\>
 
-Defined in: [removeDirectory.ts:17](https://github.com/Xandeum/test_web3/blob/main/src/removeDirectory.ts#L17)
+Defined in: [removeDirectory.ts:17](https://github.com/Xandeum/xandeum-web3.js/blob/reinheim/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`).

package/docs/markdown/functions/removeFile.md

@@ -1,4 +1,4 @@
-[**Xandeum Web3 Library v9.2.0**](../README.md)
+[**Xandeum Web3 Library v0.8.1**](../README.md)
 
 ***
 
@@ -8,7 +8,7 @@
 
 > **removeFile**(`fsid`, `path`, `wallet`): `Promise`\<`Transaction`\>
 
-Defined in: [removeFile.ts:17](https://github.com/Xandeum/test_web3/blob/main/src/removeFile.ts#L17)
+Defined in: [removeFile.ts:17](https://github.com/Xandeum/xandeum-web3.js/blob/reinheim/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.

package/docs/markdown/functions/renamePath.md

@@ -1,4 +1,4 @@
-[**Xandeum Web3 Library v9.2.0**](../README.md)
+[**Xandeum Web3 Library v0.8.1**](../README.md)
 
 ***
 
@@ -8,7 +8,7 @@
 
 > **renamePath**(`fsid`, `oldPath`, `name`, `wallet`): `Promise`\<`Transaction`\>
 
-Defined in: [renamePath.ts:18](https://github.com/Xandeum/test_web3/blob/main/src/renamePath.ts#L18)
+Defined in: [renamePath.ts:18](https://github.com/Xandeum/xandeum-web3.js/blob/reinheim/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`).

package/docs/markdown/functions/subscribeResult.md

@@ -1,4 +1,4 @@
-[**Xandeum Web3 Library v9.2.0**](../README.md)
+[**Xandeum Web3 Library v0.8.1**](../README.md)
 
 ***
 
@@ -6,9 +6,9 @@
 
 # Function: subscribeResult()
 
-> **subscribeResult**(`tx`, `wsUrl`, `onResult`, `onError?`, `onClose?`): `void`
+> **subscribeResult**(`connection`, `tx`, `onResult`, `onError?`, `onClose?`): `void`
 
-Defined in: [webSocket.ts:38](https://github.com/Xandeum/test_web3/blob/main/src/webSocket.ts#L38)
+Defined in: [webSocket.ts:40](https://github.com/Xandeum/xandeum-web3.js/blob/reinheim/src/webSocket.ts#L40)
 
 Opens a WebSocket connection and subscribes to the result of a transaction
 via the custom `xandeumResultSubscribe` method.
@@ -25,17 +25,17 @@ if a valid result with `fsid`, `status`, or `data` is received.
 
 ## Parameters
 
-### tx
+### connection
 
-`string`
+`Connection`
 
-The transaction ID you want to listen for results from.
+The solana web3 connection with Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
 
-### wsUrl
+### tx
 
 `string`
 
-The full WebSocket endpoint (e.g., `wss://...`) to connect to.
+The transaction ID you want to listen for results from.
 
 ### onResult
 

package/docs/markdown/functions/unsubscribeResult.md

@@ -1,4 +1,4 @@
-[**Xandeum Web3 Library v9.2.0**](../README.md)
+[**Xandeum Web3 Library v0.8.1**](../README.md)
 
 ***
 
@@ -6,9 +6,9 @@
 
 # Function: unsubscribeResult()
 
-> **unsubscribeResult**(`subscriptionId`, `wsUrl`): `void`
+> **unsubscribeResult**(`connection`, `subscriptionId`): `void`
 
-Defined in: [webSocket.ts:93](https://github.com/Xandeum/test_web3/blob/main/src/webSocket.ts#L93)
+Defined in: [webSocket.ts:103](https://github.com/Xandeum/xandeum-web3.js/blob/reinheim/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).
@@ -17,17 +17,17 @@ This function automatically closes the WebSocket connection after sending the un
 
 ## Parameters
 
-### subscriptionId
+### connection
 
-`string`
+`Connection`
 
-The ID of the active subscription you want to cancel.
+The solana web3 connection with Xandeum-compatible JSON-RPC endpoint (e.g., `'https://api.devnet.solana.com'`).
 
-### wsUrl
+### subscriptionId
 
 `string`
 
-The WebSocket endpoint (e.g., `wss://...`) to connect to for unsubscribing.
+The ID of the active subscription you want to cancel.
 
 ## Returns
 

package/docs/markdown/globals.md

@@ -1,19 +1,23 @@
-[**Xandeum Web3 Library v9.2.0**](README.md)
+[**Xandeum Web3 Library v0.8.1**](README.md)
 
 ***
 
-# Xandeum Web3 Library v9.2.0
+# Xandeum Web3 Library v0.8.1
 
 ## Functions
 
 - [armageddon](functions/armageddon.md)
+- [assignCoowner](functions/assignCoowner.md)
 - [bigbang](functions/bigbang.md)
 - [copyPath](functions/copyPath.md)
 - [createDirectory](functions/createDirectory.md)
 - [createFile](functions/createFile.md)
 - [exists](functions/exists.md)
+- [find](functions/find.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)

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@xandeum/web3.js",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "description": "Xandeum javascript api",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc",
-    "deploy-docs": "typedoc && gh-pages -d docs"
+    "deploy-docs": "typedoc && gh-pages -d docs/html"
   },
   "author": "",
-  "license": "MIT",
+  "license": "Apache-2.0",
   "publishConfig": {
     "access": "public"
   },

package/src/armageddon.ts

@@ -1,6 +1,7 @@
 import { Transaction, TransactionInstruction, PublicKey } from '@solana/web3.js'
 import BN from 'bn.js'
 import { programId } from './const.js'
+import { getFeeDistributorPda } from './helpers.js'
 
 /**
  * Constructs a Solana transaction that triggers the "armageddon" instruction
@@ -15,9 +16,11 @@ export async function armageddon (
   wallet: PublicKey
 ): Promise<Transaction> {
   const instructionData = Buffer.concat([
+    Buffer.from(Int8Array.from([0]).buffer),
     Buffer.from(Int8Array.from([1]).buffer),
     Buffer.from(Uint8Array.of(...new BN(fsid).toArray('le', 8)))
   ])
+  let feeDistributorPda = getFeeDistributorPda()
 
   const instruction = new TransactionInstruction({
     keys: [
@@ -25,6 +28,11 @@ export async function armageddon (
         pubkey: wallet,
         isSigner: true,
         isWritable: true
+      },
+      {
+        pubkey: feeDistributorPda.pda,
+        isSigner: false,
+        isWritable: true
       }
     ],
     programId: new PublicKey(programId),