@toon-protocol/rig 3.6.0 → 4.1.0

package/dist/{publisher-BFcnZeJI.d.ts → publisher-DMJ06cuL.d.ts}

@@ -126,6 +126,42 @@ declare function parseMaintainers(tags: string[][]): string[];
  * `maintainers` tag). All values are lowercased hex.
  */
 declare function authorizedStatusAuthors(ownerPubkey: string, repoAnnouncementTags: string[][]): Set<string>;
+/**
+ * NIP-34 tag naming the repo's declared payout pointer: a single
+ * `["payout", "<chain>", "<address>"]` tag on the kind:30617 announcement.
+ * No pointer → no split, the serving node keeps 100% of repo-scoped write
+ * fees (toon-meta#391 decision 2). The tag carries the chain label so the
+ * shape survives future chains, but v1 accepts exactly one: `evm` — the
+ * payout accrual ledger is EVM-only today
+ * (`crates/connector-client-edge/src/btp.rs:270-272`).
+ */
+declare const PAYOUT_TAG = "payout";
+/** Chains the payout pointer can target. v1: `evm` only (toon-meta#391). */
+type PayoutChain = 'evm';
+/** A repo's declared payout pointer (parsed from / built into the `payout` tag). */
+interface PayoutPointer {
+    chain: PayoutChain;
+    /** EIP-55 checksummed address (never a raw lowercase/mixed-case echo). */
+    address: string;
+}
+/**
+ * True when `address` is a structurally valid, correctly-checksummed EVM
+ * address: `0x` + 40 hex chars, and — when mixed-case — a valid EIP-55
+ * checksum (an all-lowercase address is accepted as "unchecksummed").
+ */
+declare function isValidEvmPayoutAddress(address: string): boolean;
+/**
+ * Collect the repo's declared payout pointer from a kind:30617 event's tags.
+ * Only `["payout", "evm", <address>]` with a shape- and checksum-valid
+ * address is accepted; the address is normalized to its EIP-55 checksummed
+ * form. Tolerant of relay noise: an unsupported chain or malformed address
+ * is skipped (not thrown). The relay is permissionless and 30617 is
+ * replaceable, so a legacy/hand-crafted event could carry more than one
+ * `payout` tag — the first valid one wins and the rest are ignored (a
+ * `console.warn` notes the drop so a stray extra tag isn't silently
+ * mysterious).
+ */
+declare function parsePayout(tags: string[][]): PayoutPointer | null;
 /**
  * Build a kind:30617 repository announcement event.
  *
@@ -137,8 +173,11 @@ declare function authorizedStatusAuthors(ownerPubkey: string, repoAnnouncementTa
  *   values are dropped. The owner (the signer) is an implicit maintainer and
  *   need not be listed — if passed it is emitted, which is harmless since the
  *   owner is authorized regardless. See {@link MAINTAINERS_TAG}.
+ * @param payout - Optional declared payout pointer (rig#92). Emitted as a
+ *   single `["payout", "evm", <address>]` tag when given; omit (or pass
+ *   `null`) to leave the repo with no payout pointer. See {@link PAYOUT_TAG}.
  */
-declare function buildRepoAnnouncement(repoId: string, name: string, description: string, maintainers?: string[]): UnsignedEvent;
+declare function buildRepoAnnouncement(repoId: string, name: string, description: string, maintainers?: string[], payout?: PayoutPointer | null): UnsignedEvent;
 /**
  * Build a kind:30618 repository refs/state event.
  *
@@ -281,6 +320,47 @@ interface PublishReceipt {
     /** Fee paid for this publish, in the smallest asset unit. */
     feePaid: bigint;
 }
+/**
+ * One NIP-90 job for a store node's DVM, carried on the PAID path (#101).
+ *
+ * The store sits behind the connector's payment termination, so there is no
+ * public HTTP endpoint to POST these to — a reachable one would be an
+ * anonymous free gateway to a paid handler, which is the failure ADR 0020
+ * exists to close. The job therefore travels exactly as a kind:5094 store
+ * write does: inside a paid ILP packet, with `/store` as the envelope target
+ * BENEATH the route's handler path rather than as a URL path.
+ */
+interface StoreJobRequest {
+    /** NIP-90 job kind — 5095 brokered ArNS buy, 5096 gas station. */
+    kind: number;
+    /** Job arguments, sent as `["param", key, value]` tags. */
+    params: [string, string][];
+}
+/**
+ * A store DVM's answer, opened from the sealed FULFILL.
+ *
+ * ⚠️ A refusal is a RESULT, not an error. Under ADR 0020 an HTTP status is
+ * envelope content and never a packet outcome, so `accept: false` arrives on a
+ * FULFILL and the payer was charged for it either way. Implementations must
+ * return it rather than throw: the zero-ARIO rehearsal (submit a buy with no
+ * `processId` and watch the handler refuse by name before it quotes or touches
+ * the registry) is the cheapest proof the whole paid path works, and it only
+ * works if the refusal comes back as data.
+ */
+interface StoreJobResponse {
+    /** HTTP status the app answered with, inside the envelope. */
+    status: number;
+    /** The DVM's own accept flag. `false` is a refusal, not a transport fault. */
+    accept: boolean;
+    /** Machine-readable refusal reason, when the DVM sent one. */
+    code?: string;
+    /** Human-readable detail, when the DVM sent one. */
+    message?: string;
+    /** The job's output, shape depending on `kind`. */
+    result?: Record<string, unknown>;
+    /** Fee paid to carry this job, in the smallest asset unit. */
+    feePaid: bigint;
+}
 /**
  * Fee rates used by `planPush` for the pre-push estimate.
  *
@@ -300,6 +380,12 @@ interface FeeRates {
      * price, so an estimate built from it is exactly what a push pays.
      */
     uploadFee: bigint;
+    /**
+     * The store route's per-kibibyte rate, when it meters by size (ADR 0065: a
+     * price is a schedule `{base, per_kib}`; a flat route has no slope). Absent
+     * or zero means every upload costs exactly `uploadFee`.
+     */
+    uploadPerKib?: bigint;
     /**
      * Flat cost per published event (smallest asset unit). Implementations
      * already fold any per-packet route-price floor into this flat value, so
@@ -328,6 +414,16 @@ interface Publisher {
      * implement it — `rig site` requires it and errors clearly when absent.
      */
     uploadBlob?(upload: BlobUpload): Promise<UploadReceipt>;
+    /**
+     * Submit one NIP-90 job to the store node's DVM over the paid path and
+     * return its answer; paid. Used by `rig name buy/set --via` (#101) for the
+     * brokered kind:5095 buy and the kind:5096 gas station.
+     *
+     * Optional for the same reason as {@link uploadBlob}: transports that only
+     * move git objects (and pre-#101 test fakes) need not implement it, and
+     * `rig name --via` errors clearly when it is absent.
+     */
+    submitStoreJob?(request: StoreJobRequest): Promise<StoreJobResponse>;
     /**
      * Sign (implementation-held key) and pay-to-publish one event to the
      * given relay(s).
@@ -335,4 +431,4 @@ interface Publisher {
     publishEvent(event: UnsignedEvent, relayUrls: string[]): Promise<PublishReceipt>;
 }
 
-export { type BlobUpload as B, COMMENT_KIND as C, type FeeRates as F, type GitObjectUpload as G, MAINTAINERS_TAG as M, type Publisher as P, REPOSITORY_STATE_KIND as R, type StatusKind as S, type UnsignedEvent as U, type UploadReceipt as a, type PublishReceipt as b, type GitObjectType as c, type GitObject as d, MAX_OBJECT_SIZE as e, authorizedStatusAuthors as f, buildComment as g, buildIssue as h, buildPatch as i, buildRepoAnnouncement as j, buildRepoRefs as k, buildStatus as l, createGitBlob as m, createGitCommit as n, createGitTag as o, createGitTree as p, hashGitObject as q, parseMaintainers as r };
+export { type BlobUpload as B, COMMENT_KIND as C, type FeeRates as F, type GitObjectUpload as G, MAINTAINERS_TAG as M, type Publisher as P, REPOSITORY_STATE_KIND as R, type StoreJobRequest as S, type UploadReceipt as U, type StoreJobResponse as a, type UnsignedEvent as b, type PublishReceipt as c, type GitObjectType as d, type PayoutPointer as e, type GitObject as f, MAX_OBJECT_SIZE as g, PAYOUT_TAG as h, type PayoutChain as i, type StatusKind as j, authorizedStatusAuthors as k, buildComment as l, buildIssue as m, buildPatch as n, buildRepoAnnouncement as o, buildRepoRefs as p, buildStatus as q, createGitBlob as r, createGitCommit as s, createGitTag as t, createGitTree as u, hashGitObject as v, isValidEvmPayoutAddress as w, parseMaintainers as x, parsePayout as y };