Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Refactor auction house operations #451

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ import {
DirectSellBuilderParams,
withdrawFromBuyerAccountBuilder,
WithdrawFromBuyerAccountBuilderParams,
withdrawFromFeeAccountBuilder,
WithdrawFromFeeAccountBuilderParams,
} from './operations';
import {
createAuctionHouseBuilder,
Expand Down Expand Up @@ -120,4 +122,12 @@ export class AuctionHouseBuildersClient {
) {
return withdrawFromBuyerAccountBuilder(this.metaplex, input, options);
}

/** {@inheritDoc withdrawFromFeeAccountBuilder} */
withdrawFromFeeAccount(
input: WithdrawFromFeeAccountBuilderParams,
options?: TransactionBuilderOptions
) {
return withdrawFromFeeAccountBuilder(this.metaplex, input, options);
}
}
12 changes: 12 additions & 0 deletions packages/js/src/plugins/auctionHouseModule/AuctionHouseClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ import {
findAuctionHouseByAddressOperation,
FindAuctionHouseByCreatorAndMintInput,
findAuctionHouseByCreatorAndMintOperation,
FindAuctionHousesByAddressListInput,
findAuctionHousesByAddressListOperation,
FindBidByReceiptInput,
findBidByReceiptOperation,
FindBidByTradeStateInput,
Expand Down Expand Up @@ -188,6 +190,16 @@ export class AuctionHouseClient {
.execute(findAuctionHouseByCreatorAndMintOperation(input), options);
}

/** {@inheritDoc findAuctionHousesByAddressListOperation} */
findByAddressList(
input: FindAuctionHousesByAddressListInput,
options?: OperationOptions
) {
return this.metaplex
.operations()
.execute(findAuctionHousesByAddressListOperation(input), options);
}

/** {@inheritDoc findBidByReceiptOperation} */
findBidByReceipt(input: FindBidByReceiptInput, options?: OperationOptions) {
return this.metaplex
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import type { PublicKey } from '@solana/web3.js';
import { toAuctioneerAccount, toAuctionHouseAccount } from '../accounts';
import { AuctioneerAuthorityRequiredError } from '../errors';
import { AuctionHouse, toAuctionHouse } from '../models/AuctionHouse';
import {
Operation,
Expand Down Expand Up @@ -51,7 +50,7 @@ export type FindAuctionHouseByAddressInput = {

/**
* The Auctioneer authority key.
* It is required when Auction House has Auctioneer enabled.
* It is automatically loaded when not specified and Auction House has Auctioneer enabled.
*
* @defaultValue No default value.
*/
Expand Down Expand Up @@ -101,7 +100,9 @@ export const findAuctionHouseByAddressOperationHandler: OperationHandler<FindAuc
}

if (!accounts[1] || !accounts[1].exists) {
throw new AuctioneerAuthorityRequiredError();
accounts[1] = await metaplex
.rpc()
.getAccount(auctionHouseAccount.data.auctioneerAddress);
}

const auctioneerAccount = toAuctioneerAccount(accounts[1]);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
import { PublicKey } from '@solana/web3.js';
import { toAuctioneerAccount, toAuctionHouseAccount } from '../accounts';
import { AuctionHouse, toAuctionHouse } from '../models';
import { toMint, toMintAccount } from '../../tokenModule';
import { chunk } from '../../../utils/common';
import {
Operation,
OperationHandler,
OperationScope,
UnparsedMaybeAccount,
useOperation,
} from '@/types';
import { Metaplex } from '@/Metaplex';

// -----------------
// Operation
// -----------------

const Key = 'FindAuctionHousesByAddressListOperation' as const;

/**
* Finds multiple Auction Houses by their address.
*
* ```ts
* const nft = await metaplex
* .auctionHouse()
* .findByAddressList({ addresses };
* ```
*
* @group Operations
* @category Constructors
*/
export const findAuctionHousesByAddressListOperation =
useOperation<FindAuctionHousesByAddressListOperation>(Key);

/**
* @group Operations
* @category Types
*/
export type FindAuctionHousesByAddressListOperation = Operation<
typeof Key,
FindAuctionHousesByAddressListInput,
FindAuctionHousesByAddressListOutput
>;

/**
* @group Operations
* @category Inputs
*/
export type FindAuctionHousesByAddressListInput = {
/** The addresses of the Auction Houses. */
addresses: PublicKey[];
};

/**
* @group Operations
* @category Outputs
*/
export type FindAuctionHousesByAddressListOutput = AuctionHouse[];

const fetchUniqueAccountMap: <T = UnparsedMaybeAccount>(
metaplex: Metaplex,
accounts: PublicKey[],
mapper: (account: UnparsedMaybeAccount) => T,
accountMap?: Map<PublicKey, T>
) => Promise<Map<PublicKey, T>> = async (
metaplex,
accounts,
mapper, // = (account) => account,
accountMap = new Map()
) => {
const uniqueAccounts: Set<PublicKey> = new Set(
accounts.filter((key): key is PublicKey => key !== null)
);

const accountInfos = await Promise.all(
chunk(Array.from(uniqueAccounts), 100).map((chunk) =>
metaplex.rpc().getMultipleAccounts(chunk)
)
).then((infos) => infos.flat());

for (const account of accountInfos) {
accountMap.set(account.publicKey, mapper(account));
}

return accountMap;
};

/**
* @group Operations
* @category Handlers
*/
export const findAuctionHousesByAddressListOperationHandler: OperationHandler<FindAuctionHousesByAddressListOperation> =
{
handle: async (
operation: FindAuctionHousesByAddressListOperation,
metaplex: Metaplex,
scope: OperationScope
): Promise<FindAuctionHousesByAddressListOutput> => {
const { commitment } = scope;
const { addresses } = operation.input;

const auctionHouseUnparsedAccounts = await Promise.all(
chunk(addresses, 100).map((c) =>
metaplex.rpc().getMultipleAccounts(c, commitment)
)
);
scope.throwIfCanceled();

const auctionHouseAccounts = auctionHouseUnparsedAccounts
.flat()
.map((account) => toAuctionHouseAccount(account));

const mintAddresses = auctionHouseAccounts.map(
(auctionHouseAccount) => auctionHouseAccount.data.treasuryMint
);
const auctioneerAddresses = auctionHouseAccounts
.map(({ data: { hasAuctioneer, auctioneerAddress } }) =>
hasAuctioneer ? auctioneerAddress : null
)
.filter((key): key is PublicKey => key !== null);

const mintAndAuctioneerAccounts = await fetchUniqueAccountMap(
metaplex,
mintAddresses.concat(auctioneerAddresses),
(a) => a
);
scope.throwIfCanceled();

return auctionHouseAccounts.map((auctionHouseAccount) => {
const mintModel = toMint(
toMintAccount(
mintAndAuctioneerAccounts.get(
auctionHouseAccount.data.treasuryMint
)!
)
);

if (!auctionHouseAccount.data.hasAuctioneer)
return toAuctionHouse(auctionHouseAccount, mintModel);

return toAuctionHouse(
auctionHouseAccount,
mintModel,
toAuctioneerAccount(
mintAndAuctioneerAccounts.get(
auctionHouseAccount.data.auctioneerAddress
)!
)
);
});
},
};
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ export type FindListingsOperation = Operation<
*/
export type FindListingsInput = {
/** A model of the Auction House related to these listings. */
auctionHouse: AuctionHouse;
auctionHouse?: AuctionHouse;

/** The address of a seller to search by. */
seller?: PublicKey;
Expand Down Expand Up @@ -92,9 +92,11 @@ export const findListingsOperationHandler: OperationHandler<FindListingsOperatio
let listingQuery = new ListingReceiptGpaBuilder(
metaplex,
auctionHouseProgram.address
)
.mergeConfig({ commitment })
.whereAuctionHouse(auctionHouse.address);
).mergeConfig({ commitment });

if (auctionHouse) {
listingQuery = listingQuery.whereAuctionHouse(auctionHouse.address);
}

if (seller) {
listingQuery = listingQuery.whereSeller(seller);
Expand All @@ -112,8 +114,40 @@ export const findListingsOperationHandler: OperationHandler<FindListingsOperatio

scope.throwIfCanceled();

return listingQuery.getAndMap((account) =>
toLazyListing(toListingReceiptAccount(account), auctionHouse)
const listingReceiptAccounts = await listingQuery.getAndMap((account) =>
toListingReceiptAccount(account)
);

// return early if auctionHouse is specified
if (auctionHouse) {
return listingReceiptAccounts.map((listing) =>
toLazyListing(listing, auctionHouse)
);
}

const uniqueAuctionHouseAddresses = Array.from(
new Set(
listingReceiptAccounts.map(
(auctionHouseAccount) => auctionHouseAccount.data.auctionHouse
)
)
);

const auctionHouses = await metaplex
.auctionHouse()
.findByAddressList({ addresses: uniqueAuctionHouseAddresses });

scope.throwIfCanceled();

const auctionHouseMap: Map<PublicKey, AuctionHouse> = new Map(
auctionHouses.map((auctionHouse) => [
auctionHouse.address,
auctionHouse,
])
);

return listingReceiptAccounts.map((listing) =>
toLazyListing(listing, auctionHouseMap.get(listing.data.auctionHouse)!)
);
},
};
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ export * from './directSell';
export * from './executeSale';
export * from './findAuctionHouseByAddress';
export * from './findAuctionHouseByCreatorAndMint';
export * from './findAuctionHousesByAddressList';
export * from './findBidByReceipt';
export * from './findBidByTradeState';
export * from './findBids';
Expand Down
6 changes: 6 additions & 0 deletions packages/js/src/plugins/auctionHouseModule/plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ import {
findAuctionHouseByAddressOperationHandler,
findAuctionHouseByCreatorAndMintOperation,
findAuctionHouseByCreatorAndMintOperationHandler,
findAuctionHousesByAddressListOperation,
findAuctionHousesByAddressListOperationHandler,
findBidByReceiptOperation,
findBidByReceiptOperationHandler,
findBidByTradeStateOperation,
Expand Down Expand Up @@ -104,6 +106,10 @@ export const auctionHouseModule = (): MetaplexPlugin => ({
findAuctionHouseByCreatorAndMintOperation,
findAuctionHouseByCreatorAndMintOperationHandler
);
op.register(
findAuctionHousesByAddressListOperation,
findAuctionHousesByAddressListOperationHandler
);
op.register(findBidByReceiptOperation, findBidByReceiptOperationHandler);
op.register(
findBidByTradeStateOperation,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,19 @@ test('[auctionHouseModule] create new Auctioneer Auction House', async (t: Test)
// And the Auctioneer PDA for that Auction House was created.
const ahAuctioneerAccount = await mx.rpc().getAccount(ahAuctioneerPda);
t.ok(ahAuctioneerAccount.exists);

// Try fetching auctioneer auction house with only auctionHouse key
const retrievedAuctionHouse = await mx
.auctionHouse()
.findByAddress({ address: auctionHouse.address });
spok(t, retrievedAuctionHouse, {
hasAuctioneer: true,
scopes: AUCTIONEER_ALL_SCOPES,
auctioneer: {
address: spokSamePubkey(ahAuctioneerPda),
authority: spokSamePubkey(auctioneerAuthority.publicKey),
},
});
});

test('[auctionHouseModule] create new Auctioneer Auction House with separate authority', async (t: Test) => {
Expand Down