Search
Preparing search index...
The search index is not available
mirage-js-sdk
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
mirage-js-sdk
core/src
Marketplace
Class Marketplace
Hierarchy
Marketplace
Index
Constructors
constructor
Properties
connection
program
wallet
Methods
create
Buy
Transaction
create
Cancel
Listing
Transaction
create
Create
Marketplace
Transaction
create
List
Transaction
create
Transfer
Transaction
create
Update
Listing
Transaction
create
Update
Marketplace
Transaction
fetch
Auction
House
get
Auction
House
Address
get
Marketplace
Fee
Balance
get
Store
Front
Configuration
load
Auction
House
Program
setup
withdraw
Marketplace
Fees
Constructors
constructor
new
Marketplace
(
__namedParameters
:
IAuctionOptions
)
:
Marketplace
Parameters
__namedParameters:
IAuctionOptions
Returns
Marketplace
Properties
connection
connection
:
Connection
Optional
program
program
?:
Program
<
AuctionHouseIDL
>
wallet
wallet
:
Wallet
Methods
create
Buy
Transaction
create
Buy
Transaction
(
userWallet
:
PublicKey
, mint
:
PublicKey
, listingPrice
:
number
, seller
:
PublicKey
, auctionHouseAddress
:
PublicKey
)
:
Promise
<
readonly
[
Transaction
,
PublicKey
,
Keypair
[]
]
>
Parameters
userWallet:
PublicKey
mint:
PublicKey
listingPrice:
number
seller:
PublicKey
auctionHouseAddress:
PublicKey
Returns
Promise
<
readonly
[
Transaction
,
PublicKey
,
Keypair
[]
]
>
create
Cancel
Listing
Transaction
create
Cancel
Listing
Transaction
(
userWallet
:
PublicKey
, mint
:
PublicKey
, currentListingPrice
:
number
, auctionHouseAddress
:
PublicKey
)
:
Promise
<
readonly
[
Transaction
,
PublicKey
]
>
Parameters
userWallet:
PublicKey
mint:
PublicKey
currentListingPrice:
number
auctionHouseAddress:
PublicKey
Returns
Promise
<
readonly
[
Transaction
,
PublicKey
]
>
create
Create
Marketplace
Transaction
create
Create
Marketplace
Transaction
(
auctionHouseAuthority
:
PublicKey
, sellerFeeBasisPoints
:
number
, treasuryMint
?:
PublicKey
, feeWithdrawalDestination
?:
PublicKey
, treasuryWithdrawalDestination
?:
PublicKey
, requiresSignOff
?:
boolean
, canChangeSalePrice
?:
boolean
, feePayer
?:
PublicKey
, storeFrontUrl
?:
string
)
:
Promise
<
Transaction
>
Parameters
auctionHouseAuthority:
PublicKey
sellerFeeBasisPoints:
number
Optional
treasuryMint:
PublicKey
Optional
feeWithdrawalDestination:
PublicKey
Optional
treasuryWithdrawalDestination:
PublicKey
Optional
requiresSignOff:
boolean
Optional
canChangeSalePrice:
boolean
Optional
feePayer:
PublicKey
Optional
storeFrontUrl:
string
Returns
Promise
<
Transaction
>
create
List
Transaction
create
List
Transaction
(
userWallet
:
PublicKey
, mint
:
PublicKey
, listingPrice
:
number
, auctionHouseAddress
:
PublicKey
)
:
Promise
<
readonly
[
Transaction
,
PublicKey
]
>
Parameters
userWallet:
PublicKey
mint:
PublicKey
listingPrice:
number
auctionHouseAddress:
PublicKey
Returns
Promise
<
readonly
[
Transaction
,
PublicKey
]
>
create
Transfer
Transaction
create
Transfer
Transaction
(
userWallet
:
PublicKey
, mint
:
PublicKey
, recipient
:
PublicKey
)
:
Promise
<
Transaction
>
Parameters
userWallet:
PublicKey
mint:
PublicKey
recipient:
PublicKey
Returns
Promise
<
Transaction
>
create
Update
Listing
Transaction
create
Update
Listing
Transaction
(
userWallet
:
PublicKey
, mint
:
PublicKey
, currentListingPrice
:
number
, newListingPrice
:
number
, auctionHouseAddress
:
PublicKey
)
:
Promise
<
readonly
[
Transaction
,
PublicKey
]
>
Parameters
userWallet:
PublicKey
mint:
PublicKey
currentListingPrice:
number
newListingPrice:
number
auctionHouseAddress:
PublicKey
Returns
Promise
<
readonly
[
Transaction
,
PublicKey
]
>
create
Update
Marketplace
Transaction
create
Update
Marketplace
Transaction
(
authority
:
PublicKey
, sellerFeeBasisPoints
:
number
, newAuthority
?:
PublicKey
, treasuryMint
?:
PublicKey
, feeWithdrawalDestination
?:
PublicKey
, treasuryWithdrawalDestination
?:
PublicKey
, requiresSignOff
?:
boolean
, canChangeSalePrice
?:
boolean
, storeFrontUrl
?:
string
, feePayer
?:
PublicKey
)
:
Promise
<
Transaction
>
Parameters
authority:
PublicKey
sellerFeeBasisPoints:
number
Optional
newAuthority:
PublicKey
Optional
treasuryMint:
PublicKey
Optional
feeWithdrawalDestination:
PublicKey
Optional
treasuryWithdrawalDestination:
PublicKey
Optional
requiresSignOff:
boolean
Optional
canChangeSalePrice:
boolean
Optional
storeFrontUrl:
string
Optional
feePayer:
PublicKey
Returns
Promise
<
Transaction
>
fetch
Auction
House
fetch
Auction
House
(
auctionHouse
:
PublicKey
)
:
Promise
<
{
auctionHouseFeeAccount
:
PublicKey
;
auctionHouseTreasury
:
PublicKey
;
authority
:
PublicKey
;
bump
:
number
;
canChangeSalePrice
:
boolean
;
creator
:
PublicKey
;
feeAmount
:
number
;
feePayerBump
:
number
;
feeWithdrawalDestination
:
PublicKey
;
requiresSignOff
:
boolean
;
sellerFeeBasisPoints
:
number
;
treasuryAmount
:
number
;
treasuryBump
:
number
;
treasuryMint
:
PublicKey
;
treasuryWithdrawalDestination
:
PublicKey
}
>
Parameters
auctionHouse:
PublicKey
Returns
Promise
<
{
auctionHouseFeeAccount
:
PublicKey
;
auctionHouseTreasury
:
PublicKey
;
authority
:
PublicKey
;
bump
:
number
;
canChangeSalePrice
:
boolean
;
creator
:
PublicKey
;
feeAmount
:
number
;
feePayerBump
:
number
;
feeWithdrawalDestination
:
PublicKey
;
requiresSignOff
:
boolean
;
sellerFeeBasisPoints
:
number
;
treasuryAmount
:
number
;
treasuryBump
:
number
;
treasuryMint
:
PublicKey
;
treasuryWithdrawalDestination
:
PublicKey
}
>
get
Auction
House
Address
get
Auction
House
Address
(
authority
:
PublicKey
, treasuryMint
?:
PublicKey
)
:
Promise
<
[
PublicKey
,
number
]
>
Parameters
authority:
PublicKey
Optional
treasuryMint:
PublicKey
Returns
Promise
<
[
PublicKey
,
number
]
>
get
Marketplace
Fee
Balance
get
Marketplace
Fee
Balance
(
auctionHouseAddress
:
PublicKey
)
:
Promise
<
number
>
Parameters
auctionHouseAddress:
PublicKey
Returns
Promise
<
number
>
get
Store
Front
Configuration
get
Store
Front
Configuration
(
auctionHouseAuthority
:
PublicKey
, storeFrontOptions
:
StoreFrontOptions
, treasuryMints
:
(
undefined
|
PublicKey
)
[]
)
:
Promise
<
MarktplaceSettingsPayload
>
Parameters
auctionHouseAuthority:
PublicKey
storeFrontOptions:
StoreFrontOptions
treasuryMints:
(
undefined
|
PublicKey
)
[]
Returns
Promise
<
MarktplaceSettingsPayload
>
load
Auction
House
Program
load
Auction
House
Program
(
)
:
Promise
<
Program
<
AuctionHouseIDL
>
>
Loads Auction House program
Returns
Promise
<
Program
<
AuctionHouseIDL
>
>
setup
setup
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
withdraw
Marketplace
Fees
withdraw
Marketplace
Fees
(
amount
:
number
, auctionHouseAddress
:
PublicKey
, royaltyBasePoints
:
number
, royaltyReceiver
:
PublicKey
)
:
Promise
<
Transaction
>
Parameters
amount:
number
auctionHouseAddress:
PublicKey
royaltyBasePoints:
number
royaltyReceiver:
PublicKey
Returns
Promise
<
Transaction
>
Modules
core/src
transactions
utils/src
Marketplace
constructor
connection
program
wallet
create
Buy
Transaction
create
Cancel
Listing
Transaction
create
Create
Marketplace
Transaction
create
List
Transaction
create
Transfer
Transaction
create
Update
Listing
Transaction
create
Update
Marketplace
Transaction
fetch
Auction
House
get
Auction
House
Address
get
Marketplace
Fee
Balance
get
Store
Front
Configuration
load
Auction
House
Program
setup
withdraw
Marketplace
Fees
Generated using
TypeDoc
Loads Auction House program