@domino-sdk/relay 1.68.0 → 1.70.0

package/dist/solana.d.ts

@@ -1,26 +1,115 @@
-import { TransactionSigner, Rpc, GetAccountInfoApi, GetBlockHeightApi, GetLatestBlockhashApi, GetMinimumBalanceForRentExemptionApi, GetSignatureStatusesApi, SendTransactionApi, KeyPairSigner, Address, Signature } from '@solana/kit';
-import { S as SolanaNetwork } from './wallet-DQtJelQQ.js';
-export { s as solanaDevnet, t as solanaMainnet } from './wallet-DQtJelQQ.js';
-import { M as ManagementClient, W as WebhookEvent, C as CompletionReceipt } from './transport-CkidqTOk.js';
+import { Rpc, GetAccountInfoApi, GetBlockHeightApi, GetLatestBlockhashApi, GetMinimumBalanceForRentExemptionApi, GetSignatureStatusesApi, SendTransactionApi, GetTransactionApi, TransactionSigner, KeyPairSigner, Address, Signature } from '@solana/kit';
+import { l as SolanaNetwork } from './wallet-CJTULM0Q.js';
+export { s as solanaDevnet, m as solanaMainnet } from './wallet-CJTULM0Q.js';
+import { ManagementClient, WebhookEvent, CompletionReceipt } from './server/index.js';
 import 'zod';
-import './accounts-DnpKoJCo.js';
-import './tracker-data-CAK942sx.js';
-import './identity-integration-r76xaAax.js';
-import './reward-deliveries-0VvT6LMj.js';
-import './request-error-D_dUPLwo.js';
-import './action-9Xl0StBg.js';
-import './limits-ByVRQePO.js';
-import './automatic-outcomes-CQ3vpiQl.js';
-import './deployments-BCr418BX.js';
-import './offers-xcPbYaEv.js';
-import './catalog-BLGie8Lh.js';
-import './attempt-captures-DMNFMYFb.js';
+import './accounts-B49TGZLk.js';
+import './tracker-data-CUopgomU.js';
+import './identity-integration-BAJdzbdl.js';
+import './reward-deliveries-ARvt1UXb.js';
+import './request-error-C24SY7n9.js';
+import './action-BDFKqGlH.js';
+import './limits-UawUbr0S.js';
+import './automatic-outcomes-DeRyox-X.js';
+import './profiles-CLDKZVFx.js';
+import './deployments-QVGxC-fT.js';
+import './offers-0hqbnogq.js';
+import './catalog-CR_2iacf.js';
+import './attempt-captures-Dn-oGE1o.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";
 /**
@@ -45,8 +134,31 @@ type SolanaBadgeAward = {
 } | {
     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 AwardSolanaBadgeInput = {
+type SolanaBadgeOptions = {
     /**
      * A management client with `points` and `read` permission: it reads the member's wallets and
      * completions and records the receipt.
@@ -54,9 +166,10 @@ type AwardSolanaBadgeInput = {
     management: Pick<ManagementClient, "completions" | "members">;
     /** A delivery `verifyWebhook` verified. Events other than a quest's `completion.created` are ignored. */
     event: WebhookEvent;
-    /** The badge's Token-2022 mint, as `createSolanaBadgeMint` created it. */
-    mint: string;
-    /** The mint authority. It signs the mint and pays the fee and the member's token account rent. */
+    /**
+     * 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`. */
@@ -73,10 +186,12 @@ type AwardSolanaBadgeInput = {
     label?: string;
 };
 /**
- * Mints one unit of a non-transferable Token-2022 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. Call it from your webhook handler; your server holds the mint
- * authority and pays the fees.
+ * 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
@@ -113,7 +228,7 @@ type OwedSolanaBadges = {
  *
  * @experimental A minor release can change the Solana badge helpers.
  */
-type AwardOwedSolanaBadgesInput = Omit<AwardSolanaBadgeInput, "whenNoWallet">;
+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
@@ -168,4 +283,5 @@ declare function createSolanaBadgeMint(input: CreateSolanaBadgeMintInput): Promi
 /** The SPL Memo `awardSolanaBadge` attaches to a completion's mint. */
 declare const solanaBadgeMemo: (completion: string) => string;
 
-export { type AwardOwedSolanaBadgesInput, type AwardSolanaBadgeInput, type CreateSolanaBadgeMintInput, type OwedSolanaBadges, type SolanaBadgeAward, SolanaBadgePendingError, type SolanaBadgeRpc, SolanaNetwork, awardOwedSolanaBadges, awardSolanaBadge, createSolanaBadgeMint, solanaBadgeMemo, solanaBadgeReceiptKey };
+export { SolanaBadgePendingError, SolanaNetwork, awardOwedSolanaBadges, awardSolanaBadge, createSolanaBadgeMint, createSolanaBadgeTree, solanaBadgeMemo, solanaBadgeReceiptKey };
+export type { AwardOwedSolanaBadgesInput, AwardSolanaBadgeInput, CreateSolanaBadgeMintInput, CreateSolanaBadgeTreeInput, OwedSolanaBadges, SolanaBadgeAward, SolanaBadgeKind, SolanaBadgeOptions, SolanaBadgeRpc, SolanaBadgeTreeRent, SolanaCompressedBadge, SolanaCompressedBadgeRpc };