Class AuctionHousePdasClient

This client allows you to build PDAs related to the Auction House module.

See

AuctionHouseClient

Hierarchy

AuctionHousePdasClient

Index

Constructors

constructor

new AuctionHousePdasClient(metaplex: Metaplex): AuctionHousePdasClient
Parameters
- metaplex: Metaplex
Returns AuctionHousePdasClient
- Defined in packages/js/src/plugins/auctionHouseModule/AuctionHousePdasClient.ts:13

Properties

`Protected` `Readonly` metaplex

metaplex: Metaplex

Methods

auctionHouse

auctionHouse(input: {
    creator: PublicKey;
    treasuryMint: PublicKey;
    programs?: Program[];
}): Pda
Finds the Auction House PDA for a creator and treasury tuple.
Parameters
- input: {
      creator: PublicKey;
      treasuryMint: PublicKey;
      programs?: Program[];
  }
  - creator: PublicKey
    
    The address of the Auction House's creator.
  - treasuryMint: PublicKey
    
    The mint address of the Auction House's treasury.
  - Optional programs?: Program[]
    
    An optional set of programs that override the registered ones.
Returns Pda
- Defined in packages/js/src/plugins/auctionHouseModule/AuctionHousePdasClient.ts:16

auctioneer

auctioneer(input: {
    auctionHouse: PublicKey;
    auctioneerAuthority: PublicKey;
    programs?: Program[];
}): Pda
Finds the Auctioneer PDA of an Auction House.
Parameters
- input: {
      auctionHouse: PublicKey;
      auctioneerAuthority: PublicKey;
      programs?: Program[];
  }
  - auctionHouse: PublicKey
    
    The Auction House address.
  - auctioneerAuthority: PublicKey
    
    The address of the Auctioneer authority.
  - Optional programs?: Program[]
    
    An optional set of programs that override the registered ones.
Returns Pda
- Defined in packages/js/src/plugins/auctionHouseModule/AuctionHousePdasClient.ts:33

programAsSigner

programAsSigner(input?: {
programs?: Program[];
}): Pda
Finds the PDA of the Auction House Program itself used to sign transaction.
Parameters
- Optional input: {
  programs?: Program[];
  }
  - Optional programs?: Program[]
    
    An optional set of programs that override the registered ones.
Returns Pda
- Defined in packages/js/src/plugins/auctionHouseModule/AuctionHousePdasClient.ts:53

fee

fee(input: {
auctionHouse: PublicKey;
programs?: Program[];
}): Pda
Finds the PDA of an Auction House's fee account.
Parameters
- input: {
  auctionHouse: PublicKey;
  programs?: Program[];
  }
  - auctionHouse: PublicKey
    
    The Auction House address.
  - Optional programs?: Program[]
    
    An optional set of programs that override the registered ones.
Returns Pda
- Defined in packages/js/src/plugins/auctionHouseModule/AuctionHousePdasClient.ts:65

treasury

treasury(input: {
auctionHouse: PublicKey;
programs?: Program[];
}): Pda
Finds the PDA of an Auction House's treasury account.
Parameters
- input: {
  auctionHouse: PublicKey;
  programs?: Program[];
  }
  - auctionHouse: PublicKey
    
    The Auction House address.
  - Optional programs?: Program[]
    
    An optional set of programs that override the registered ones.
Returns Pda
- Defined in packages/js/src/plugins/auctionHouseModule/AuctionHousePdasClient.ts:80

buyerEscrow

buyerEscrow(input: {
    auctionHouse: PublicKey;
    buyer: PublicKey;
    programs?: Program[];
}): Pda
Finds the PDA of a buyer's escrow account.
Parameters
- input: {
      auctionHouse: PublicKey;
      buyer: PublicKey;
      programs?: Program[];
  }
  - auctionHouse: PublicKey
    
    The Auction House address.
  - buyer: PublicKey
    
    The address of the buyer.
  - Optional programs?: Program[]
    
    An optional set of programs that override the registered ones.
Returns Pda
- Defined in packages/js/src/plugins/auctionHouseModule/AuctionHousePdasClient.ts:95

tradeState

tradeState(input: {
    auctionHouse: PublicKey;
    wallet: PublicKey;
    treasuryMint: PublicKey;
    tokenMint: PublicKey;
    price: BigNumber;
    tokenSize: BigNumber;
    tokenAccount?: Option<PublicKey>;
    programs?: Program[];
}): Pda
Finds the trade state PDA of a bid or listing.
Parameters
- input: {
      auctionHouse: PublicKey;
      wallet: PublicKey;
      treasuryMint: PublicKey;
      tokenMint: PublicKey;
      price: BigNumber;
      tokenSize: BigNumber;
      tokenAccount?: Option<PublicKey>;
      programs?: Program[];
  }
  - auctionHouse: PublicKey
    
    The Auction House address.
  - wallet: PublicKey
    
    The address of the buyer or seller.
  - treasuryMint: PublicKey
    
    The mint address of the Auction House's treasury at the time of trade.
  - tokenMint: PublicKey
    
    The mint address of the token to trade.
  - price: BigNumber
    
    The price of the trade in basis points.
  - tokenSize: BigNumber
    
    The number of tokens to trade in basis points.
  - Optional tokenAccount?: Option<PublicKey>
    
    The token account from which to trade, unless it is a public bid.
  - Optional programs?: Program[]
    
    An optional set of programs that override the registered ones.
Returns Pda
- Defined in packages/js/src/plugins/auctionHouseModule/AuctionHousePdasClient.ts:112

listingReceipt

listingReceipt(input: {
tradeState: PublicKey;
programs?: Program[];
}): Pda
Finds the receipt PDA of a Listing trade state.
Parameters
- input: {
  tradeState: PublicKey;
  programs?: Program[];
  }
  - tradeState: PublicKey
    
    The trade state PDA of the Listing.
  - Optional programs?: Program[]
    
    An optional set of programs that override the registered ones.
Returns Pda
- Defined in packages/js/src/plugins/auctionHouseModule/AuctionHousePdasClient.ts:144

bidReceipt

bidReceipt(input: {
tradeState: PublicKey;
programs?: Program[];
}): Pda
Finds the receipt PDA of a Bid trade state.
Parameters
- input: {
  tradeState: PublicKey;
  programs?: Program[];
  }
  - tradeState: PublicKey
    
    The trade state PDA of the Bid.
  - Optional programs?: Program[]
    
    An optional set of programs that override the registered ones.
Returns Pda
- Defined in packages/js/src/plugins/auctionHouseModule/AuctionHousePdasClient.ts:158

purchaseReceipt

purchaseReceipt(input: {
    listingTradeState: PublicKey;
    bidTradeState: PublicKey;
    programs?: Program[];
}): Pda
Finds the receipt PDA of a Purchase.
Parameters
- input: {
      listingTradeState: PublicKey;
      bidTradeState: PublicKey;
      programs?: Program[];
  }
  - listingTradeState: PublicKey
    
    The trade state PDA of the Listing.
  - bidTradeState: PublicKey
    
    The trade state PDA of the Bid.
  - Optional programs?: Program[]
    
    An optional set of programs that override the registered ones.
Returns Pda
- Defined in packages/js/src/plugins/auctionHouseModule/AuctionHousePdasClient.ts:172

`Private` programId

programId(programs?: Program[]): PublicKey
Parameters
- Optional programs: Program[]
Returns PublicKey
- Defined in packages/js/src/plugins/auctionHouseModule/AuctionHousePdasClient.ts:188

Class AuctionHousePdasClient

See

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

metaplex: Metaplex

Returns AuctionHousePdasClient

Properties

Protected Readonly metaplex

Methods

auctionHouse

Parameters

input: { creator: PublicKey; treasuryMint: PublicKey; programs?: Program[]; }

creator: PublicKey

treasuryMint: PublicKey

Optional programs?: Program[]

Returns Pda

auctioneer

Parameters

input: { auctionHouse: PublicKey; auctioneerAuthority: PublicKey; programs?: Program[]; }

auctionHouse: PublicKey

auctioneerAuthority: PublicKey

Optional programs?: Program[]

Returns Pda

programAsSigner

Parameters

Optional input: { programs?: Program[]; }

Optional programs?: Program[]

Returns Pda

fee

Parameters

input: { auctionHouse: PublicKey; programs?: Program[]; }

auctionHouse: PublicKey

Optional programs?: Program[]

Returns Pda

treasury

Parameters

input: { auctionHouse: PublicKey; programs?: Program[]; }

auctionHouse: PublicKey

Optional programs?: Program[]

Returns Pda

buyerEscrow

Parameters

input: { auctionHouse: PublicKey; buyer: PublicKey; programs?: Program[]; }

auctionHouse: PublicKey

buyer: PublicKey

Optional programs?: Program[]

Returns Pda

tradeState

Parameters

input: { auctionHouse: PublicKey; wallet: PublicKey; treasuryMint: PublicKey; tokenMint: PublicKey; price: BigNumber; tokenSize: BigNumber; tokenAccount?: Option<PublicKey>; programs?: Program[]; }

auctionHouse: PublicKey

wallet: PublicKey

treasuryMint: PublicKey

tokenMint: PublicKey

price: BigNumber

tokenSize: BigNumber

Optional tokenAccount?: Option<PublicKey>

Optional programs?: Program[]

Returns Pda

listingReceipt

Parameters

input: { tradeState: PublicKey; programs?: Program[]; }

tradeState: PublicKey

Optional programs?: Program[]

Returns Pda

bidReceipt

Parameters

input: { tradeState: PublicKey; programs?: Program[]; }

tradeState: PublicKey

Optional programs?: Program[]

Returns Pda

purchaseReceipt

Parameters

input: { listingTradeState: PublicKey; bidTradeState: PublicKey; programs?: Program[]; }

`Protected` `Readonly` metaplex

input: {
creator: PublicKey;
treasuryMint: PublicKey;
programs?: Program[];
}

`Optional` programs?: Program[]

input: {
auctionHouse: PublicKey;
auctioneerAuthority: PublicKey;
programs?: Program[];
}

`Optional` programs?: Program[]

`Optional` input: {
programs?: Program[];
}

`Optional` programs?: Program[]

input: {
auctionHouse: PublicKey;
programs?: Program[];
}

`Optional` programs?: Program[]

input: {
auctionHouse: PublicKey;
programs?: Program[];
}

`Optional` programs?: Program[]

input: {
auctionHouse: PublicKey;
buyer: PublicKey;
programs?: Program[];
}

`Optional` programs?: Program[]

input: {
auctionHouse: PublicKey;
wallet: PublicKey;
treasuryMint: PublicKey;
tokenMint: PublicKey;
price: BigNumber;
tokenSize: BigNumber;
tokenAccount?: Option<PublicKey>;
programs?: Program[];
}

`Optional` tokenAccount?: Option<PublicKey>

`Optional` programs?: Program[]

input: {
tradeState: PublicKey;
programs?: Program[];
}

`Optional` programs?: Program[]

input: {
tradeState: PublicKey;
programs?: Program[];
}

`Optional` programs?: Program[]

input: {
listingTradeState: PublicKey;
bidTradeState: PublicKey;
programs?: Program[];
}

`Optional` programs?: Program[]

`Private` programId

`Optional` programs: Program[]