Add docs: js Spawn and IPC interface

Author: joii2020

website/docs/script/js/js-api-ipc.mdx

@@ -0,0 +1,164 @@
+---
+id: js-api-ipc
+title: "API (IPC)"
+---
+
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
+import Link from "@docusaurus/Link";
+import TutorialHeader from "@components/TutorialHeader";
+import Tooltip from "@components/Tooltip";
+import ScriptTools from "./../_ScriptTools.mdx";
+
+# IPC
+
+As mentioned in the previous chapter on [JS Syscalls](./js-api-syscalls), `ckb-js-vm` supports [Spawn](../spawn-cross-script-calling). Building on top of Spawn, we implemented an additional abstraction layer called [IPC](../ckb-ipc), which also provides a similar set of APIs for use in JavaScript.
+
+(While using JavaScript as a server is technically supported, the overhead of `ckb-js-vm` is significant, so we do **not** recommend doing so.)
+
+## `spawnCellServer`
+
+Spawns a new IPC server process using the provided code hash and hash type.
+
+### Syntax
+
+```typescript
+export function spawnCellServer(
+  codeHash: ArrayBuffer,
+  hashType: number,
+  argv: string[]
+): [Pipe, Pipe];
+```
+
+### Parameters
+
+- `codeHash`: The code hash to search for (must be 32 bytes)
+- `hashType`: The type of hash to search for (type or data)
+- `argv`: An array of strings representing the arguments to pass to the new process.
+
+### Return
+
+A tuple of two `Pipe` objects representing the read and write pipes for the parent process, or throws an `Error` if an error occurs.
+
+## spawnServer
+
+Same to spawnCellServer, but spawn from a specified source
+
+### Syntax
+
+```typescript
+export function spawnServer(
+  index: number,
+  source: SourceType,
+  argv: string[],
+): [Pipe, Pipe] {
+```
+
+### Parameters
+
+- `index` : The index of the source to spawn from
+- `source` : The type of source (use SOURCE\_\* constants)
+- `argv`: An array of strings representing the arguments to pass to the new process.
+
+### Return
+
+A tuple of two `Pipe` objects representing the read and write pipes for the parent process, or throws an `Error` if an error occurs.
+
+## runServer
+
+Runs the server with the provided service implementation.
+This function listens for incoming requests, processes them using the provided service, and sends back the responses. It uses the inherited file descriptors for communication.
+
+### Syntax
+
+```typescript
+export function runServer(handler: RequestHandler): void;
+```
+
+### Parameters
+
+`handler` : The service implementation that handles the requests and generates the responses.
+
+### Return
+
+Never returns unless an error occurs, in which case it throws an `Error`.
+
+## Channel
+
+The `Channel` class facilitates IPC communication between a client and a server.
+It handles the transmission of requests from the client to the server and the reception of responses from the server to the client.
+
+## Channel.constructor
+
+Creates a new Channel instance
+
+### Syntax
+
+```typescript
+constructor(reader: Read, writer: Write);
+```
+
+### Parameters
+
+- `reader` : Responsible for reading data from the channel
+- `writer` : Responsible for writing data to the channel
+
+## Channel.execute
+
+Executes the server loop, processing incoming requests and sending responses.
+
+### Syntax
+
+```typescript
+execute(handler: RequestHandler): void
+```
+
+### Parameters
+
+`handler` : A service that handles requests and generates responses
+
+## Channel.call
+
+Sends a request to the server and waits for a response.
+
+This method handles the complete request-response cycle by sending the request to the server and then waiting for and returning the server's response.
+
+### Syntax
+
+```typescript
+call(req: RequestPacket): ResponsePacket
+```
+
+### Parameters
+
+- `req` : The request packet to send to the server
+
+### Return
+
+The response packet received from the server
+
+## Channel.sendErrorCode
+
+Sends an error code to the client
+
+### Syntax
+
+```typescript
+sendErrorCode(errorCode: number): void
+```
+
+### Parameters
+
+- `errorCode` - The error code to send
+
+## RequestHandler
+
+Interface for a service that can handle requests and generate responses
+
+### Syntax
+
+```typescript
+export interface RequestHandler {
+  serve(req: RequestPacket): ResponsePacket;
+}
+```

website/docs/script/js/js-api-syscalls.mdx

@@ -283,3 +283,178 @@ The tests in `tests/src/type-id.test.ts`.
 When minting, You need to create type-id through `inputCell` and `index` and check it in the contract. `check type-id minting success` and `check type-id minting failed`.
 
 When transaction, Will not check again. `check type-id transaction success`.
+
+## spawnCell
+
+Spawn a new process from a cell.
+
+### Syntax
+
+```typescript
+export function spawnCell(
+  codeHash: ArrayBuffer,
+  hashType: number,
+  offset: number,
+  length: number,
+  args: SpawnArgs
+): number;
+```
+
+### Parameters
+
+- `codeHash` : The code hash of the cell to spawn
+- `hashType` : The hash type of the code (use SCRIPT*HASH_TYPE*\* constants)
+- `offset` : The offset in the cell data (defaults to 0)
+- `length` : The length of code to execute (defaults to reading until the end)
+- `args` : Spawn arguments including argv and inherited file descriptors
+
+### Return
+
+The process ID of the spawned process
+
+## spawn
+
+Spawn a new process from a specified source.
+
+### Syntax
+
+```typescript
+export function spawn(
+  index: number,
+  source: SourceType,
+  offset: number,
+  length: number,
+  args: SpawnArgs
+): number;
+```
+
+### Parameters
+
+- `index` : The index of the source to spawn from
+- `source` : The type of source (use SOURCE\_\* constants)
+- `offset` : The offset in the source data (defaults to 0)
+- `length` : The length of code to execute (defaults to reading until the end)
+- `args` : Spawn arguments including argv and inherited file descriptors
+
+### Return
+
+The process ID of the spawned process
+
+## pipe
+
+Create a new pipe
+
+### Syntax
+
+```typescript
+export function pipe(): [number, number];
+```
+
+### Return
+
+A tuple of [read_fd, write_fd] for the pipe.
+
+## inheritedFds
+
+Get inherited file descriptors
+
+### Syntax
+
+```typescript
+export function inheritedFds(): number[];
+```
+
+### Return
+
+Array of inherited file descriptor numbers.
+
+## read
+
+Read from a file descriptor
+
+### Syntax
+
+```typescript
+export function read(fd: number, length: number): ArrayBuffer;
+```
+
+### Parameters
+
+- `fd` : The file descriptor to read from
+- `length` : Number of bytes to read
+
+### Return
+
+The read data as ArrayBuffer.
+
+### Remarks
+
+The length of returned data might be smaller than `length`.
+
+## write
+
+Write data to a file descriptor
+
+### Syntax
+
+```typescript
+export function write(fd: number, data: ArrayBuffer): void;
+```
+
+### Parameters
+
+- `fd` : The file descriptor to write to
+- `data` : The data to write as ArrayBuffer
+
+### Remarks
+
+All data will be written atomically - no partial writes will occur
+
+- - If the write cannot complete fully, it will throw an error
+- - The function blocks until all data is written
+
+## close
+
+Close a file descriptor
+
+### Syntax
+
+```typescript
+export function close(fd: number): void;
+```
+
+### Parameters
+
+- `fd` : The file descriptor to close
+
+## wait
+
+Wait for a process to exit
+
+### Syntax
+
+```typescript
+export function wait(pid: number): number;
+```
+
+### Parameters
+
+- `pid` : The process ID to wait for
+
+### Return
+
+The exit status of the process
+
+## processId
+
+Get the current process ID
+
+### Syntax
+
+```typescript
+export function processId(): number;
+```
+
+### Return
+
+The current process ID

website/sidebars.js

@@ -163,6 +163,7 @@ export default {
             "script/js/js-api-common-algorithms",
             "script/js/js-api-molecule",
             "script/js/js-api-other-utilities",
+            "script/js/js-api-ipc",
           ],
         },
       ],