@xgamesfun/solana 0.26.3 → 0.27.0

package/types/play/index.d.ts

@@ -60,13 +60,14 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
         settled: null;
         says: string;
     } | {
-        says?: undefined;
         order: any;
         won: any;
         assets: any;
         settled: any;
         parts?: any[] | undefined;
         asset?: any;
+        gone?: any[] | undefined;
+        says?: string | undefined;
     } | {
         signature: any;
         assets: any[];
@@ -80,13 +81,14 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
             settled: null;
             says: string;
         } | {
-            says?: undefined;
             order: any;
             won: any;
             assets: any;
             settled: any;
             parts?: any[] | undefined;
             asset?: any;
+            gone?: any[] | undefined;
+            says?: string | undefined;
         })[] | undefined;
     } | {
         orders: ({
@@ -98,70 +100,24 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
             settled: null;
             says: string;
         } | {
-            says?: undefined;
-            order: any;
-            won: any;
-            assets: any;
-            settled: any;
-            parts?: any[] | undefined;
-            asset?: any;
-        })[];
-        won: any[];
-        assets: any[];
-        parts: any[];
-    } | {
-        order: any;
-        settled: string;
-        says: string;
-        orders: ({
-            order: any;
-            settled: string;
-            says: string;
-        } | {
-            order: any;
-            settled: null;
-            says: string;
-        } | {
-            says?: undefined;
-            order: any;
-            won: any;
-            assets: any;
-            settled: any;
-            parts?: any[] | undefined;
-            asset?: any;
-        })[];
-        won: any[];
-        assets: any[];
-        parts: any[];
-    } | {
-        order: any;
-        settled: null;
-        says: string;
-        orders: ({
-            order: any;
-            settled: string;
-            says: string;
-        } | {
-            order: any;
-            settled: null;
-            says: string;
-        } | {
-            says?: undefined;
             order: any;
             won: any;
             assets: any;
             settled: any;
             parts?: any[] | undefined;
             asset?: any;
+            gone?: any[] | undefined;
+            says?: string | undefined;
         })[];
         won: any[];
         assets: any[];
         parts: any[];
     } | {
-        says?: undefined;
         order: any;
         settled: any;
         asset?: any;
+        gone?: any[] | undefined;
+        says?: string | undefined;
         orders: ({
             order: any;
             settled: string;
@@ -171,13 +127,14 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
             settled: null;
             says: string;
         } | {
-            says?: undefined;
             order: any;
             won: any;
             assets: any;
             settled: any;
             parts?: any[] | undefined;
             asset?: any;
+            gone?: any[] | undefined;
+            says?: string | undefined;
         })[];
         won: any[];
         assets: any[];
@@ -197,13 +154,14 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
         settled: null;
         says: string;
     } | {
-        says?: undefined;
         order: any;
         won: any;
         assets: any;
         settled: any;
         parts?: any[] | undefined;
         asset?: any;
+        gone?: any[] | undefined;
+        says?: string | undefined;
     } | {
         signature: any;
         assets: any[];
@@ -217,13 +175,14 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
             settled: null;
             says: string;
         } | {
-            says?: undefined;
             order: any;
             won: any;
             assets: any;
             settled: any;
             parts?: any[] | undefined;
             asset?: any;
+            gone?: any[] | undefined;
+            says?: string | undefined;
         })[] | undefined;
     } | {
         orders: ({
@@ -235,70 +194,24 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
             settled: null;
             says: string;
         } | {
-            says?: undefined;
-            order: any;
-            won: any;
-            assets: any;
-            settled: any;
-            parts?: any[] | undefined;
-            asset?: any;
-        })[];
-        won: any[];
-        assets: any[];
-        parts: any[];
-    } | {
-        order: any;
-        settled: string;
-        says: string;
-        orders: ({
-            order: any;
-            settled: string;
-            says: string;
-        } | {
-            order: any;
-            settled: null;
-            says: string;
-        } | {
-            says?: undefined;
             order: any;
             won: any;
             assets: any;
             settled: any;
             parts?: any[] | undefined;
             asset?: any;
+            gone?: any[] | undefined;
+            says?: string | undefined;
         })[];
         won: any[];
         assets: any[];
         parts: any[];
     } | {
-        order: any;
-        settled: null;
-        says: string;
-        orders: ({
-            order: any;
-            settled: string;
-            says: string;
-        } | {
-            order: any;
-            settled: null;
-            says: string;
-        } | {
-            says?: undefined;
-            order: any;
-            won: any;
-            assets: any;
-            settled: any;
-            parts?: any[] | undefined;
-            asset?: any;
-        })[];
-        won: any[];
-        assets: any[];
-        parts: any[];
-    } | {
-        says?: undefined;
         order: any;
         settled: any;
         asset?: any;
+        gone?: any[] | undefined;
+        says?: string | undefined;
         orders: ({
             order: any;
             settled: string;
@@ -308,13 +221,14 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
             settled: null;
             says: string;
         } | {
-            says?: undefined;
             order: any;
             won: any;
             assets: any;
             settled: any;
             parts?: any[] | undefined;
             asset?: any;
+            gone?: any[] | undefined;
+            says?: string | undefined;
         })[];
         won: any[];
         assets: any[];
@@ -330,13 +244,14 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
         settled: null;
         says: string;
     } | {
-        says?: undefined;
         order: any;
         won: any;
         assets: any;
         settled: any;
         parts?: any[] | undefined;
         asset?: any;
+        gone?: any[] | undefined;
+        says?: string | undefined;
     }>;
     /**
      * Finds the settle keys a page that closed left holding the player's SOL, and finishes their jobs: a key whose order
@@ -369,7 +284,9 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
         key: string;
         swept: bigint;
     })[]>;
-    /** Gives an order's payment back once its time has come (a roll that failed or never came). */
+    /** Gives an order's payment back once its time has come (a roll that failed or never came). An NFT the project
+     * held for the roll goes back with it; one it no longer holds (its collection took it back or burned it) is not
+     * looked for, and the whole payment goes back all the same. */
     refund(orderAddress: any): Promise<any>;
     /** Asks the oracle for a roll a mission, a recipe or a prize made (its player or the project's keys may; the asker
      * pays the oracle). Its first ask fixes its odds: the player's profile, and an NFT they show (`shown`; by default
@@ -550,18 +467,31 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
             settled: null;
             says: string;
         } | {
-            says?: undefined;
             order: any;
             won: any;
             assets: any;
             settled: any;
             parts?: any[] | undefined;
             asset?: any;
+            gone?: any[] | undefined;
+            says?: string | undefined;
         } | undefined;
     }>;
     /**
      * Hands an NFT of any kind to the project until a time (a hold): `seconds` from now, or `{ until }` (Unix seconds).
      * The hold's address names its end. Returns { signature, freeAt }.
+     *
+     * Like every route that hands an NFT in (`stakeNft` in escrow, `borrow`, `enter`, `bid`, `listForSale`,
+     * `listForRent`, a ticket paid with an NFT, a box that rolls on one), it first clears what an earlier owner of the
+     * NFT left in this project: a hold or a listing that stayed open when whoever controls the NFT's collection took it
+     * out of the project's hands. Left open, such a record could take the NFT once the project holds it again. The
+     * player holds the NFT now, so the program closes each on that proof (a hold by `release`, a listing by
+     * `take_listing`, nothing sent or paid), in front of the deposit in the same transaction, or in a transaction of
+     * their own before it when the two do not fit one. The closes cost the player their transaction fee only: each
+     * record's rent goes to whoever that record names (a hold's payer, a listing's maker), never to the player. Only
+     * what can't be closed still refuses the deposit, in words (a listing whose rental still runs: the program keeps
+     * it until the rental has run); `acceptLeftover: true` goes ahead all the same. NFTs of the project's own
+     * collections are not read.
      */
     hold(asset: any, seconds: any, { acceptLeftover, ...others }?: Readonly<Record<string, any>>): Promise<{
         signature: any;
@@ -613,7 +543,9 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
      * borrower in the same instruction: one prompt. `repay`: the debt the payer was shown (`loan()`'s, in base units);
      * the program refuses any other (`TermsChanged`). An NFT its collection took back or burned while the project held
      * it is refused here, before anything is signed: the program takes no repayment for it, and the borrower keeps what
-     * they borrowed. When the NFT can't move now (frozen for now, or its collection refuses the move), or `home` is
+     * they borrowed. Such a loan is closed for nothing instead: `claims()` lists it for its borrower and its lender, and
+     * `claim` of it closes the hold (nothing is repaid, and the hold's rent goes back to whoever paid it). When the NFT
+     * can't move now (frozen for now, or its collection refuses the move), or `home` is
      * false, the money goes alone, so the loan does not fall due: the hold is then over, and anyone sends the NFT home
      * once it can move (`claims()` lists it). A compressed NFT is proven in the same transaction; the money alone for one
      * whose proof keeps going out of date goes without it. Returns { signature, home }, and `says` when the NFT waits.
@@ -661,10 +593,10 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
      * be a hold one, and sends each on with a release after it (`releases`).
      */
     endAuction(auctionKey: any, { holders, ...others }?: Readonly<Record<string, any>>): Promise<{
-        says?: undefined;
         owedPaid: any;
         waiting?: undefined;
         paid: any;
+        says?: undefined;
         releases?: undefined;
     } | {
         owedPaid: any;
@@ -673,9 +605,9 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
         says: string;
         releases?: undefined;
     } | {
-        says?: undefined;
         owedPaid: any;
         waiting?: undefined;
+        says?: undefined;
         paid: any;
         releases: any[];
     } | {
@@ -687,7 +619,6 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
         waiting: boolean;
         says: string;
     } | {
-        says?: undefined;
         winner?: any;
         asset?: any;
         waiting?: undefined;
@@ -702,22 +633,24 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
             settled: null;
             says: string;
         } | {
-            says?: undefined;
             order: any;
             won: any;
             assets: any;
             settled: any;
             parts?: any[] | undefined;
             asset?: any;
+            gone?: any[] | undefined;
+            says?: string | undefined;
         } | undefined;
-    } | {
         says?: undefined;
+    } | {
         winner?: any;
         asset?: any;
         waiting?: undefined;
         signature: any;
         lotFirst: boolean;
         paid: any;
+        says?: undefined;
         releases?: undefined;
     } | {
         winner?: any;
@@ -729,12 +662,12 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
         says: string;
         releases?: undefined;
     } | {
-        says?: undefined;
         winner?: any;
         asset?: any;
         waiting?: undefined;
         signature: any;
         lotFirst: boolean;
+        says?: undefined;
         paid: any;
         releases: any[];
     }>;
@@ -745,10 +678,10 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
      * an NFT of the winning bid is gone (`endAuction` does it then). Refused once the lot went to its winner (`CantCallOff`).
      */
     callOffSale(auctionKey: any, { ...others }?: Readonly<Record<string, any>>): Promise<{
-        says?: undefined;
         owedPaid: any;
         waiting?: undefined;
         paid: any;
+        says?: undefined;
         releases?: undefined;
     } | {
         owedPaid: any;
@@ -757,9 +690,9 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
         says: string;
         releases?: undefined;
     } | {
-        says?: undefined;
         owedPaid: any;
         waiting?: undefined;
+        says?: undefined;
         paid: any;
         releases: any[];
     } | {
@@ -771,7 +704,6 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
         waiting: boolean;
         says: string;
     } | {
-        says?: undefined;
         winner?: any;
         asset?: any;
         waiting?: undefined;
@@ -786,22 +718,24 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
             settled: null;
             says: string;
         } | {
-            says?: undefined;
             order: any;
             won: any;
             assets: any;
             settled: any;
             parts?: any[] | undefined;
             asset?: any;
+            gone?: any[] | undefined;
+            says?: string | undefined;
         } | undefined;
-    } | {
         says?: undefined;
+    } | {
         winner?: any;
         asset?: any;
         waiting?: undefined;
         signature: any;
         lotFirst: boolean;
         paid: any;
+        says?: undefined;
         releases?: undefined;
     } | {
         winner?: any;
@@ -813,12 +747,12 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
         says: string;
         releases?: undefined;
     } | {
-        says?: undefined;
         winner?: any;
         asset?: any;
         waiting?: undefined;
         signature: any;
         lotFirst: boolean;
+        says?: undefined;
         paid: any;
         releases: any[];
     }>;
@@ -839,24 +773,64 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
      * `maxPeriods` at once. Nobody can end a rental early; the next renter takes it once one is over, until it is unlisted.
      */
     listForRent(asset: any, { price, lasts, maxPeriods, currency, shares, acceptLeftover, ...others }?: Readonly<Record<string, any>>): Promise<any>;
-    /** The listing of `asset` (one account read), or null: { listing, asset, maker, mint, deal, renter, until }. */
+    /**
+     * The listing of `asset` (one account read), or null: { listing, asset, maker, mint, deal, renter, until }. One more
+     * read says whether the project still holds the NFT: when whoever controls its collection took it back or burned
+     * it, the listing is flagged `gone` with `says`, what that means in words. There is then nothing to buy or rent,
+     * and the listing can be closed for nothing (`unlist` by its maker, `closeGone` by anyone).
+     */
     listing(asset: any): Promise<any>;
     /** Who rents `asset` now (one account read, then a check that the project still holds it), or null. */
     rentedTo(asset: any): Promise<any>;
-    /** The project's listings, a maker's (`maker`) or all: one search of the program's accounts. */
+    /**
+     * The project's listings, a maker's (`maker`) or all: one search of the program's accounts, then one read of the
+     * listed NFTs together, which flags a listing `gone` (with `says`) when the project no longer holds its NFT: a
+     * Core asset held by another or burned, a Token Metadata NFT whose token left the project's account. A compressed
+     * NFT is not read here (an indexer's answer for each): `listing(asset)` says it for one.
+     */
     listings({ maker, ...others }?: Readonly<Record<string, any>>): Promise<any>;
     /**
      * Buys a listed NFT at the terms the player saw: `listing`, as `listing()` or `listings()` showed it. It is
      * required: the terms signed are those, never the listing read now, so a price or a share changed since is refused.
+     * A listing whose NFT the project no longer holds (its collection took it back or burned it) is refused in words
+     * before anything is signed: nothing is there to buy, and anyone can close that listing for nothing (`closeGone`).
      */
     buyListing(asset: any, { listing, ...others }?: Readonly<Record<string, any>>): Promise<any>;
     /**
      * Rents a listed NFT for `periods` periods, at the terms the player saw: `listing`, as `listing()` or `listings()`
-     * showed it (required, as for `buyListing`).
+     * showed it (required, as for `buyListing`). One whose NFT the project no longer holds is refused in words, as
+     * `buyListing` refuses it.
      */
     rentListing(asset: any, { periods, listing, ...others }?: Readonly<Record<string, any>>): Promise<any>;
-    /** Takes a listed NFT home (its maker). While a rental runs it only stops the listing; call again once it is over. */
+    /**
+     * Takes a listed NFT home (its maker). While a rental runs it only stops the listing; call again once it is over.
+     * A listing whose NFT the project no longer holds (its collection took it back or burned it) closes without it, on
+     * that proof: nothing is sent, and the listing's rent comes back to its maker. While a rental of it still runs,
+     * that close too only stops the listing, and closes it once the rental has run.
+     */
     unlist(asset: any): Promise<any>;
+    /**
+     * Closes what this project still records of an NFT it no longer holds (`asset`: whoever controls its collection
+     * took it out of the project's hands or burned it): each hold of it (`release`) and its listing (`take_listing`),
+     * on the proof that it is gone. Anyone may, at any time, also while a hold runs and for a loan before it is due:
+     * nothing is sent or paid, and a loan's debt ends unpaid. The sender pays the transaction's fee only; each
+     * record's rent goes to whoever that record names (a hold's payer, a listing's maker), never to the sender. A
+     * listing whose rental still runs is left (`waits`): the program keeps a running rental, and the listing closes
+     * once it has run. Refused in words, with nothing sent, when the project still holds the NFT or nothing shows it
+     * gone. Returns { signature, closed: [{ kind, address }], waits: [{ kind, address }] }; `signature` is null when
+     * there was nothing to close.
+     */
+    closeGone(asset: any): Promise<{
+        signature: any;
+        closed: {
+            kind: any;
+            address: any;
+        }[];
+        waits: {
+            kind: any;
+            address: any;
+        }[];
+    }>;
     /**
      * The project's owner raffles an NFT they hold, as lottery `id`: the NFT goes into the lottery's own stash, where
      * nothing but the lottery can take it while a place names it; the winner gets it before any ticket money moves.
@@ -899,15 +873,126 @@ export declare function solanaApp({ spec, rpcUrl, rpc, wallet, programs, now, ke
     }[]>;
     /**
      * What this player can finish now, themselves: a box to settle or refund, a contest entry to claim, a held
-     * collectible to take home, an auction they won (or one off by the clock: their bid back), a lottery place they
+     * collectible to take home, a hold of theirs or a loan they made or took whose NFT the project no longer holds (its
+     * collection took it back or burned it: listed at any time, also while the hold runs, as a `release` flagged
+     * `gone`, whose claim closes the hold and sends nothing), an auction they won (or one off by the clock: their bid back), a lottery place they
      * won, a draw that is due (anyone may reveal it, or ask again when the oracle never answered; it takes 0.0008
      * SOL), and a drawn lottery's unpaid places, which anyone may pay so the next round can open. [{ kind, says, … }];
      * a winner's first claim of a contest of tokens carries `potUnits` and `prizeUnits`, its part as the decision wrote
      * it (base units, as text). Pass one to `claim`.
      */
-    claims(): Promise<any[]>;
+    claims(): Promise<({
+        key?: undefined;
+        tree?: undefined;
+        kind: string;
+        order: any;
+        says: string;
+        round?: undefined;
+        pulls?: undefined;
+        asset?: undefined;
+        table?: undefined;
+    } | {
+        key?: undefined;
+        tree?: undefined;
+        order?: undefined;
+        kind: string;
+        id: any;
+        side: any;
+        says: string;
+        potUnits?: string | undefined;
+        prizeUnits?: string | undefined;
+        round?: undefined;
+        pulls?: undefined;
+        asset?: undefined;
+        table?: undefined;
+    } | {
+        key?: undefined;
+        tree?: undefined;
+        order?: undefined;
+        kind: string;
+        asset: any;
+        hold: any;
+        gone: boolean;
+        says: string;
+        round?: undefined;
+        pulls?: undefined;
+        table?: undefined;
+    } | {
+        key?: undefined;
+        tree?: undefined;
+        order?: undefined;
+        kind: string;
+        asset: any;
+        hold: any;
+        says: string;
+        round?: undefined;
+        pulls?: undefined;
+        table?: undefined;
+    } | {
+        key?: undefined;
+        order?: undefined;
+        kind: string;
+        asset: string;
+        tree: string;
+        says: string;
+        round?: undefined;
+        pulls?: undefined;
+        table?: undefined;
+    } | {
+        tree?: undefined;
+        order?: undefined;
+        kind: string;
+        key: any;
+        says: string;
+        round?: undefined;
+        pulls?: undefined;
+        asset?: undefined;
+        table?: undefined;
+    } | {
+        tree?: undefined;
+        order?: undefined;
+        kind: string;
+        key: any;
+        round: any;
+        says: string;
+        pulls?: undefined;
+        asset?: undefined;
+        table?: undefined;
+    } | {
+        tree?: undefined;
+        order?: undefined;
+        kind: string;
+        key: any;
+        round: any;
+        pulls: any;
+        says: string;
+        asset?: undefined;
+        table?: undefined;
+    } | {
+        key?: undefined;
+        tree?: undefined;
+        order?: undefined;
+        round?: undefined;
+        pulls?: undefined;
+        kind: string;
+        asset: any;
+        says: string;
+        table?: undefined;
+    } | {
+        key?: undefined;
+        tree?: undefined;
+        order?: undefined;
+        round?: undefined;
+        pulls?: undefined;
+        asset?: undefined;
+        kind: string;
+        table: any;
+        says: string;
+    })[]>;
     /**
-     * Finishes one of `claims()`, signed by this player. Returns the signature. A winner of a contest of NFTs picks
+     * Finishes one of `claims()`, signed by this player. Returns the signature. A `release` flagged `gone` closes its
+     * hold on the proof that the project no longer holds the NFT: nothing is sent, the hold's rent goes back to whoever
+     * paid it, and a loan's debt ends unpaid. A winner of a contest of NFTs picks
      * which loser's NFT they take (`{ take: asset }`, the NFT of a losing entry that still holds one; the first found by default):
      * only the winner can, while any are left.
      */