Jannik/PaperClipAI

0 Fork 0

mirror of https://github.com/paperclipai/paperclip.git synced 2026-10-13 13:38:01 +02:00

Files

T

History

2bc88ca1c5 build(deps): bump ws and @types/ws (#15164 )

Bumps [ws](https://github.com/websockets/ws) and
[@types/ws](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/ws).
These dependencies needed to be updated together.
Updates `ws` from 8.21.3 to 8.22.0
<details>
<summary>Release notes</summary>
<p><em>Sourced from <a
href="https://github.com/websockets/ws/releases">ws's
releases</a>.</em></p>
<blockquote>
<h2>8.22.0</h2>
<h1>Features</h1>
<ul>
<li>Introduced the <code>protocols</code> option (8b918b01).</li>
</ul>
<h1>Bug fixes</h1>
<ul>
<li>Calling <code>websocket.close()</code> with invalid arguments no
longer transitions the
state to <code>WebSocket.CLOSING</code> (<a
href="https://redirect.github.com/websockets/ws/issues/2337">#2337</a>).</li>
</ul>
</blockquote>
</details>
<details>
<summary>Commits</summary>
<ul>
<li><a
href="https://github.com/websockets/ws/commit/297202cdae9b0590629821373b3b679c407f3431"><code>297202c</code></a>
[dist] 8.22.0</li>
<li><a
href="https://github.com/websockets/ws/commit/8b918b01c149c6e4ccb8051bace7f322db94ed8b"><code>8b918b0</code></a>
[feature] Introduce the <code>protocols</code> option</li>
<li><a
href="https://github.com/websockets/ws/commit/73e03eb35b1a84a3b28f906bab6a359231660695"><code>73e03eb</code></a>
[ci] Update actions/setup-node action to v7</li>
<li><a
href="https://github.com/websockets/ws/commit/d9b89544e627f2a260fb85a6f42c8ecba98d7615"><code>d9b8954</code></a>
[fix] Change the ready state after validating the arguments (<a
href="https://redirect.github.com/websockets/ws/issues/2337">#2337</a>)</li>
<li>See full diff in <a
href="https://github.com/websockets/ws/compare/8.21.3...8.22.0">compare
view</a></li>
</ul>
</details>
<br />

Updates `@types/ws` from 8.18.1 to 8.18.2
<details>
<summary>Commits</summary>
<ul>
<li>See full diff in <a
href="https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/ws">compare
view</a></li>
</ul>
</details>
<br />

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: nickyleach <331803+nickyleach@users.noreply.github.com>
Co-authored-by: Paperclip <noreply@paperclip.ing>

2026-10-09 09:27:45 -07:00

doc

Introduce bind presets for deployment setup

2026-04-11 07:09:07 -05:00

src

fix(runner): preserve task context when tool connections change (#14963 )

2026-10-02 15:11:44 -05:00

CHANGELOG.md

chore: release v0.3.1

2026-03-12 13:09:22 -05:00

package.json

build(deps): bump ws and @types/ws (#15164 )

2026-10-09 09:27:45 -07:00

README.md

PAPA-430: workspace finalize gates + no-remote-git enforcement (#6969 )

2026-05-29 08:25:29 -07:00

tsconfig.json

Fix root TypeScript solution config

2026-03-09 14:09:30 -05:00

vitest.config.ts

fix(openclaw-gateway): use per-agent claimedApiKeyPath in wake text (#4668 )

2026-08-05 00:53:43 -05:00

README.md

OpenClaw Gateway Adapter

This document describes how @paperclipai/adapter-openclaw-gateway invokes OpenClaw over the Gateway protocol.

Transport

This adapter always uses WebSocket gateway transport.

URL must be ws:// or wss://
Connect flow follows gateway protocol:

receive connect.challenge
send req connect (protocol/client/auth/device payload)
send req agent
wait for completion via req agent.wait
stream event agent frames into Paperclip logs/transcript parsing

Auth Modes

Gateway credentials can be provided in any of these ways:

authToken / token in adapter config
headers.x-openclaw-token
headers.x-openclaw-auth (legacy)
password (shared password mode)

When a token is present and authorization header is missing, the adapter derives Authorization: Bearer <token>.

Device Auth

By default the adapter sends a signed device payload in connect params.

set disableDeviceAuth=true to omit device signing
set devicePrivateKeyPem to pin a stable signing key
without devicePrivateKeyPem, the adapter generates an ephemeral Ed25519 keypair per run
when autoPairOnFirstConnect is enabled (default), the adapter handles one initial pairing required by calling device.pair.list + device.pair.approve over shared auth, then retries once.

Session Strategy

The adapter supports the same session routing model as HTTP OpenClaw mode:

sessionKeyStrategy=issue|fixed|run
sessionKey is used when strategy is fixed

Resolved session key is sent as agent.sessionKey.

Payload Mapping

The agent request is built as:

required fields:
- message (wake text plus optional payloadTemplate.message/payloadTemplate.text prefix)
- idempotencyKey (Paperclip runId)
- sessionKey (resolved strategy)
optional additions:
- all payloadTemplate fields merged in
- agentId from config if set and not already in template

Timeouts

timeoutSec controls adapter-level request budget
waitTimeoutMs controls agent.wait.timeoutMs

If agent.wait returns timeout, adapter returns openclaw_gateway_wait_timeout.

Log Format

Structured gateway event logs use:

[openclaw-gateway] ... for lifecycle/system logs
[openclaw-gateway:event] run=<id> stream=<stream> data=<json> for event agent frames

UI/CLI parsers consume these lines to render transcript updates.

No-remote-git contract

Like every Paperclip adapter, this one must treat the local execution-workspace cwd as the only persistence boundary across runs — no git push from runtime code, no assuming a git remote exists. The gateway transport here doesn't touch the workspace directly, but if you extend the adapter to ship code to the OpenClaw side, use the round-trip helpers in @paperclipai/adapter-utils (prepareWorkspaceForSshExecution → restoreWorkspaceFromSshExecution) rather than reaching for a git remote. See packages/adapters/AUTHORING.md for the full contract and the pinning test at packages/adapter-utils/src/ssh-fixture.test.ts.