@domino-sdk/relay 0.24.0 → 0.25.0

package/dist/authoring.d.ts

@@ -1,5 +1,5 @@
-import { A as AdmittedContent, O as Observation, T as TrackerReader, X as XReader, I as ImageReader, D as DiscordMember, a as DiscordMessage, W as WalletConnection, S as SolanaBalance, o as observationTriggerSchema, B as Budget, b as AuthoringIdentity, C as ContentMetric, c as IntegrationProvider, d as StreakPolicy, e as TextEvidence, U as UrlEvidence, f as TextOptions, g as UrlOptions } from './submission-input-CK4Dy19H.js';
-export { h as content, i as customSource, j as defineEngagementReward, k as defineLeaderboard, l as defineReferral, m as defineTracker, n as discord, p as perContent, q as pointLedgers, s as settings, r as streak, x } from './submission-input-CK4Dy19H.js';
+import { A as AdmittedContent, O as Observation, T as TrackerTriggerContext, a as TrackerReader, X as XReader, I as ImageReader, D as DiscordMember, b as DiscordMessage, W as WalletConnection, S as SolanaBalance, L as LinkedWallet, c as WalletBalanceQuery, d as WalletBalance, o as observationTriggerSchema, e as TrackerDefinition, f as TrackerBeneficiary, g as TrackerTriggerPolicy, B as Budget, h as AuthoringIdentity, C as ContentMetric, i as IntegrationProvider, j as StreakPolicy, k as TextEvidence, U as UrlEvidence, l as TextOptions, m as UrlOptions } from './submission-input-Ckpb4sBv.js';
+export { n as content, p as customSource, q as defineEngagementReward, r as defineLeaderboard, s as defineReferral, t as defineTracker, u as discord, v as formatUnits, w as parseUnits, x as perContent, y as pointLedgers, z as settings, E as streak, F as trackerTriggerContextSchema, G as x } from './submission-input-Ckpb4sBv.js';
 import { z } from 'zod';
 import { TextReviewInput, TextResult, PhotoResult, rewardSchema, triggerSchema, QuestPresentation, QuizEvidence, Decision, TieredRewardDefinition } from './schema.js';
 
@@ -58,17 +58,35 @@ declare function manual(options: {
     input: "none";
     actor: "staff";
 };
-declare const automatic: (observation?: z.infer<typeof observationTriggerSchema>) => {
-    observation?: {
-        source: string;
-        type: string;
-    } | undefined;
+/**
+ * An automatic quest. With no argument it runs once its prerequisites are complete; with an
+ * observation it runs for each matching observation; with a tracker it runs for each new record
+ * observation (each newly discovered post, for an X tracker), for the member Relay attributes the
+ * record to.
+ */
+declare function automatic(): {
     kind: "automatic";
 };
+declare function automatic(observation: z.infer<typeof observationTriggerSchema>): {
+    kind: "automatic";
+    observation: z.infer<typeof observationTriggerSchema>;
+};
+declare function automatic(input: {
+    tracker: TrackerDefinition;
+    /**
+     * Whose quest each record is. `"author"` (the default): the member who verified the record
+     * author's wallet (custom trackers) or X account (X trackers). `"replied-to"`: the member whose
+     * verified X account an X post replies to.
+     */
+    beneficiary?: TrackerBeneficiary;
+}): {
+    kind: "automatic";
+    tracker: TrackerTriggerPolicy;
+};
 declare const budget: (definition: Budget) => {
     id: string;
     scope: "member" | "project";
-    period: "lifetime" | "day";
+    period: "lifetime" | "day" | "week";
     limit: number;
     cost: number | {
         balance: string;
@@ -80,6 +98,8 @@ declare const keyed: (key: (ctx: {
     };
     content?: AdmittedContent | null;
     observation: Observation | null;
+    /** The pinned tracker observation of a tracker-triggered quest. */
+    tracker?: TrackerTriggerContext | null;
     eligibleAt: number;
 }) => string) => {
     kind: "keyed";
@@ -89,6 +109,8 @@ declare const keyed: (key: (ctx: {
         };
         content?: AdmittedContent | null;
         observation: Observation | null;
+        /** The pinned tracker observation of a tracker-triggered quest. */
+        tracker?: TrackerTriggerContext | null;
         eligibleAt: number;
     }) => string;
 };
@@ -161,6 +183,11 @@ type EvaluationContext<T, I = {
     input: I;
     content: AdmittedContent | null;
     observation: Observation | null;
+    /**
+     * The tracker observation that admitted this attempt, and the member and verified account it
+     * was attributed to. Null unless the quest has a tracker trigger.
+     */
+    tracker: TrackerTriggerContext | null;
     eligibleAt: number;
     trackers: TrackerReader;
     x: XReader;
@@ -180,8 +207,18 @@ type EvaluationContext<T, I = {
         }): Promise<DiscordMessage | null>;
     };
     wallet: {
+        /** The member's newest linked Solana wallet. */
         connection(): Promise<WalletConnection | null>;
+        /** SOL held by the newest linked Solana wallet. */
         solanaBalance(): Promise<SolanaBalance | null>;
+        /** Every wallet the member has linked to this project, pinned once per attempt. */
+        list(): Promise<LinkedWallet[]>;
+        /**
+         * The native or token balance of the member's pinned linked wallets on one chain: all wallets of
+         * that family, or `address` (which must be one of them). No wallets gives `total: "0"` and
+         * `wallets: []`. Provider failures throw; they never read as a zero balance.
+         */
+        balance(query: WalletBalanceQuery): Promise<WalletBalance>;
     };
 };
 type Evaluator<T, I = {
@@ -400,6 +437,11 @@ declare function defineQuest<T extends Record<string, z.ZodType>, const G extend
                 posts: "after-enrollment" | "since-start";
                 historical: "staff" | "automatic" | "claim";
             } | undefined;
+            tracker?: {
+                tracker: string;
+                source: "custom" | "x-search";
+                beneficiary: "author" | "replied-to";
+            } | undefined;
         } | {
             kind: "manual";
             input: "text";
@@ -439,7 +481,7 @@ declare function defineQuest<T extends Record<string, z.ZodType>, const G extend
         budgets: {
             id: string;
             scope: "member" | "project";
-            period: "lifetime" | "day";
+            period: "lifetime" | "day" | "week";
             limit: number;
             cost: number | {
                 balance: string;
@@ -460,4 +502,4 @@ declare function defineQuest<T extends Record<string, z.ZodType>, const G extend
  * Console instances receive independent quest identities and pinned versions. */
 declare const defineQuestType: typeof defineQuest;
 
-export { type EvaluationContext, automatic, budget, completed, decision, defineQuest, defineQuestType, defineTieredReward, discordRole, evaluators, evidence, keyed, manual, once, points, staffHandover, untracked };
+export { type EvaluationContext, TrackerTriggerContext, WalletBalance, WalletBalanceQuery, automatic, budget, completed, decision, defineQuest, defineQuestType, defineTieredReward, discordRole, evaluators, evidence, keyed, manual, once, points, staffHandover, untracked };

package/dist/authoring.js

@@ -2,8 +2,11 @@ import {
   authoringKey,
   defineEngagementReward,
   defineLeaderboard,
-  defineReferral
-} from "./chunk-ZOL7RYHW.js";
+  defineReferral,
+  formatUnits,
+  parseUnits
+} from "./chunk-AKB266O5.js";
+import "./chunk-D6BX627V.js";
 import {
   admittedContentSchema,
   budgetSchema,
@@ -28,9 +31,11 @@ import {
   textOptionsSchema,
   tierRewardSchema,
   tieredRewardDefinitionSchema,
+  trackerTriggerContextSchema,
+  trackerTriggerPolicySchema,
   urlOptionsSchema,
   x
-} from "./chunk-UYS522ER.js";
+} from "./chunk-IXLY3A7B.js";
 
 // src/authoring.ts
 import { z } from "zod";
@@ -63,10 +68,31 @@ function manual(options) {
     ...options?.actor ? { actor: options.actor } : {}
   };
 }
-var automatic = (observation) => ({
-  kind: "automatic",
-  ...observation ? { observation } : {}
-});
+function automatic(input) {
+  if (!input) {
+    return { kind: "automatic" };
+  }
+  if ("tracker" in input) {
+    const { tracker, beneficiary = "author" } = input;
+    if (beneficiary === "replied-to" && tracker.source.kind !== "x-search") {
+      throw new Error('"replied-to" requires an X tracker');
+    }
+    if (tracker.source.kind === "custom" && tracker.source.authors !== "wallet") {
+      throw new Error(
+        'Tracker triggers need attributable authors: use customSource(namespace, { authors: "wallet" })'
+      );
+    }
+    return {
+      kind: "automatic",
+      tracker: trackerTriggerPolicySchema.parse({
+        tracker: tracker.key,
+        source: tracker.source.kind,
+        beneficiary
+      })
+    };
+  }
+  return { kind: "automatic", observation: input };
+}
 var budget = (definition) => budgetSchema.parse(definition);
 var keyed = (key) => ({ kind: "keyed", key });
 var completed = (quest) => ({
@@ -134,6 +160,10 @@ function defineQuest(definition) {
   if (definition.performance && !contentTrigger) {
     throw new Error("Performance requires a content trigger");
   }
+  const trackerTrigger = definition.trigger.kind === "automatic" && definition.trigger.tracker !== void 0;
+  if (trackerTrigger && definition.completion.kind === "streak") {
+    throw new Error("Tracker triggers complete once() or keyed()");
+  }
   const contentCompletion = "perContent" in definition.completion;
   if (contentTrigger !== contentCompletion) {
     throw new Error(
@@ -198,6 +228,7 @@ function defineQuest(definition) {
     describe,
     async evaluate(ctx) {
       const settings2 = definition.settings.parse(ctx.settings);
+      const tracker = trackerTrigger ? trackerTriggerContextSchema.parse(ctx.tracker) : null;
       if (ctx.performance) {
         if (!definition.performance) {
           throw new Error("Quest has no performance evaluator");
@@ -235,6 +266,7 @@ function defineQuest(definition) {
         input: ctx.input,
         content: contentTrigger ? admittedContentSchema.parse(ctx.content) : null,
         observation: ctx.observation ?? null,
+        tracker,
         eligibleAt: ctx.eligibleAt,
         review: ctx.review,
         trackers: ctx.trackers,
@@ -253,7 +285,12 @@ function defineQuest(definition) {
         result.kind === "accept" || result.kind === "review" ? {
           ...result,
           rewards: result.rewards ?? ctx.rewards,
-          ...definition.completion.kind === "keyed" ? { completionKey: definition.completion.key(ctx) } : {}
+          ...definition.completion.kind === "keyed" ? {
+            completionKey: definition.completion.key({
+              ...ctx,
+              tracker
+            })
+          } : {}
         } : result
       );
     }
@@ -278,15 +315,18 @@ export {
   discordRole,
   evaluators,
   evidence,
+  formatUnits,
   keyed,
   manual,
   once,
+  parseUnits,
   perContent,
   pointLedgers,
   points,
   settings,
   staffHandover,
   streak,
+  trackerTriggerContextSchema,
   untracked,
   x
 };