@domino-sdk/relay 1.67.0 → 1.69.0

package/dist/{sign-in-providers-BRYVOSlG.d.ts → sign-in-providers-C97mRNbG.d.ts}

@@ -1,6 +1,6 @@
-import { J as SignInProvider } from './accounts-C2O8mpB8.js';
+import { J as SignInProvider } from './accounts-DD4gAOCe.js';
 import * as z from 'zod';
-import { a as TelegramSignInMethods } from './submission-input-C152xIdn.js';
+import { a as TelegramSignInMethods } from './submission-input-BD7nORuh.js';
 
 /**
  * `GET /v1/auth/providers`, as `relay.auth.providers()` reads it. Exported as a schema only, for the
@@ -41,4 +41,5 @@ type AuthProviders = Omit<z.infer<typeof authProvidersSchema>, "telegram"> & {
     telegram?: TelegramSignInMethods;
 };
 
-export { type AuthProviders as A, authProvidersSchema as a };
+export { authProvidersSchema as a };
+export type { AuthProviders as A };

package/dist/solana.d.ts

@@ -0,0 +1,287 @@
+import { Rpc, GetAccountInfoApi, GetBlockHeightApi, GetLatestBlockhashApi, GetMinimumBalanceForRentExemptionApi, GetSignatureStatusesApi, SendTransactionApi, GetTransactionApi, TransactionSigner, KeyPairSigner, Address, Signature } from '@solana/kit';
+import { l as SolanaNetwork } from './wallet-CPAjrW4k.js';
+export { s as solanaDevnet, m as solanaMainnet } from './wallet-CPAjrW4k.js';
+import { ManagementClient, WebhookEvent, CompletionReceipt } from './server/index.js';
+import 'zod';
+import './accounts-DD4gAOCe.js';
+import './tracker-data-DQgX3FIc.js';
+import './identity-integration-BlfOn8rc.js';
+import './reward-deliveries-DFhYGJdx.js';
+import './request-error-C24SY7n9.js';
+import './action-BDFKqGlH.js';
+import './limits-Ctaeq23J.js';
+import './automatic-outcomes-DE3vfi8g.js';
+import './profiles-CLDKZVFx.js';
+import './deployments-BIfdCMd5.js';
+import './offers-COqHGbHm.js';
+import './catalog-Cf3fHDNn.js';
+import './attempt-captures-CbuCmthd.js';
+
+/**
+ * The RPC methods the badge helpers call. `createSolanaRpc(url)` from `@solana/kit` answers all of
+ * them.
+ */
+type SolanaBadgeRpc = Rpc<GetAccountInfoApi & GetBlockHeightApi & GetLatestBlockhashApi & GetMinimumBalanceForRentExemptionApi & GetSignatureStatusesApi & SendTransactionApi>;
+
+/**
+ * The RPC methods a compressed badge needs: `SolanaBadgeRpc`'s, and `getTransaction`, which reads
+ * the asset ID a mint created. `createSolanaRpc(url)` from `@solana/kit` answers all of them.
+ *
+ * @experimental A minor release can change the Solana badge helpers.
+ */
+type SolanaCompressedBadgeRpc = SolanaBadgeRpc & Rpc<GetTransactionApi>;
+/**
+ * A compressed NFT badge: each completion mints one cNFT into `tree`, in the Core `collection`,
+ * as `createSolanaBadgeTree` created them. `metadata` is each badge's on-chain name, symbol and
+ * metadata JSON URI.
+ *
+ * @experimental A minor release can change the Solana badge helpers.
+ */
+type SolanaCompressedBadge = {
+    kind: "cnft";
+    tree: string;
+    collection: string;
+    metadata: {
+        name: string;
+        symbol?: string;
+        uri: string;
+    };
+};
+/** @experimental A minor release can change the Solana badge helpers. */
+type CreateSolanaBadgeTreeInput = {
+    /**
+     * Becomes the tree's creator and delegate and the collection's update authority, so it alone
+     * can mint badges, and pays the rent.
+     */
+    authority: TransactionSigner;
+    rpc: SolanaBadgeRpc;
+    /**
+     * The tree's depth and change-log buffer: it holds 2^maxDepth badges, and `maxBufferSize` mints
+     * can land in the same block. One of Bubblegum's supported pairs, such as 14 and 64 (16,384
+     * badges).
+     */
+    maxDepth: number;
+    maxBufferSize: number;
+    /** The Core collection the badges belong to, which quests gate on with `ctx.wallet.nfts()`. */
+    collection: {
+        name: string;
+        uri: string;
+        /**
+         * Let members move and burn their badges. Omitted or false, the collection is permanently
+         * frozen, so its cNFTs can never be transferred or burned (soulbound).
+         */
+        transferable?: boolean;
+    };
+    /**
+     * Called with what the new accounts cost before anything is sent; answering false sends nothing
+     * and throws. Omit to print the rent with `console.info` and go ahead.
+     */
+    confirmRent?: (rent: SolanaBadgeTreeRent) => boolean | Promise<boolean>;
+    /** The new tree's and collection's key pairs. Omit to generate them. */
+    tree?: KeyPairSigner;
+    collectionKey?: KeyPairSigner;
+};
+/**
+ * What `createSolanaBadgeTree` pays: rent-exempt lamports for the tree, its config and the
+ * collection, and how many badges the tree holds. Rent comes back only if the accounts are closed.
+ *
+ * @experimental A minor release can change the Solana badge helpers.
+ */
+type SolanaBadgeTreeRent = {
+    lamports: bigint;
+    /** `lamports` in SOL, as a decimal string. */
+    sol: string;
+    capacity: number;
+    treeBytes: number;
+};
+/**
+ * Creates a Bubblegum v2 Merkle tree and a Core collection for compressed badges
+ * (`awardSolanaBadge` with `badge: { kind: "cnft", tree, collection, metadata }`), in one
+ * transaction, after stating the rent it costs. The collection has the `BubblegumV2` plugin, and
+ * unless `collection.transferable`, a `PermanentFreezeDelegate` that freezes it with no authority
+ * to thaw it, so its badges are soulbound. The tree is private: only `authority` mints into it.
+ * Run it once, for example from a setup script, and keep both addresses.
+ *
+ * @experimental A minor release can change the Solana badge helpers.
+ */
+declare function createSolanaBadgeTree(input: CreateSolanaBadgeTreeInput): Promise<{
+    tree: Address;
+    collection: Address;
+    signature: Signature;
+}>;
+
+/** The receipt key `awardSolanaBadge` records a badge under. */
+declare const solanaBadgeReceiptKey = "badge";
+/**
+ * What `awardSolanaBadge` did. `minted` and `already-minted` carry the completion's badge
+ * receipt; `no-wallet` means the member has no proven Solana wallet, and nothing was sent;
+ * `deferred` is `no-wallet` under `whenNoWallet: "defer"`, so `awardOwedSolanaBadges` mints the
+ * badge once the member links one; `ignored` means the event is not a quest completion, or its
+ * quest is outside `quests`.
+ *
+ * @experimental A minor release can change the Solana badge helpers.
+ */
+type SolanaBadgeAward = {
+    status: "minted";
+    receipt: CompletionReceipt;
+} | {
+    status: "already-minted";
+    receipt: CompletionReceipt;
+} | {
+    status: "no-wallet";
+} | {
+    status: "deferred";
+} | {
+    status: "ignored";
+};
+/**
+ * `awardSolanaBadge`'s input: the badge (a Token-2022 `mint`, or a compressed `badge`), its
+ * authority and RPC, and which completions to award.
+ *
+ * @experimental A minor release can change the Solana badge helpers.
+ */
+type AwardSolanaBadgeInput = SolanaBadgeOptions & SolanaBadgeKind;
+/**
+ * The badge `awardSolanaBadge` mints: one unit of a Token-2022 `mint`, or a compressed NFT
+ * (`badge`, whose `rpc` also answers `getTransaction`).
+ *
+ * @experimental A minor release can change the Solana badge helpers.
+ */
+type SolanaBadgeKind = {
+    /** The badge's Token-2022 mint, as `createSolanaBadgeMint` created it. */
+    mint: string;
+    badge?: never;
+} | {
+    /** A compressed NFT badge in the tree and collection `createSolanaBadgeTree` created. */
+    badge: SolanaCompressedBadge;
+    mint?: never;
+    rpc: SolanaCompressedBadgeRpc;
+};
+/** @experimental A minor release can change the Solana badge helpers. */
+type SolanaBadgeOptions = {
+    /**
+     * A management client with `points` and `read` permission: it reads the member's wallets and
+     * completions and records the receipt.
+     */
+    management: Pick<ManagementClient, "completions" | "members">;
+    /** A delivery `verifyWebhook` verified. Events other than a quest's `completion.created` are ignored. */
+    event: WebhookEvent;
+    /**
+     * The mint authority, or for a compressed badge the tree's delegate and the collection's update
+     * authority. It signs the mint and pays the fees and any rent.
+     */
+    authority: TransactionSigner;
+    rpc: SolanaBadgeRpc;
+    /** The cluster `rpc` serves, recorded on the receipt: `solanaMainnet` or `solanaDevnet`. */
+    network: SolanaNetwork;
+    /** Award only completions of these quest IDs. Omit to award every quest's completions. */
+    quests?: readonly string[];
+    /**
+     * What happens when the member has no proven Solana wallet. Both send nothing: `skip` (the
+     * default) answers `no-wallet`, and `defer` answers `deferred`, for a server that also calls
+     * `awardOwedSolanaBadges` on `wallet.linked` to mint the badge once the member links a wallet.
+     */
+    whenNoWallet?: "skip" | "defer";
+    /** Receipt `label` Console shows beside it. */
+    label?: string;
+};
+/**
+ * Mints a badge to the member's most recently linked proven Solana wallet for a quest's
+ * `completion.created` event, and records the transaction as the completion's `badge` receipt:
+ * one unit of a non-transferable Token-2022 `mint` (receipt `asset`: the mint), or with
+ * `badge: { kind: "cnft", tree, collection, metadata }` one compressed NFT, minted with Bubblegum
+ * v2's `mint_v2` into the tree and collection (receipt `asset`: the cNFT's asset ID). Call it from
+ * your webhook handler; your server holds the authority and pays the fees.
+ *
+ * Exactly once per completion, whatever the deliveries and retries. Before sending, it records the
+ * signed transaction as a `badge-attempt-<n>` receipt, which only one call can record, and only
+ * then sends it. A call that finds an earlier attempt records it as the badge once it landed,
+ * sends a new attempt once it failed or its blockhash expired, and otherwise throws
+ * `SolanaBadgePendingError` without sending, so the delivery is retried later. It waits for the
+ * `confirmed` commitment.
+ *
+ * Requires the optional peer dependencies `@solana/kit` and `@solana-program/token-2022`.
+ *
+ * @experimental A minor release can change the Solana badge helpers.
+ */
+declare function awardSolanaBadge(input: AwardSolanaBadgeInput): Promise<SolanaBadgeAward>;
+/**
+ * What `awardOwedSolanaBadges` did: `awarded` with each owed completion and what
+ * `awardSolanaBadge` did for it (`minted`, `already-minted`, or `no-wallet` when the member has
+ * unlinked the wallet since), or `ignored` when the event is not a Solana `wallet.linked`.
+ *
+ * @experimental A minor release can change the Solana badge helpers.
+ */
+type OwedSolanaBadges = {
+    status: "awarded";
+    awards: {
+        completion: string;
+        quest: string;
+        award: SolanaBadgeAward;
+    }[];
+} | {
+    status: "ignored";
+};
+/**
+ * `awardSolanaBadge`'s input for a `wallet.linked` event: the same badge, mint authority and
+ * `quests`.
+ *
+ * @experimental A minor release can change the Solana badge helpers.
+ */
+type AwardOwedSolanaBadgesInput = Omit<SolanaBadgeOptions, "whenNoWallet"> & SolanaBadgeKind;
+/**
+ * Mints the badges a member is owed once they link a Solana wallet: call it from your webhook
+ * handler for `wallet.linked`, next to `awardSolanaBadge` with `whenNoWallet: "defer"` for
+ * `completion.created`. For a Solana wallet, it lists the member's completions that count (not
+ * revoked) of each quest in `quests` (every quest when omitted) and awards each one exactly as
+ * `awardSolanaBadge` does, so a completion that has its `badge` receipt mints nothing and a
+ * redelivered event mints nothing new. Other events and chains are `ignored`.
+ *
+ * It mints one completion at a time and throws on the first failure, such as
+ * `SolanaBadgePendingError`: fail the delivery so Domino retries it, and the retry skips the badges
+ * already minted.
+ *
+ * @experimental A minor release can change the Solana badge helpers.
+ */
+declare function awardOwedSolanaBadges(input: AwardOwedSolanaBadgesInput): Promise<OwedSolanaBadges>;
+/**
+ * An earlier call's badge transaction for this completion has not landed yet, and its blockhash
+ * is still valid. Nothing was sent; call again later, for example by failing the webhook delivery
+ * so Domino retries it.
+ *
+ * @experimental A minor release can change the Solana badge helpers.
+ */
+declare class SolanaBadgePendingError extends Error {
+    readonly signature: string;
+    readonly code = "badge-pending";
+    constructor(signature: string);
+}
+/** @experimental A minor release can change the Solana badge helpers. */
+type CreateSolanaBadgeMintInput = {
+    /** Becomes the mint and metadata authority, and pays for the mint account. */
+    authority: TransactionSigner;
+    rpc: SolanaBadgeRpc;
+    /** The badge's on-chain name, symbol and metadata JSON URI, which wallets and explorers show. */
+    name: string;
+    symbol: string;
+    uri: string;
+    /** The new mint's key pair. Omit to generate one. */
+    mint?: KeyPairSigner;
+};
+/**
+ * Creates a badge mint for `awardSolanaBadge`: a Token-2022 mint with 0 decimals, the
+ * NonTransferable extension, so its tokens can't move from the wallet they were minted to, and
+ * on-mint metadata (the metadata pointer and token metadata extensions). Run it once per badge,
+ * for example from a setup script, and keep the mint address.
+ *
+ * @experimental A minor release can change the Solana badge helpers.
+ */
+declare function createSolanaBadgeMint(input: CreateSolanaBadgeMintInput): Promise<{
+    mint: Address;
+    signature: Signature;
+}>;
+/** The SPL Memo `awardSolanaBadge` attaches to a completion's mint. */
+declare const solanaBadgeMemo: (completion: string) => string;
+
+export { SolanaBadgePendingError, SolanaNetwork, awardOwedSolanaBadges, awardSolanaBadge, createSolanaBadgeMint, createSolanaBadgeTree, solanaBadgeMemo, solanaBadgeReceiptKey };
+export type { AwardOwedSolanaBadgesInput, AwardSolanaBadgeInput, CreateSolanaBadgeMintInput, CreateSolanaBadgeTreeInput, OwedSolanaBadges, SolanaBadgeAward, SolanaBadgeKind, SolanaBadgeOptions, SolanaBadgeRpc, SolanaBadgeTreeRent, SolanaCompressedBadge, SolanaCompressedBadgeRpc };