diff --git a/README.md b/README.md index 39476af..5bcd5e4 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ Screenshots live in `docs/images/` and are linked with relative Markdown image s An image appears once its change is merged to `main`. Use PNG or WebP under 250 KB, crop to the relevant component, and write descriptive alt text. Public screenshots must not show test funds, local-fork labels, chain ids of test networks, -test accounts or internal organization names. +test accounts or internal project names. Changes go through a pull request with a passing **Docs check** before merging. A second person's approval is not required, so a solo maintainer can merge their own checked PR. diff --git a/docs/api/authentication.md b/docs/api/authentication.md index ce55dfd..5fa9459 100644 --- a/docs/api/authentication.md +++ b/docs/api/authentication.md @@ -24,7 +24,7 @@ Enable **API**, **MCP** or both, choose only the needed read scopes and select a Copy the secret when it appears; Claire retains a hash, not a recoverable copy. Revoke it when no longer needed. Changing its methods or scopes requires explicit manager approval and does not rotate the secret or expiry. ::: -![The Create key dialog: a name, an access method of API, MCP or Both, read permissions for organization context, Knowledge, asset metadata, Telegram, X mentions and token, and a 7-, 30- or 90-day expiry.](../images/developer-create-key.webp) +![The Create key dialog: a name, an access method of API, MCP or Both, read permissions for project context, Knowledge, asset metadata, Telegram, X mentions and token, and a 7-, 30- or 90-day expiry.](../images/developer-create-key.webp) > [!WARNING] > Store the key in your server environment or agent's secret store, never in browser code, a public variable, a skill file or source control. A key stops working if its issuer loses owner or admin membership. diff --git a/docs/api/claire-proof.md b/docs/api/claire-proof.md index 3e1017f..68100c9 100644 --- a/docs/api/claire-proof.md +++ b/docs/api/claire-proof.md @@ -9,13 +9,13 @@ order: 46 ## Read the Claire Proof -`GET /api/v1/token/proof` (MCP tool `get_token_proof`, scope `token:read`) returns the [Claire Proof](../sources/token-actions/claire-proof.md) for the organization's linked token, the facts its public proof page shows plus the detail behind them, with `data` set to `null` when no token is linked. Unlike the other token reads it makes RPC requests: the on-chain figures come from one read at one block, stated in `block`, and are cached briefly. It returns: +`GET /api/v1/token/proof` (MCP tool `get_token_proof`, scope `token:read`) returns the [Claire Proof](../sources/token-actions/claire-proof.md) for the project's linked token, the facts its public proof page shows plus the detail behind them, with `data` set to `null` when no token is linked. Unlike the other token reads it makes RPC requests: the on-chain figures come from one read at one block, stated in `block`, and are cached briefly. It returns: - `chainId`, `network`, `explorer`, `url` (the token's permalink `/proof//`, the token's public proof page; append `/badge.svg` for the badge), `token` (`address`, `name`, `symbol`, `decimals`, `totalSupply`) and `block` (`number`, `time`). - `claire`: whether the token's launch is registered by a Claire router factory (launched or migrated), and `launch` when it is (`router`, `launchpad`, `creator`, `payee`, `payeeKind` of `creator`, `vault`, `split` or `other`, `holderBps`, `buyback`, `pendingPayee` and `migrated`). `payee` and `holderBps` are the current values. `launch.pendingPayee` is `null` or `{ address, kind, effectiveAt }`, the payee change the creator has announced and the time it can take effect. `launch.migrated` is `null` for a token launched through Claire; for a token brought over with `adopt` it holds `at` (ISO time of the adoption block, or `null` if it could not be read) and `block`. A linked token that never migrated is not registered. -- `locked`: raw amounts held by the time, revenue and price lock contracts for this token (`time`, `revenue`, `price`, `total`), `percent` of total supply (`null` when supply is zero), and the organization's published `locks` with their proof URLs. Vested but unclaimed tokens are included. +- `locked`: raw amounts held by the time, revenue and price lock contracts for this token (`time`, `revenue`, `price`, `total`), `percent` of total supply (`null` when supply is zero), and the project's published `locks` with their proof URLs. Vested but unclaimed tokens are included. - `openingLock` (from the confirmed launch receipt, or `null`), `ponsLocked` (the supply pons' locker holds), `revenue` (the distributor, per asset what the router counted as `routed` and the cumulative total `published` to holders, and the confirmed `rounds` with `evidence` and `manifestUrl`) and `feeRecipient` (the launchpad's creator-fee recipient, `ok` when it is the Claire router, and any `pending` change). -- `contracts` (the lock and proof-view contracts it read) and `links` (the X account and Telegram chat the organization connected inside Claire, which are not on-chain facts). Take verification addresses from `@tryclaire/sdk/protocol`, not from this response. +- `contracts` (the lock and proof-view contracts it read) and `links` (the X account and Telegram chat the project connected inside Claire, which are not on-chain facts). Take verification addresses from `@tryclaire/sdk/protocol`, not from this response. ```sh curl --header "Authorization: Bearer $CLAIRE_API_KEY" "$CLAIRE_API_URL/token/proof" diff --git a/docs/api/context-and-search.md b/docs/api/context-and-search.md index 56b7f56..3cd6c6f 100644 --- a/docs/api/context-and-search.md +++ b/docs/api/context-and-search.md @@ -18,4 +18,4 @@ curl --get --header "Authorization: Bearer $CLAIRE_API_KEY" \ ## Endpoints -`GET /api/v1/context` includes the credential's organization ID and approved sources permitted by their matching read scopes; organization identity fields and connection blocks may be absent when their sources are filtered. `GET /api/v1/sources` lists approved, included sources with matching read scopes, status and timestamps. `GET /api/v1/search` accepts `q`, `source` (an ID from `/sources`), `after`, `before` and `limit` (maximum 50). Search results intersect `context:read` with the per-source read scopes; `context:read` alone does not expose Documents or Notes. Timestamps may include UTC offsets; `after` is inclusive and `before` is exclusive. `data.items` contain bounded previews and source IDs; `data.sources` describes permitted sources and `data.hasMore` indicates additional results or a bounded source pool, **not** complete provider history. Follow source links or scoped detail endpoints for evidence. +`GET /api/v1/context` includes the credential's project ID and approved sources permitted by their matching read scopes; project identity fields and connection blocks may be absent when their sources are filtered. `GET /api/v1/sources` lists approved, included sources with matching read scopes, status and timestamps. `GET /api/v1/search` accepts `q`, `source` (an ID from `/sources`), `after`, `before` and `limit` (maximum 50). Search results intersect `context:read` with the per-source read scopes; `context:read` alone does not expose Documents or Notes. Timestamps may include UTC offsets; `after` is inclusive and `before` is exclusive. `data.items` contain bounded previews and source IDs; `data.sources` describes permitted sources and `data.hasMore` indicates additional results or a bounded source pool, **not** complete provider history. Follow source links or scoped detail endpoints for evidence. diff --git a/docs/api/index.md b/docs/api/index.md index e351967..a4afe88 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -23,7 +23,7 @@ Sources, context and bounded persisted search. ::card[People and other reads]{href=people-and-other-reads.md icon=users} People, Knowledge, Assets, Telegram, X and token reads. ::card[Token locks, routers and rounds]{href=token-reads.md icon=chart} -The organization's persisted Claire locks, fee routers and rounds. +The project's persisted Claire locks, fee routers and rounds. ::card[Claire Proof endpoint]{href=claire-proof.md icon=shield} The public proof facts read from the chain at one block. ::card[Freshness and rate limits]{href=errors-and-rate-limits.md icon=bolt} diff --git a/docs/api/scopes.md b/docs/api/scopes.md index ce13c41..e81efe7 100644 --- a/docs/api/scopes.md +++ b/docs/api/scopes.md @@ -18,7 +18,7 @@ In **Knowledge**, the source must also be used (**Claire uses**) **and** explici | `assets:read` | File and folder metadata, not private object keys, file content or signed URLs. | | `telegram:read` | Linked chats, stored messages and Telegram-sourced People. | | `x:read` | Stored mentions and X-sourced People. | -| `token:read` | Stored token identity and observations, plus the organization's Claire locks, fee routers, distribution rounds and the token's Claire Proof. | +| `token:read` | Stored token identity and observations, plus the project's Claire locks, fee routers, distribution rounds and the token's Claire Proof. | ## Next steps diff --git a/docs/api/token-reads.md b/docs/api/token-reads.md index a66cdd4..2182a35 100644 --- a/docs/api/token-reads.md +++ b/docs/api/token-reads.md @@ -1,6 +1,6 @@ --- title: Token locks, routers and rounds -description: Read the organization's persisted Claire locks, fee routers and distribution rounds. +description: Read the project's persisted Claire locks, fee routers and distribution rounds. icon: chart order: 45 --- @@ -9,13 +9,13 @@ order: 45 ## Read token locks, fee routers and rounds -Three read-only endpoints need `token:read` and the organization's approved token source. Each makes no RPC request and returns what Claire persisted from confirmed transactions. They are also MCP tools with the same scope; see [MCP](../mcp/index.md). A fourth, [`token/proof`](claire-proof.md#read-the-claire-proof), does read the chain. +Three read-only endpoints need `token:read` and the project's approved token source. Each makes no RPC request and returns what Claire persisted from confirmed transactions. They are also MCP tools with the same scope; see [MCP](../mcp/index.md). A fourth, [`token/proof`](claire-proof.md#read-the-claire-proof), does read the chain. | Endpoint | MCP tool | Returns | | --- | --- | --- | -| `GET /api/v1/token/locks` | `list_token_locks` | The organization's locks from confirmed funding receipts: `kind` (`time`, `revenue` or `price`), `chainId`, lock `contract` and `lockId`, `token`, `funder`, `beneficiary`, raw `amount`, `cancelable`, `cancelNotice`, `transferable`, `fundingTransactionHash`, `published` and a public `id`. Time locks add `schedule` (`timelock`, `linear` or `catch-up-cliff`), `start`, `cliff` and `end`, and `cancelNotice` (seconds the funder must wait between requesting and executing a cancellation; `0` cancels at once; `null` unless the lock is cancelable). For revenue and price locks those time fields are `null`. `revenue` (revenue locks) holds `router`, `asset` (the quote asset; the zero address is native ETH), `baseline`, `deadline` (Unix seconds) and `tranches` (`revenue` threshold in raw units and `bps`). `price` (price locks) holds `router`, `asset`, `highWaterAtCreation`, `deadline` and `tranches` (`price` target in raw quote units per whole token, and `bps`). `proofUrl` is set once the lock is published. Claimed and remaining amounts are on the proof page. | -| `GET /api/v1/token/fee-routers` | `list_fee_routers` | The organization's confirmed fee routers: `router`, `factory`, `launchpad`, `creator` (the launcher), `payee` (who receives the creator share now; the creator can change it with 7 days' notice), `payeeKind` (`creator`, `vault` or `split`), `payeeTerms` (a vault's beneficiary and schedule, or a split's payees and basis points; `null` when the creator is the payee), `buyback` (pons only; `null` when unknown), `holderBps` (the current holder share; the creator can only raise it), `pendingPayee` (a proposed payee, or `null`), `payeeChangeAt` (ISO time the proposal can take effect, or `null`), `payeeChanges` (the history of changes this app confirmed: `type` of `holder_share_raised`, `payee_change_proposed`, `payee_change_canceled` or `payee_changed`, `at`, `transactionHash`, and `from`, `to`, `payee` or `effectiveAt` as relevant), `projectHolderDistributor`, `claireHolderDistributor`, `treasury`, `launchedToken`, and `totals` per asset (the sums of confirmed harvests, in raw units of that asset: `harvests`, `received`, `revenue`, `creator`, `projectHolders`, `claireHolders`, `treasury`). With buyback on, the launch token appears in `totals` as an asset next to the quote. | -| `GET /api/v1/token/rounds` | `list_token_rounds` | The organization's confirmed project-holder and airdrop rounds, 20 per page (`page`): `purpose`, `distributor`, `roundId`, `asset`, `total` (what this round added), `cumulativeTotal` (everything promised for the asset so far), `previousEvidence`, `recipients` (accounts this round added to), `accounts` (accounts with an entitlement in this root), `snapshotBlock`, `root`, `evidence`, `transactionHash`, `manifestUrl` and `publishedAt`. | +| `GET /api/v1/token/locks` | `list_token_locks` | The project's locks from confirmed funding receipts: `kind` (`time`, `revenue` or `price`), `chainId`, lock `contract` and `lockId`, `token`, `funder`, `beneficiary`, raw `amount`, `cancelable`, `cancelNotice`, `transferable`, `fundingTransactionHash`, `published` and a public `id`. Time locks add `schedule` (`timelock`, `linear` or `catch-up-cliff`), `start`, `cliff` and `end`, and `cancelNotice` (seconds the funder must wait between requesting and executing a cancellation; `0` cancels at once; `null` unless the lock is cancelable). For revenue and price locks those time fields are `null`. `revenue` (revenue locks) holds `router`, `asset` (the quote asset; the zero address is native ETH), `baseline`, `deadline` (Unix seconds) and `tranches` (`revenue` threshold in raw units and `bps`). `price` (price locks) holds `router`, `asset`, `highWaterAtCreation`, `deadline` and `tranches` (`price` target in raw quote units per whole token, and `bps`). `proofUrl` is set once the lock is published. Claimed and remaining amounts are on the proof page. | +| `GET /api/v1/token/fee-routers` | `list_fee_routers` | The project's confirmed fee routers: `router`, `factory`, `launchpad`, `creator` (the launcher), `payee` (who receives the creator share now; the creator can change it with 7 days' notice), `payeeKind` (`creator`, `vault` or `split`), `payeeTerms` (a vault's beneficiary and schedule, or a split's payees and basis points; `null` when the creator is the payee), `buyback` (pons only; `null` when unknown), `holderBps` (the current holder share; the creator can only raise it), `pendingPayee` (a proposed payee, or `null`), `payeeChangeAt` (ISO time the proposal can take effect, or `null`), `payeeChanges` (the history of changes this app confirmed: `type` of `holder_share_raised`, `payee_change_proposed`, `payee_change_canceled` or `payee_changed`, `at`, `transactionHash`, and `from`, `to`, `payee` or `effectiveAt` as relevant), `projectHolderDistributor`, `claireHolderDistributor`, `treasury`, `launchedToken`, and `totals` per asset (the sums of confirmed harvests, in raw units of that asset: `harvests`, `received`, `revenue`, `creator`, `projectHolders`, `claireHolders`, `treasury`). With buyback on, the launch token appears in `totals` as an asset next to the quote. | +| `GET /api/v1/token/rounds` | `list_token_rounds` | The project's confirmed project-holder and airdrop rounds, 20 per page (`page`): `purpose`, `distributor`, `roundId`, `asset`, `total` (what this round added), `cumulativeTotal` (everything promised for the asset so far), `previousEvidence`, `recipients` (accounts this round added to), `accounts` (accounts with an entitlement in this root), `snapshotBlock`, `root`, `evidence`, `transactionHash`, `manifestUrl` and `publishedAt`. | These fields come from receipts Claire confirmed; a change made directly on-chain outside Claire shows in the Claire Proof, which reads the chain. Each fee router also carries `migrated` (true when the router adopted a token launched on pons outside Claire) and `migration`, which is `null` for a router that launched its token itself or has not adopted one. Otherwise it holds `adoptedAt`, `migrationFee` and `migrationFeeToken` (the one-time fee in raw units of its stablecoin), `treasury` and `claireHolders` (the two halves), `historicalPayouts` (per `asset`, the `amount` the router paid the creator uncharged from before the migration) and `transactionHash`. diff --git a/docs/automations/index.md b/docs/automations/index.md index af89ec4..506c1c9 100644 --- a/docs/automations/index.md +++ b/docs/automations/index.md @@ -51,4 +51,4 @@ At delivery, Claire rechecks the rule, approving manager's role, connected accou > [!IMPORTANT] > Unknown is never retried automatically. Check the chat before taking another action. -A completed post is not posted again just because pinning it failed. Live delivery has an organization-wide hourly cap; see [current limits](../reference/limits.md). See also [notifications](reports-and-notifications.md). +A completed post is not posted again just because pinning it failed. Live delivery has a project-wide hourly cap; see [current limits](../reference/limits.md). See also [notifications](reports-and-notifications.md). diff --git a/docs/claire/earning.md b/docs/claire/earning.md index b9cff33..253ab0f 100644 --- a/docs/claire/earning.md +++ b/docs/claire/earning.md @@ -11,7 +11,7 @@ order: 31 | --- | --- | --- | | [Fee rounds](#fee-rounds) | Every holder, pro rata | Cumulative rounds, claimed by you or anyone | | [Launch airdrops](#launch-airdrops) | Holders of a project's chosen snapshot | A project's own token, until its claims close | -| [Referral rewards](#referral-rewards) | Referrers of paying organizations | Treasury-funded rounds, to your payout wallet | +| [Referral rewards](#referral-rewards) | Referrers of paying projects | Treasury-funded rounds, to your payout wallet | ## Fee rounds @@ -63,9 +63,9 @@ The public proof at `/airdrops/` shows the rule, snapshot block, Merkle root ## Referral rewards -Your invite link on the personal **Referrals** page counts link opens (unverified), sign-ups and paying projects separately. An organization keeps the referrer of the account that created it. +Your invite link on the personal **Referrals** page counts link opens (unverified), sign-ups and paying projects separately. A project keeps the referrer of the account that created it. -When such an organization pays a Claire service fee or a Pro plan payment that confirms on-chain, you receive **5% of Claire's treasury share** of that payment, or **7.5%** if your verified holding qualifies when the reward is recorded: +When such a project pays a Claire service fee or a Pro plan payment that confirms on-chain, you receive **5% of Claire's treasury share** of that payment, or **7.5%** if your verified holding qualifies when the reward is recorded: | Payment | Claire treasury share | Reward at 5% | Reward at 7.5% | | --- | --- | --- | --- | @@ -74,7 +74,7 @@ When such an organization pays a Claire service fee or a Pro plan payment that c | Pro plan, USD 49 | 49 | 2.45 | 3.675 | - A reward is never a share of trading revenue, of the $CLAIRE holder half or of project-holder funds. -- Self-referrals are void: there is no reward when you belong to the paying organization, made the payment yourself, or paid from one of your verified wallets. If a payment is reorganized off the chain and confirms again, this is checked again. +- Self-referrals are void: there is no reward when you belong to the paying project, made the payment yourself, or paid from one of your verified wallets. If a payment is reorganized off the chain and confirms again, this is checked again. - A reward becomes payable once the payment's block is finalized. Claire's treasury then funds payable rewards in a claim round on the fee's chain, in the fee's stablecoin (USDG on Robinhood Chain). Funding a round is not a payout: the reward reaches your payout wallet when a claim is submitted, by you or anyone. A reward waits while you have no verified payout wallet. - Pro payments are referral payments like service fees; the whole amount is treasury share, so the reward is 5% or 7.5% of USD 49 on the chain it was paid on. diff --git a/docs/claire/faq.md b/docs/claire/faq.md index 4b8ad76..650acf0 100644 --- a/docs/claire/faq.md +++ b/docs/claire/faq.md @@ -16,7 +16,7 @@ Until a $CLAIRE address is published, Claire shows **$CLAIRE is not live yet** a Only balances in your verified wallets count, read at a finalized Robinhood Chain block. $CLAIRE in locks, vesting or unclaimed distribution rounds does not count. If the holder data is unavailable, nothing is granted or removed. ::: :::details[What happens if my balance drops below 25,000?] -Only this benefit ends. Items created above the lower limits are kept and only new ones are refused. A Pro plan the organization paid for is never overridden or removed. +Only this benefit ends. Items created above the lower limits are kept and only new ones are refused. A Pro plan the project paid for is never overridden or removed. ::: ## Rewards and claims @@ -25,7 +25,7 @@ Only this benefit ends. Items created above the lower limits are kept and only n A reward becomes payable once the payment's block is finalized. Claire's treasury then funds payable rewards in a claim round. Funding a round is not a payout: the reward reaches your payout wallet when a claim is submitted, by you or anyone. A reward also waits while you have no verified payout wallet. ::: :::details[Why is a referral reward void?] -Self-referrals are void: there is no reward when you belong to the paying organization, made the payment yourself, or paid from one of your verified wallets. +Self-referrals are void: there is no reward when you belong to the paying project, made the payment yourself, or paid from one of your verified wallets. ::: :::details[Can fee rounds be zero?] Yes. Amounts depend on activity and can be zero. Holders receive Claire protocol fees only, never $CLAIRE's own trading fees. diff --git a/docs/claire/holder-benefits.md b/docs/claire/holder-benefits.md index 7c65c9e..782e55c 100644 --- a/docs/claire/holder-benefits.md +++ b/docs/claire/holder-benefits.md @@ -38,25 +38,25 @@ Your first verified wallet also becomes your referral payout wallet; you can cho - **Threshold:** 25,000 $CLAIRE held across your verified wallets. Only wallet balances count; $CLAIRE in locks, vesting or unclaimed distribution rounds does not. -- **One target:** the top plan applies to you or to one organization you belong to. You can move it once every 30 days; if you leave that organization, it stops applying there and you can move it right away. +- **One target:** the top plan applies to you or to one project you belong to. You can move it once every 30 days; if you leave that project, it stops applying there and you can move it right away. -- **Nothing is deleted:** if your verified holding falls below 25,000, only this benefit ends. Items created above the lower limits are kept and only new ones are refused. A Pro plan the organization paid for is never overridden or removed. +- **Nothing is deleted:** if your verified holding falls below 25,000, only this benefit ends. Items created above the lower limits are kept and only new ones are refused. A Pro plan the project paid for is never overridden or removed. ### Limits | Limit | Early access | Top plan | | --- | --- | --- | -| Organization storage | 2 GiB | 10 GiB | -| Unarchived automation rules per organization | 10 | 25 | +| Project storage | 2 GiB | 10 GiB | +| Unarchived automation rules per project | 10 | 25 | | Developer API requests per minute per key | 120 | 360 | -| Developer API requests per minute per organization | 600 | 1,800 | +| Developer API requests per minute per project | 600 | 1,800 | | Workspaces with figures on your personal Home | 25 | 100 | Early access applies everywhere today. The Developer API's per-IP limit is the same on both. Responses report the applicable limit in `RateLimit-Limit`. ## Pro plan -An organization can buy the same limits as the top plan without holding $CLAIRE: **USD 49 per 30 days**, prepaid, no auto-renewal. Owners and admins pay from the organization's designated wallet in **Settings → General → Plan → Get Pro**, in USDG on Robinhood Chain, or by buying the stablecoin with ETH in one swap first. The payment goes to the Claire treasury and confirms on-chain; paying while Pro is active extends the paid period from its current end. Pro payments become available once the Claire protocol is deployed on that chain. +A project can buy the same limits as the top plan without holding $CLAIRE: **USD 49 per 30 days**, prepaid, no auto-renewal. Owners and admins pay from the project's designated wallet in **Settings → General → Plan → Get Pro**, in USDG on Robinhood Chain, or by buying the stablecoin with ETH in one swap first. The payment goes to the Claire treasury and confirms on-chain; paying while Pro is active extends the paid period from its current end. Pro payments become available once the Claire protocol is deployed on that chain. ## Next steps diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index a9482cd..f88782f 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -8,7 +8,7 @@ order: 2 # Getting started -Your personal space and organization workspaces are separate. Personal navigation contains your Home, Referrals, Wallet, [$CLAIRE](../claire/index.md) and account settings. An organization's sidebar starts with Home, Token, Community (Telegram), Social (X) and People; then Knowledge, Automations and Developers; then Assets; and Settings last. Create or choose a workspace for your project. You do not need to link a token to use Telegram, X, or Knowledge. +Your personal space and project workspaces are separate. Personal navigation contains your Home, Referrals, Wallet, [$CLAIRE](../claire/index.md) and account settings. A project's sidebar starts with Home, Token, Community (Telegram), Social (X) and People; then Knowledge, Automations and Developers; then Assets; and Settings last. Create or choose a workspace for your project. You do not need to link a token to use Telegram, X, or Knowledge. ## Create a workspace @@ -23,7 +23,7 @@ Sign in and create a workspace with a name and unique slug. 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. +Owners and admins can use the optional **Getting started** sidebar checklist. Hide or restore it for the selected project in **Personal settings → Appearance**; the preference applies to your account in this browser. ![The Finish setting up checklist on a workspace's Home page, grouped under Connect, Publish, Team and Optional, with a Connect Telegram shortcut.](../images/getting-started-checklist.webp) diff --git a/docs/getting-started/security-and-data.md b/docs/getting-started/security-and-data.md index 573e2e0..c95e1fd 100644 --- a/docs/getting-started/security-and-data.md +++ b/docs/getting-started/security-and-data.md @@ -15,7 +15,7 @@ Only the owner can change another member's role or transfer ownership. Developer A Knowledge item's **public reference** classification does not publish it or grant public access. **Private is not integration-private**: approving Agent access for Notes lets credentials with `knowledge:read` read team notes, and agent providers may receive that content. Approving Telegram chats likewise lets credentials with `telegram:read` read stored conversations, including private linked groups or channels. External People reads still exclude private person notes. A file explicitly marked **public** in Assets has a public file URL; do not mark confidential files public. -Only an owner designates a [token signing wallet](../sources/token-actions/signing-wallet.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. +Only an owner designates a [token signing wallet](../sources/token-actions/signing-wallet.md), separately for each chain. Owners and admins can prepare token actions and publish vesting links, but the designated wallet must sign project transactions. Removing app access does not revoke wallet keys or on-chain rights. Funding a lock exposes addresses, amounts, and its schedule on-chain even without a Claire proof page. Publishing additionally lists the lock on the token's Claire Proof page and gives it a public proof page; unpublishing does not make the underlying on-chain data private. A proof is not a liquidity lock or investment guarantee. diff --git a/docs/mcp/tools.md b/docs/mcp/tools.md index e365d41..b47bc18 100644 --- a/docs/mcp/tools.md +++ b/docs/mcp/tools.md @@ -13,7 +13,7 @@ With `context:read`, start with `get_context` and `list_sources`, then use `sear ## Token reads -With `token:read`, `list_token_locks`, `list_fee_routers` and `list_token_rounds` (optional `page`; 20 rounds per page) return the organization's persisted Claire locks (time, revenue and price), fee routers (with payee and buyback state) and cumulative distribution rounds with their public proof and manifest URLs. They read stored records, make no chain request, and are described with the REST endpoints in [Developer REST API and SDK](../api/token-reads.md#read-token-locks-fee-routers-and-rounds). To check what they return against the chain, see [Verify on-chain](../verification/index.md). +With `token:read`, `list_token_locks`, `list_fee_routers` and `list_token_rounds` (optional `page`; 20 rounds per page) return the project's persisted Claire locks (time, revenue and price), fee routers (with payee and buyback state) and cumulative distribution rounds with their public proof and manifest URLs. They read stored records, make no chain request, and are described with the REST endpoints in [Developer REST API and SDK](../api/token-reads.md#read-token-locks-fee-routers-and-rounds). To check what they return against the chain, see [Verify on-chain](../verification/index.md). `get_token_proof` (also `token:read`) returns the linked token's [Claire Proof](../sources/token-actions/claire-proof.md) read from the chain at one block, the facts on the token's public Claire Proof page; see [Read the Claire Proof](../api/claire-proof.md#read-the-claire-proof). Unlike the tools above it makes chain requests. diff --git a/docs/sources/token-actions/fees.md b/docs/sources/token-actions/fees.md index 97f7753..d50ecc0 100644 --- a/docs/sources/token-actions/fees.md +++ b/docs/sources/token-actions/fees.md @@ -41,7 +41,7 @@ Every token launch through Claire goes through the workspace's own **fee router* Before you sign, Claire shows the exact payment token and amount, the launchpad's own fees and a gas estimate. -When the paying organization was referred, a referral reward comes out of Claire's treasury half of a service fee, never out of trading revenue. Projects that launched through Claire can also choose to airdrop part of their token to $CLAIRE holders. Both are described in [$CLAIRE holders and referrals](../../claire/index.md). +When the paying project was referred, a referral reward comes out of Claire's treasury half of a service fee, never out of trading revenue. Projects that launched through Claire can also choose to airdrop part of their token to $CLAIRE holders. Both are described in [$CLAIRE holders and referrals](../../claire/index.md). ## Limits to keep in mind diff --git a/docs/sources/token-actions/index.md b/docs/sources/token-actions/index.md index d9551fd..dab5a0d 100644 --- a/docs/sources/token-actions/index.md +++ b/docs/sources/token-actions/index.md @@ -7,7 +7,7 @@ order: 8 # Token actions -In **Token**, the **signing wallet** button designates the organization's wallet and lists its transactions. With no token linked, **Launch a token** opens the launch setup, saved as a draft until you launch it; once a token is linked, **Vesting** funds and publishes locks. Robinhood Chain (pons v2) is the only network open today; Ethereum (Stockereum) is **coming soon** and cannot be selected. Robinhood Chain requires ETH for gas. Token tools are optional. +In **Token**, the **signing wallet** button designates the project's wallet and lists its transactions. With no token linked, **Launch a token** opens the launch setup, saved as a draft until you launch it; once a token is linked, **Vesting** funds and publishes locks. Robinhood Chain (pons v2) is the only network open today; Ethereum (Stockereum) is **coming soon** and cannot be selected. Robinhood Chain requires ETH for gas. Token tools are optional. > [!IMPORTANT] > Ethereum is coming soon; do not plan a launch, link or lock on it. @@ -16,7 +16,7 @@ In **Token**, the **signing wallet** button designates the organization's wallet | Task | Where | Who | | --- | --- | --- | -| [Designate the signing wallet](signing-wallet.md) | **Token → signing wallet** | The organization owner signs a verification challenge | +| [Designate the signing wallet](signing-wallet.md) | **Token → signing wallet** | The project owner signs a verification challenge | | [Launch a token](launch.md) | **Token → Launch a token** | Owners and admins prepare it; the designated wallet signs | | [Bring a linked token to Claire](linking-and-migration.md#bring-a-linked-token-to-claire) | **Bring this token to Claire** on the Token page | The creator's designated wallet, once | | [Change the split](creator-share-and-split.md#change-the-split-after-launch) | **Creator fees → Change the split** | The launcher only | diff --git a/docs/sources/token-actions/revenue-and-price-locks.md b/docs/sources/token-actions/revenue-and-price-locks.md index 8cd209e..ed74c6d 100644 --- a/docs/sources/token-actions/revenue-and-price-locks.md +++ b/docs/sources/token-actions/revenue-and-price-locks.md @@ -43,7 +43,7 @@ In **Vesting → New lock**, **Unlock by** offers **Dates**, **Revenue milestone **How a target is reached.** The price is sampled on-chain whenever anyone updates it. Each hour keeps its lowest sample, and a target is reached once the lowest hourly value over the last **24 completed hours** is at or above it. Only completed hours count, and every one of the 24 needs at least one sample. Once reached, a target stays unlocked for good. -**Anyone can update the price.** The public **Update price** link on lock cards and the claim page prepares the update; any wallet can send it, with only gas to pay, and no organization is needed. A later update in the same hour lowers that hour's minimum if the price is lower, so an update at the real price corrects an inflated sample. The price comes from the launchpad: before graduation pons' bonding curve, after graduation the Uniswap v4 pool pons registered for the token. +**Anyone can update the price.** The public **Update price** link on lock cards and the claim page prepares the update; any wallet can send it, with only gas to pay, and no project is needed. A later update in the same hour lowers that hour's minimum if the price is lower, so an update at the real price corrects an inflated sample. The price comes from the launchpad: before graduation pons' bonding curve, after graduation the Uniswap v4 pool pons registered for the token. > [!WARNING] > **A sampled-price trigger, not an oracle.** The price is a spot read. A trader who can move the market for one transaction can raise the price, update it and unwind, and an hour with no honest update can carry that manipulated sample. Nothing forces anyone to update the price. Moving the price costs the capital the trade needs plus round-trip fees, repeated for each of the 24 hours, but set targets with this in mind: only the fallback date guarantees an unlock. diff --git a/docs/sources/token-actions/signing-wallet.md b/docs/sources/token-actions/signing-wallet.md index f446979..94f87ed 100644 --- a/docs/sources/token-actions/signing-wallet.md +++ b/docs/sources/token-actions/signing-wallet.md @@ -7,7 +7,7 @@ order: 9 # Signing wallet -The **signing wallet** is the organization's designated wallet. Owners and admins prepare token actions in Claire; this wallet signs them. +The **signing wallet** is the project's designated wallet. Owners and admins prepare token actions in Claire; this wallet signs them. ## Designate the wallet @@ -19,7 +19,7 @@ Open the signing wallet, then select the network and the wallet that will sign. ### The owner signs a challenge -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. +An **project 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. ### Admins prepare, the wallet signs diff --git a/docs/sources/token-actions/vesting-and-locks.md b/docs/sources/token-actions/vesting-and-locks.md index 656a588..de23028 100644 --- a/docs/sources/token-actions/vesting-and-locks.md +++ b/docs/sources/token-actions/vesting-and-locks.md @@ -58,6 +58,6 @@ After funding is verified and associated with the workspace, an owner or admin c This is evidence of a particular allocation, **not** an endorsement, payout guarantee, or liquidity lock. Unpublishing removes Claire's public listing/proof access; it does not hide on-chain addresses, transfers, or schedules. -Beneficiaries claim at `/vesting//claire-` (`revenue-` or `price-` for those lock types): a signed-in user can connect a wallet and prepare a payout claim without joining the organization. Anyone may submit and pay the network gas, or call `claim` on the lock contract directly, but tokens go only to the beneficiary recorded on-chain. The claim pays what is available when it executes; the displayed amount may change. Claims have no Claire fee. +Beneficiaries claim at `/vesting//claire-` (`revenue-` or `price-` for those lock types): a signed-in user can connect a wallet and prepare a payout claim without joining the project. Anyone may submit and pay the network gas, or call `claim` on the lock contract directly, but tokens go only to the beneficiary recorded on-chain. The claim pays what is available when it executes; the displayed amount may change. Claims have no Claire fee. 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.