Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,19 @@ person's approval is not required, so a solo maintainer can merge their own chec
CI has read-only repository permissions, uses pinned actions and a dependency lockfile,
and requires no provider or deployment secrets.

## Connect publishing
## Publishing

The repository is prepared for the owner to switch the existing Claire workspace source:
Edit pages under `docs/`, run `npm run check`, and open a pull request. Once connected,
merges to `main` affecting that folder enqueue a Claire sync. CI checks the repository;
it does not publish the pages itself. Check Site → Docs sync status and rendered navigation
before announcing a change as live.

Before publishing the token/vesting update, verify the advertised workflows in production.
Ethereum/Stockereum availability and the SDK's new token fields must match the enabled
deployment and released npm version. Remove rollout/unreleased notes only after verification.

If the workspace has not switched its existing docs source to this repository, the owner
must first complete the one-time source switch:

- Repository: `tryclaire/docs`
- Branch: `main`
Expand Down
8 changes: 6 additions & 2 deletions docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,17 @@ order: 2

# Getting started

Create a workspace for your project, then invite the people who need access. You do not need to link a token to use Telegram, X, Knowledge, or the site.
Your personal space and organization workspaces are separate. Personal navigation contains your Home, Wallet and account settings; an organization contains its activity, sources, Knowledge, Assets, site and management settings. Create or choose a workspace for your project. You do not need to link a token to use Telegram, X, Knowledge, or the site.

## Create a workspace

1. Sign in and create a workspace with a name and unique slug.
2. Choose it from your workspace list. The creator becomes its owner.

Owners and admins can use the optional **Getting started** sidebar checklist. Hide or restore it for the selected organization in **Personal settings → Appearance**; the preference applies to your account in this browser.

Claire uses a dark interface. Appearance offers preset or custom accent colours for this browser, not an account-wide theme or a change to your public site's appearance.

## Invite teammates

1. In Organization settings, invite teammates by email. Owners and admins can send invitations.
Expand All @@ -31,6 +35,6 @@ Only the owner changes another member's role.

## Choose your next step

[Link a Telegram chat](../sources/telegram.md), [connect X](../sources/x.md), or [set up your site](../publishing/index.md). You can do these in any order.
[Link a Telegram chat](../sources/telegram.md), [connect X](../sources/x.md), or [set up your site](../publishing/index.md). You can do these in any order. For optional token tools, [verify a wallet and launch or vest a supported token](../sources/token-actions.md) when your chosen network is available.

Building a server or agent integration? An owner or admin can [create a developer key and install the official npm SDK](../reference/developer-api.md) to read permitted workspace data.
6 changes: 4 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ order: 1

# Introduction

Claire is a workspace for project teams to inspect connected community activity and maintain project information and a public site. Connect Telegram chats and an X account, optionally link a supported token, write docs, and keep team notes in Knowledge.
All-in-one infrastructure layer for teams, communities, and on-chain participants.

Claire brings Telegram and X activity, supported token observations, team Knowledge, and public docs into one workspace. Teams can maintain a public profile and use wallet-signed token launches and vesting where available. Token tools are optional.

## Start here

Expand All @@ -20,7 +22,7 @@ Your personal account is separate from workspaces. Each workspace has its own me
| Section | What you will find |
| --- | --- |
| [Getting started](getting-started/index.md) | Workspace creation, invitations, and roles. |
| [Sources](sources/index.md) | Telegram chats and join portal, X activity, and optional token data. |
| [Sources](sources/index.md) | Telegram chats and join portal, X activity, token data, and wallet-signed token actions. |
| [Publishing](publishing/index.md) | Public profile, domains, and docs from Claire or GitHub. |
| [Automations](automations/index.md) | Telegram rules, weekly reports, and notifications. |
| [Reference](reference/index.md) | Limits, developer API and npm SDK, security, and data. |
8 changes: 8 additions & 0 deletions docs/reference/developer-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,14 @@ The key selects the workspace; you do not pass an organization ID to the client.

Query arguments are optional. Use the Claire chat UUID from `telegram.chats.list()`, not Telegram's numeric chat ID. Pass Knowledge IDs, including their prefix, unchanged.

### Token identity

The next SDK contract adds `chainId`, `protocol`, `poolId`, and `pairedToken` inside `data.token`. These TypeScript fields are not in npm `0.1.0`; check the SDK release notes and hosted OpenAPI before relying on them. Ethereum availability is also rollout-gated.

Identify a token by **chain ID and contract address together**: Ethereum is `1`, Robinhood Chain is `4663`, and `protocol` is `pons` or `stockereum`. The token object is `null` when none is linked.

`pool` is a legacy V3 pool-address field; V4 launches use the zero address there. A non-null `poolId` is a Uniswap V4 pool identifier, **not** a contract address. `poolId` and `pairedToken` may be `null` when unavailable. These fields do not grant wallet access: the API and SDK still cannot launch, fund, claim, or sign transactions.

## Read responses and continue pagination

The SDK preserves the API's `data`, `meta.freshness`, and endpoint-specific `pagination`. It also exposes `http.requestId`, `http.etag`, and response headers. Timestamps stay strings, and raw token balances stay decimal strings to avoid losing precision.
Expand Down
12 changes: 9 additions & 3 deletions docs/reference/security-and-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,17 @@ order: 12

# Security and data

Workspace content is available to authorized members, while sensitive management actions require owner or admin access. Public sites and reports shared by link are separate public surfaces.
Workspace content is available to authorized members, while sensitive management actions require owner or admin access. Public profiles, published docs, public asset URLs, published vesting proofs, and reports shared by link are separate public surfaces.

## Control workspace access

Only the owner can change another member's role or transfer ownership. Developer API keys belong to one workspace, have explicit read scopes, and require the issuing manager to keep their role. Marking a Knowledge item public does not publish it on the site.
Only the owner can change another member's role or transfer ownership. Developer API keys belong to one workspace, have explicit read scopes, and require the issuing manager to keep their role.

A Knowledge item's **public reference** classification does not publish it or grant public access. A file explicitly marked **public** in Assets has a public file URL; do not mark confidential files public. Relative images imported with GitHub docs are copied into public Assets.

Only an owner designates a [token signing wallet](../sources/token-actions.md), separately for each chain. Owners and admins can prepare token actions and publish vesting links, but the designated wallet must sign organization transactions. Removing app access does not revoke wallet keys or on-chain rights.

Funding a vesting stream exposes addresses, amounts, and its schedule on-chain even without a Claire proof page. Publishing additionally lists a public proof on the site; unpublishing does not make the underlying on-chain data private. A proof is not an audit, liquidity lock, or investment guarantee.

The official [`@tryclaire/sdk`](developer-api.md) uses those same scoped keys; it does not grant additional access. Use it server-side and keep keys out of browser bundles, public environment variables, and source control. Installing the package does not connect a workspace or create a key.

Expand All @@ -24,7 +30,7 @@ GitHub docs and team notes have different origins: edit synced docs at their rep

## Know what Claire does not do

Claire does not write on X, generate replies or answers, approve its own publication of inferred project progress, hold funds, or claim creator fees. An owner-authorized automation can post or pin text you supply in a Telegram chat; [review its delivery behavior](../automations/index.md) before enabling it.
Claire does not write on X, generate replies or answers, approve its own publication of inferred project progress, custody funds, or claim creator fees. A wallet-signed beneficiary vesting claim is different from a creator-fee claim. An owner- or admin-authorized automation can post or pin supplied text in a Telegram chat; [review its delivery behavior](../automations/index.md) before enabling it.

## Find privacy information

Expand Down
5 changes: 4 additions & 1 deletion docs/sources/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ Connect the sources your workspace uses to inspect collected activity. A token i
| --- | --- |
| [Telegram](telegram.md) | Stored chat messages and activity, with an optional join portal. |
| [X](x.md) | Connected profile, authored activity, follower snapshots, and collected mentions. |
| [Token](token.md) | Market and on-chain observations for a supported pons token. |
| [Token](token.md) | Market and on-chain observations for pons on Robinhood Chain and Stockereum on Ethereum. |
| [Token actions](token-actions.md) | Designate a wallet, launch a token, fund vesting, and publish allocation evidence. |

Ethereum/Stockereum support is rollout-gated. Confirm availability for your selected network before relying on Ethereum launch, linking, or vesting actions.

## Check collection status

Expand Down
54 changes: 54 additions & 0 deletions docs/sources/token-actions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
title: Token actions
order: 7
---

# Token actions

Use **Token actions** in your organization's Token area to designate a signing wallet, launch a supported token, and fund or publish a vesting allocation. Robinhood Chain uses pons v2; Ethereum uses Stockereum v3. Both networks require ETH for gas. Token tools are optional.

> [!IMPORTANT]
> Ethereum/Stockereum availability is rollout-gated. Confirm the network and available actions in Claire before funding a wallet or promising a launch.

## Verify the organization's wallet

1. Select the network and connect the wallet that will sign. Each chain has its own designated wallet.
2. An **organization owner** signs a short-lived verification challenge to prove control. This verifies the designation; it does not transfer funds or give Claire spending authority. Only the owner can designate or remove the wallet.
3. Owners and admins can prepare launches and locks, but the **designated wallet must sign**. Being an admin does not give someone another person's wallet keys. Members cannot manage launches or vesting allocations.

Removing the designation or a member does not revoke wallet keys, on-chain rights, or previously executed transactions. Claire records intent and verified chain outcomes, not private keys. It does not custody funds, sponsor gas, or sign transactions on your behalf.

## Launch and link a token

1. Enter launch details on the chosen network. Robinhood pons v2 uses native ETH and offers a creator tax. Stockereum v3 uses an enabled quote, a permitted swap fee, and a permanent choice of creator or holder-reward routing. Review the live factory settings and costs. An optional initial buy, where available, spends wallet ETH.
2. Select **Prepare launch**. Review the network, wallet, destination contract, calldata, ETH value, nonce, and costs before signing. Preparing is not submission; submission is not confirmation.
3. Check **Transaction history and recovery** until the transaction is verified. Use **Refresh** or attach the known transaction hash if submission is uncertain. **Do not resend** an uncertain transaction or abandon it unless you know it was never sent. Confirmations reduce, but do not eliminate, reorganization risk.
4. A verified launch is linked automatically only if the initiating user still has owner/admin access, the wallet designation is unchanged, and no different token is linked. A confirmed transaction can remain unassociated if those checks fail; read its status instead of launching again.

To link an existing supported token, use **Organization → Connections**, select its network and enter its contract address. Claire verifies the chain, factory, and designated wallet requirements. One workspace has one active linked token; resolve its existing link before starting a different launch.

The protocols have different economics. Stock-linked assets also involve issuer, oracle, market, and securities-compliance risks. See the [Token guide](token.md) before interpreting market or creator-fee figures.

## Fund a vesting allocation

Vesting requires a linked supported pons v2 or Stockereum v3 token launched by that chain's designated wallet. Enter the beneficiary address, exact token amount, and UTC schedule. Claire uses **Sablier Lockup v4**:

- **Timelock:** the full amount becomes claimable at the end.
- **Linear:** tokens become claimable progressively between start and end.
- **Catch-up cliff:** nothing is claimable before the cliff; the fraction accrued since the start unlocks at the cliff, then vesting continues linearly.

Allocations are **noncancelable and nontransferable**. Verify the beneficiary, amount, and dates carefully before funding.

1. Prepare and sign the exact ERC-20 approval from the designated wallet, unless sufficient allowance is already available. Approval grants the Sablier contract allowance; it does not fund a stream. Wait for confirmation.
2. Separately prepare, review, sign, and confirm the funding transaction, which deposits the tokens into Sablier.
3. Check the recorded outcome. Approval and funding each need gas. Review the destination, calldata, value, and nonce each time, and use the same recovery procedure if submission is uncertain.

## Publish proof and claim payouts

After funding is verified and associated with the workspace, an owner or admin can **Publish** the lock. The organization site links to `/locks/<chainId>/<streamId>`, where anyone can inspect the beneficiary, schedule, contract, funding transaction, and on-chain locked, claimable, and withdrawn amounts.

This is evidence of a particular allocation, **not** an audit, endorsement, payout guarantee, or liquidity lock. Unpublishing removes Claire's public listing/proof access; it does not hide on-chain addresses, transfers, or schedules.

At `/vesting/<chainId>/<streamId>`, a signed-in user can connect a wallet and prepare a beneficiary payout claim without joining the organization. Anyone may submit and pay the network gas and quoted Sablier withdrawal fee, but tokens go only to the beneficiary recorded on-chain. The claim withdraws what is available when it executes; the displayed amount may change.

Vesting with time alone does not send tokens automatically. Check the transaction outcome before relying on a payout. These beneficiary payouts are distinct from [creator-fee figures](token.md#read-creator-fee-figures), which remain read-only in Claire.
17 changes: 13 additions & 4 deletions docs/sources/token.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,22 @@ order: 6

# Token

Token tools are optional. Link a pons token launched on Robinhood Chain by contract address; Claire verifies the launch against supported pons factories.
Token tools are optional. Select the network and enter the contract address of a supported pons token on Robinhood Chain or Stockereum v3 token on Ethereum. Claire verifies the selected chain and supported launch factory. Your workspace has one active linked token at a time.

New pons v2 and Stockereum v3 launches, linking, and vesting require a [designated signing wallet](token-actions.md). Retained supported pons launches remain readable.

> [!IMPORTANT]
> Ethereum/Stockereum availability is rollout-gated. Confirm that Ethereum actions are available for your workspace before funding a wallet or promising a launch.

## Inspect observations

The Token page brings together market observations, on-chain launch information, transfers, holders, historical snapshots, and creator fee information. Provider observations and the holder index have their own timestamps. A page load is not proof that upstream data was just collected.
The Token page brings together market observations, on-chain launch information, transfers, holders, historical snapshots, and available creator fee information. Provider observations and the holder index have their own timestamps. A page load is not proof that upstream data was just collected.

The launch protocols have different economics: pons v2 uses a native-ETH curve before graduation; Stockereum v3 uses permanent Uniswap V4 liquidity with an enabled quote, without a bonding curve or graduation stage. Stock-linked assets carry issuer, oracle, market, and securities-compliance risks.

## Work with holder snapshots

Holder counts exclude the pons factory, zero address, burn address, and liquidity pool. The deployer is not excluded by default. For a snapshot, filter by minimum balance and optionally exclude the deployer.
Holder counts exclude the applicable factory, zero address, burn address, and applicable liquidity pool or pool manager. The deployer is not excluded by default. For a snapshot, filter by minimum balance and optionally exclude the deployer.

Snapshots use indexed transfer history. They are unavailable while the index is still filling; a past snapshot reflects indexed coverage, not an independent chain scan. You can preview a snapshot and export holder rows.

Expand All @@ -22,4 +29,6 @@ Snapshots use indexed transfer history. They are unavailable while the index is

## Read creator fee figures

Creator fee figures come from the launch contracts. Claire estimates the claimable amount with a read-only on-chain call and never sends a claim transaction. It does not buy tokens, move funds, or claim fees for you. See [current limits](../reference/index.md) for additional bounds.
Where provided for pons, creator fee figures come from the launch contracts. Claire estimates the claimable amount with a read-only on-chain call and never sends a creator-fee claim transaction. Stockereum fee and reward routing differs; do not interpret a pons creator-fee estimate as a Stockereum balance. See [current limits](../reference/index.md) for additional bounds.

This read-only **creator-fee** display is separate from [wallet-signed launches, approvals, vesting funding, and beneficiary payout claims](token-actions.md). Claire does not custody funds or sign those transactions for you.
Loading