gondi 0.49.0 → 0.51.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2,10 +2,10 @@ import { OperationVariables } from '@apollo/client/core/index.js';
2
2
  import { Maybe } from 'graphql/jsutils/Maybe';
3
3
  import { Account, Address, Hash, Hex, TransactionReceipt } from 'viem';
4
4
  import { Auction } from './blockchain';
5
- import { Api, Props as ApiProps } from './clients/api';
5
+ import { Api, OrderInput, Props as ApiProps } from './clients/api';
6
6
  import { Contracts, GondiPublicClient, Wallet } from './clients/contracts';
7
7
  import { CrossCurrencyRenegotiationInput, CrossCurrencyRenegotiationQuote } from './clients/contracts/CrossCurrencyRenegotiation';
8
- import { CollectionOrderInput, DealInput, GenerateCollectionOfferHashMutation, LoanOfferPublicationInput, MarketplaceEnum, NftOrderInput, OfferValidatorInput, SingleNftOrderInput, SingleNftSignedOfferInput, TokenStandardType, TraitOrderInput } from './generated/graphql';
8
+ import { DealInput, GenerateCollectionOfferHashMutation, LoanOfferPublicationInput, MarketplaceEnum, NftOrderInput, OfferValidatorInput, SingleNftOrderInput, SingleNftSignedOfferInput, TokenStandardType } from './generated/graphql';
9
9
  import * as model from './model';
10
10
  import { NftStandard } from './model';
11
11
  import { BuyWithLoanInput, BuyWithLoanQuote } from './utils/buyWithLoan';
@@ -281,7 +281,15 @@ export declare class Gondi {
281
281
  }>;
282
282
  saveOffer: (signedOffer: TOffer & MakeOfferSignedFields) => Promise<TSaved>;
283
283
  }): Promise<TSaved>;
284
- makeOrder(orderInput: SingleNftOrderInput | CollectionOrderInput | TraitOrderInput): Promise<{
284
+ /**
285
+ * Publishes a bid or listing, signing the order when the API asks for it.
286
+ *
287
+ * The input picks the kind: `tokenId` for one NFT, `traitIds` for a trait bid,
288
+ * `nftIds` for a set bid that fills with any of the listed NFTs of
289
+ * `collectionId` (2 to 1,000), and `collectionId` alone for a collection bid.
290
+ * A trait, set or collection bid fills up to `maxExecutions` times.
291
+ */
292
+ makeOrder(orderInput: OrderInput): Promise<{
285
293
  amount?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
286
294
  contractAddress: import("./generated/graphql").Scalars["Address"];
287
295
  currencyAddress: import("./generated/graphql").Scalars["Address"];
@@ -332,6 +340,24 @@ export declare class Gondi {
332
340
  id: string;
333
341
  status: string;
334
342
  marketPlaceAddress: Address;
343
+ } | {
344
+ amount?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
345
+ collectionId: import("./generated/graphql").Scalars["Int"];
346
+ currencyAddress: import("./generated/graphql").Scalars["Address"];
347
+ expirationTime: import("./generated/graphql").Scalars["BigInt"];
348
+ fees?: import("./generated/graphql").InputMaybe<Array<import("./generated/graphql").OrderFee>>;
349
+ isAsk?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Boolean"]>;
350
+ maxExecutions?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
351
+ nftIds: Array<import("./generated/graphql").Scalars["Int"]>;
352
+ price?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
353
+ signature: import("./generated/graphql").InputMaybe<`0x${string}`>;
354
+ startTime: import("./generated/graphql").Scalars["BigInt"];
355
+ stealth?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Boolean"]>;
356
+ taker?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Address"]>;
357
+ __typename?: "MultipleTraitOrder";
358
+ id: string;
359
+ status: string;
360
+ marketPlaceAddress: Address;
335
361
  } | {
336
362
  amount?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
337
363
  contractAddress: import("./generated/graphql").Scalars["Address"];
@@ -383,6 +409,24 @@ export declare class Gondi {
383
409
  id: string;
384
410
  status: string;
385
411
  marketPlaceAddress: Address;
412
+ } | {
413
+ amount?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
414
+ collectionId: import("./generated/graphql").Scalars["Int"];
415
+ currencyAddress: import("./generated/graphql").Scalars["Address"];
416
+ expirationTime: import("./generated/graphql").Scalars["BigInt"];
417
+ fees?: import("./generated/graphql").InputMaybe<Array<import("./generated/graphql").OrderFee>>;
418
+ isAsk?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Boolean"]>;
419
+ maxExecutions?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
420
+ nftIds: Array<import("./generated/graphql").Scalars["Int"]>;
421
+ price?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
422
+ signature: import("./generated/graphql").InputMaybe<`0x${string}`>;
423
+ startTime: import("./generated/graphql").Scalars["BigInt"];
424
+ stealth?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Boolean"]>;
425
+ taker?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Address"]>;
426
+ __typename?: "TraitOrder";
427
+ id: string;
428
+ status: string;
429
+ marketPlaceAddress: Address;
386
430
  } | {
387
431
  amount?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
388
432
  contractAddress: import("./generated/graphql").Scalars["Address"];
@@ -434,6 +478,93 @@ export declare class Gondi {
434
478
  id: string;
435
479
  status: string;
436
480
  marketPlaceAddress: Address;
481
+ } | {
482
+ amount?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
483
+ collectionId: import("./generated/graphql").Scalars["Int"];
484
+ currencyAddress: import("./generated/graphql").Scalars["Address"];
485
+ expirationTime: import("./generated/graphql").Scalars["BigInt"];
486
+ fees?: import("./generated/graphql").InputMaybe<Array<import("./generated/graphql").OrderFee>>;
487
+ isAsk?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Boolean"]>;
488
+ maxExecutions?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
489
+ nftIds: Array<import("./generated/graphql").Scalars["Int"]>;
490
+ price?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
491
+ signature: import("./generated/graphql").InputMaybe<`0x${string}`>;
492
+ startTime: import("./generated/graphql").Scalars["BigInt"];
493
+ stealth?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Boolean"]>;
494
+ taker?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Address"]>;
495
+ __typename?: "SingleNFTOrder";
496
+ id: string;
497
+ status: string;
498
+ marketPlaceAddress: Address;
499
+ } | {
500
+ amount?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
501
+ contractAddress: import("./generated/graphql").Scalars["Address"];
502
+ currencyAddress: import("./generated/graphql").Scalars["Address"];
503
+ expirationTime: import("./generated/graphql").Scalars["BigInt"];
504
+ fees?: import("./generated/graphql").InputMaybe<Array<import("./generated/graphql").OrderFee>>;
505
+ isAsk?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Boolean"]>;
506
+ price?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
507
+ signature: import("./generated/graphql").InputMaybe<`0x${string}`>;
508
+ startTime: import("./generated/graphql").Scalars["BigInt"];
509
+ stealth?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Boolean"]>;
510
+ taker?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Address"]>;
511
+ tokenId: import("./generated/graphql").Scalars["BigInt"];
512
+ __typename?: "SetBidOrder";
513
+ id: string;
514
+ status: string;
515
+ marketPlaceAddress: Address;
516
+ } | {
517
+ amount?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
518
+ collectionId: import("./generated/graphql").Scalars["Int"];
519
+ currencyAddress: import("./generated/graphql").Scalars["Address"];
520
+ expirationTime: import("./generated/graphql").Scalars["BigInt"];
521
+ fees?: import("./generated/graphql").InputMaybe<Array<import("./generated/graphql").OrderFee>>;
522
+ isAsk?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Boolean"]>;
523
+ maxExecutions?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
524
+ price?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
525
+ signature: import("./generated/graphql").InputMaybe<`0x${string}`>;
526
+ startTime: import("./generated/graphql").Scalars["BigInt"];
527
+ stealth?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Boolean"]>;
528
+ taker?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Address"]>;
529
+ __typename?: "SetBidOrder";
530
+ id: string;
531
+ status: string;
532
+ marketPlaceAddress: Address;
533
+ } | {
534
+ amount?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
535
+ currencyAddress: import("./generated/graphql").Scalars["Address"];
536
+ expirationTime: import("./generated/graphql").Scalars["BigInt"];
537
+ fees?: import("./generated/graphql").InputMaybe<Array<import("./generated/graphql").OrderFee>>;
538
+ isAsk?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Boolean"]>;
539
+ maxExecutions?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
540
+ price?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
541
+ signature: import("./generated/graphql").InputMaybe<`0x${string}`>;
542
+ startTime: import("./generated/graphql").Scalars["BigInt"];
543
+ stealth?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Boolean"]>;
544
+ taker?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Address"]>;
545
+ traitIds: Array<import("./generated/graphql").Scalars["Int"]>;
546
+ __typename?: "SetBidOrder";
547
+ id: string;
548
+ status: string;
549
+ marketPlaceAddress: Address;
550
+ } | {
551
+ amount?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
552
+ collectionId: import("./generated/graphql").Scalars["Int"];
553
+ currencyAddress: import("./generated/graphql").Scalars["Address"];
554
+ expirationTime: import("./generated/graphql").Scalars["BigInt"];
555
+ fees?: import("./generated/graphql").InputMaybe<Array<import("./generated/graphql").OrderFee>>;
556
+ isAsk?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Boolean"]>;
557
+ maxExecutions?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
558
+ nftIds: Array<import("./generated/graphql").Scalars["Int"]>;
559
+ price?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
560
+ signature: import("./generated/graphql").InputMaybe<`0x${string}`>;
561
+ startTime: import("./generated/graphql").Scalars["BigInt"];
562
+ stealth?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Boolean"]>;
563
+ taker?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Address"]>;
564
+ __typename?: "SetBidOrder";
565
+ id: string;
566
+ status: string;
567
+ marketPlaceAddress: Address;
437
568
  } | {
438
569
  amount?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
439
570
  contractAddress: import("./generated/graphql").Scalars["Address"];
@@ -485,6 +616,24 @@ export declare class Gondi {
485
616
  id: string;
486
617
  status: string;
487
618
  marketPlaceAddress: Address;
619
+ } | {
620
+ amount?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
621
+ collectionId: import("./generated/graphql").Scalars["Int"];
622
+ currencyAddress: import("./generated/graphql").Scalars["Address"];
623
+ expirationTime: import("./generated/graphql").Scalars["BigInt"];
624
+ fees?: import("./generated/graphql").InputMaybe<Array<import("./generated/graphql").OrderFee>>;
625
+ isAsk?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Boolean"]>;
626
+ maxExecutions?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
627
+ nftIds: Array<import("./generated/graphql").Scalars["Int"]>;
628
+ price?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["BigInt"]>;
629
+ signature: import("./generated/graphql").InputMaybe<`0x${string}`>;
630
+ startTime: import("./generated/graphql").Scalars["BigInt"];
631
+ stealth?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Boolean"]>;
632
+ taker?: import("./generated/graphql").InputMaybe<import("./generated/graphql").Scalars["Address"]>;
633
+ __typename?: "CollectionOrder";
634
+ id: string;
635
+ status: string;
636
+ marketPlaceAddress: Address;
488
637
  }>;
489
638
  makeOrders(orders: SingleNftOrderInput[]): Promise<{
490
639
  __typename?: "SingleNFTOrder";
@@ -3745,6 +3894,45 @@ export declare class Gondi {
3745
3894
  txHash: `0x${string}`;
3746
3895
  waitMined: () => Promise<TransactionReceipt>;
3747
3896
  }>;
3897
+ /**
3898
+ * Where the wallet's CryptoPunk `tokenId` stands on its way into CryptoPunks 721, read from
3899
+ * chain: `'wallet'` while the wallet holds it naked, `'stash'` once it sits in the wallet's
3900
+ * Stash waiting for {@link wrapPunk721}, `'wrapped'` once the wallet holds its 721 token, and
3901
+ * `'other'` when none of these holds.
3902
+ *
3903
+ * IMPLEMENTATION NOTE: the punks market's `punkIndexToAddress` names the punk's holder and
3904
+ * `CryptoPunks721.punkProxyForUser` the wallet's Stash, deployed or not yet; a wrapped punk is
3905
+ * held by the 721 contract, which mints its token to the wallet
3906
+ * (https://721.cryptopunks.app, https://etherscan.io/address/0x000000000000003607fce1ac9e043a86675c5c2f#code).
3907
+ */
3908
+ punk721WrapState({ tokenId }: {
3909
+ tokenId: bigint;
3910
+ }): Promise<Punk721WrapState>;
3911
+ /**
3912
+ * Moves the wallet's naked CryptoPunk `tokenId` into its Stash, the first of the two
3913
+ * transactions that wrap it into CryptoPunks 721. Refuses a punk the wallet does not hold.
3914
+ */
3915
+ transferPunkToStash721({ tokenId }: {
3916
+ tokenId: bigint;
3917
+ }): Promise<{
3918
+ txHash: `0x${string}`;
3919
+ waitTxInBlock: () => Promise<TransactionReceipt>;
3920
+ }>;
3921
+ /**
3922
+ * Wraps the CryptoPunk `tokenId` waiting in the wallet's Stash into CryptoPunks 721, minting
3923
+ * its 721 token to the wallet. Refuses a punk that is not in the Stash: move it there first
3924
+ * with {@link transferPunkToStash721}.
3925
+ */
3926
+ wrapPunk721({ tokenId }: {
3927
+ tokenId: bigint;
3928
+ }): Promise<{
3929
+ txHash: `0x${string}`;
3930
+ waitTxInBlock: () => Promise<TransactionReceipt>;
3931
+ }>;
3932
+ /** The punk's wrap state with the addresses the wrap transactions need. */
3933
+ private _punk721Holding;
3934
+ /** A sent transaction whose `waitTxInBlock` resolves with its receipt once it succeeds. */
3935
+ private _minedTransaction;
3748
3936
  buyWithSellAndRepay({ repaymentCalldata, purchaseBundlerAddress, mslContractAddress, price, swapData, }: {
3749
3937
  repaymentCalldata: Hex;
3750
3938
  purchaseBundlerAddress?: Address;
@@ -3873,6 +4061,8 @@ export type BurnAndWithdrawArgs = {
3873
4061
  erc1155Collections?: Address[];
3874
4062
  erc1155TokenIds?: bigint[];
3875
4063
  };
4064
+ /** Where a CryptoPunk stands on its way into CryptoPunks 721; see `Gondi.punk721WrapState`. */
4065
+ export type Punk721WrapState = 'wallet' | 'stash' | 'wrapped' | 'other';
3876
4066
  type wrapOldERC721Args = {
3877
4067
  collection: {
3878
4068
  contractData: {
@@ -1,7 +1,7 @@
1
1
  export { FlaggedNftError } from './errors';
2
2
  export { Gondi } from './gondi';
3
3
  export { LoanStatusType, OfferStatus, OffersSortField, Ordering, MarketplaceEnum, TokenStandardType, } from './generated/graphql';
4
- export type { OnStepChange } from './gondi';
4
+ export type { OnStepChange, Punk721WrapState } from './gondi';
5
5
  export type { CreditPurchaseInput, CreditPurchaseQuote } from './utils/creditPurchase';
6
6
  export type { CrossCurrencyRenegotiationInput, CrossCurrencyRenegotiationQuote, } from './clients/contracts/CrossCurrencyRenegotiation';
7
7
  export type * as Types from './model';
@@ -25,6 +25,22 @@ export type CreditPurchaseQuote = Readonly<{
25
25
  loanSwapData: Hex;
26
26
  callbackData: Hex;
27
27
  }>;
28
+ /** Decodes the purchase bundler's `executionInfo` callback carried by an execution or a seller repayment. */
29
+ export declare const decodePurchaseCallback: (data: Hex) => {
30
+ reservoirExecutionInfo: {
31
+ module: `0x${string}`;
32
+ data: `0x${string}`;
33
+ value: bigint;
34
+ };
35
+ contractMustBeOwner: boolean;
36
+ purchaseCurrency: `0x${string}`;
37
+ amount: bigint;
38
+ swapData: `0x${string}`;
39
+ swapValue: bigint;
40
+ maxSlippage: bigint;
41
+ };
42
+ /** The callback's purchase currency, with every native spelling (including the ETH sentinel) as `zeroAddress`. */
43
+ export declare const callbackPurchaseCurrency: (callback: ReturnType<typeof decodePurchaseCallback>) => Address;
28
44
  /** Compares every ABI field against the confirmed terms before signing or submitting an API execution. */
29
45
  export declare const assertCreditPurchaseExecution: (expected: ExecutionDataV7, received: unknown) => void;
30
46
  /** Rechecks activation, zero additional taxes and router funding before buyer signing. */
@@ -25,6 +25,10 @@ export declare const RENEGOTIATION: {
25
25
  duration: bigint;
26
26
  expirationTime: bigint;
27
27
  };
28
+ /**
29
+ * Builds a `Gondi` without running its constructor, holding only `fields`.
30
+ */
31
+ export declare const stubGondi: (fields: object) => import("../../src").Gondi & object;
28
32
  /**
29
33
  * Builds a `Gondi` without running its constructor: empty pending-publication
30
34
  * maps, a zero-address account and wallet, plus the test's own `contracts` and
@@ -33,4 +37,25 @@ export declare const RENEGOTIATION: {
33
37
  export declare const gondiWith: (overrides: {
34
38
  contracts: object;
35
39
  apiClient: object;
36
- }) => any;
40
+ }) => import("../../src").Gondi & object;
41
+ /**
42
+ * The `nftFlaggedByContractAddressAndTokenId` response for an NFT that is not
43
+ * flagged and wraps nothing.
44
+ */
45
+ export declare const notFlaggedNft: () => Promise<{
46
+ nft: unknown;
47
+ }>;
48
+ /**
49
+ * Builds the stubs for a test of the flagged-NFT check that runs before a
50
+ * loan is emitted: an `nftFlaggedByContractAddressAndTokenId` mock answering
51
+ * `notFlaggedNft`, and a `createGondi` factory wiring it next to `contracts`,
52
+ * with the check on unless `skipFlaggedNftCheck` is passed.
53
+ */
54
+ export declare const flaggedNftCheckStub: (contracts: object) => {
55
+ nftFlaggedByContractAddressAndTokenId: import("bun:test").Mock<() => Promise<{
56
+ nft: unknown;
57
+ }>>;
58
+ createGondi: ({ skipFlaggedNftCheck }?: {
59
+ skipFlaggedNftCheck?: boolean | undefined;
60
+ }) => import("../../src").Gondi & object;
61
+ };