core/src | mirage-js-sdk

Type Aliases

Attribute

Attribute: { display_type?: string; trait_type?: string; value: string | number }

Type declaration

Optional display_type?: string
Optional trait_type?: string
value: string | number

IAuctionOptions

IAuctionOptions: { connection: Connection; wallet: Wallet }

Type declaration

connection: Connection
wallet: Wallet

Receipt

Receipt: PublicKey

ReceiptAddress

ReceiptAddress: PublicKey

ReceiptType

TransactionSignature

TransactionSignature: string | undefined

Variables

Const AUCTION_HOUSE

AUCTION_HOUSE: "auction_house" = 'auction_house'

Const AUCTION_HOUSE_PROGRAM_ID

AUCTION_HOUSE_PROGRAM_ID: PublicKey = ...

Const MINT_CONFIG

MINT_CONFIG: { mintRoyalties: number; seller_fee_basis_points: number } = ...

Type declaration

mintRoyalties: number
seller_fee_basis_points: number

Const MIRAGE_AUCTION_HOUSE

MIRAGE_AUCTION_HOUSE: PublicKey = ...

Const MIRAGE_AUCTION_HOUSE_AUTHORITY

MIRAGE_AUCTION_HOUSE_AUTHORITY: PublicKey = ...

Const NFT_STORAGE_API_KEY

NFT_STORAGE_API_KEY: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJkaWQ6ZXRocjoweEZDQjI0MDFEMTRGODk3OUViNkEzNDdhMWQ3MEMxMjQzMWI1OUUwZkMiLCJpc3MiOiJuZnQtc3RvcmFnZSIsImlhdCI6MTY0OTA4OTIxMzMyNSwibmFtZSI6Ik1pcnJvcldvcmxkX0RldmVsb3BtZW50X0tleSJ9.COpqZqwBbDM1bBgYuIiaQxsGRQc0gphXGCBMsRhAHk8" = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJkaWQ6ZXRocjoweEZDQjI0MDFEMTRGODk3OUViNkEzNDdhMWQ3MEMxMjQzMWI1OUUwZkMiLCJpc3MiOiJuZnQtc3RvcmFnZSIsImlhdCI6MTY0OTA4OTIxMzMyNSwibmFtZSI6Ik1pcnJvcldvcmxkX0RldmVsb3BtZW50X0tleSJ9.COpqZqwBbDM1bBgYuIiaQxsGRQc0gphXGCBMsRhAHk8'

Const SIGNER

SIGNER: "signer" = 'signer'

Const SPL_ASSOCIATED_TOKEN_ACCOUNT_PROGRAM_ID

SPL_ASSOCIATED_TOKEN_ACCOUNT_PROGRAM_ID: PublicKey = ...

Const TOKEN_METADATA_PROGRAM_ID

TOKEN_METADATA_PROGRAM_ID: PublicKey = ...

Const WRAPPED_SOL_MINT

WRAPPED_SOL_MINT: PublicKey = ...

Functions

getAccountInfo

getAccountInfo(connection: Connection, address: PublicKey, commitment?: Commitment, programId?: PublicKey): Promise<{ address: PublicKey; amount: any; closeAuthority: any; delegate: any; delegatedAmount: any; isFrozen: boolean; isInitialized: boolean; isNative: boolean; mint: any; owner: any; rentExemptReserve: any }>

- Defined in packages/core/src/utils.ts:33
Parameters
- connection: Connection
- address: PublicKey
- Optional commitment: Commitment
- programId: PublicKey = TOKEN_PROGRAM_ID
Returns Promise<{ address: PublicKey; amount: any; closeAuthority: any; delegate: any; delegatedAmount: any; isFrozen: boolean; isInitialized: boolean; isNative: boolean; mint: any; owner: any; rentExemptReserve: any }>

getAtaForMint

getAtaForMint(mint: PublicKey, address: PublicKey): [PublicKey, number]

- Defined in packages/core/src/utils.ts:18
Get associated token for mint

Parameters
- mint: PublicKey
- address: PublicKey
Returns [PublicKey, number]

getMetadata

getMetadata(mint: PublicKey): PublicKey

- Defined in packages/core/src/utils.ts:13
Get metadatata account for mint

Parameters
- mint: PublicKey
Returns PublicKey

getNftOwner

getNftOwner(mint: string | PublicKey, connection: Connection): Promise<readonly [string, PublicKey, Buffer | ParsedAccountData]>

- Defined in packages/core/src/utils.ts:178
Parameters
- mint: string | PublicKey
- connection: Connection
Returns Promise<readonly [string, PublicKey, Buffer | ParsedAccountData]>

getTokenTransactions

getTokenTransactions(mint: string | PublicKey, auctionHouse: PublicKey, connection: Connection): Promise<(TransactionReceipt | undefined)[]>

- Defined in packages/core/src/utils.ts:193
Get Token Transactions

Parameters
- mint: string | PublicKey
- auctionHouse: PublicKey
- connection: Connection
Returns Promise<(TransactionReceipt | undefined)[]>

isPdaAddressInitialize

isPdaAddressInitialize(connection: Connection, pdaAddress: PublicKey): Promise<boolean>

- Defined in packages/core/src/utils.ts:22
Parameters
- connection: Connection
- pdaAddress: PublicKey
Returns Promise<boolean>

processCreatorShares

processCreatorShares(creators: { address: string; share: number }[], authorityAddress: PublicKey, authorityRoyaltyPercentage?: number): { address: string; share: number }[]

Processes creator shares and adds the auctionhouse as one of the authorities on the mint. It then provides the authorityAddress and gives it a royalty percentage equal to the authorityRoyaltyPercentage of the cumulative total shares of all the creators.

e.g.

example

 const auctionHouseAuthority = new PublicKey("3MtckfRX4VRJ1yUmPHpKZstAQ8S3WfhRnNJLT8LqTZEr")
const authorityRoyaltyPercentage = 5

processCreatorShares([
{
address: "Betkx8CfRUwQAqZZRqKt13zo4t9awNFeriD2bMAq2xfJ",
share: 43
},
{
address: "Dn4D8vVvpKzCALq1X5jasPrwvs5kXnSJtfbji4iZaq6R",
share: 1232
}
], auctionHouseAuthority, authorityRoyaltyPercentage);

Yields:

[
{
address: 'Betkx8CfRUwQAqZZRqKt13zo4t9awNFeriD2bMAq2xfJ',
share: 3
},
{
address: 'Dn4D8vVvpKzCALq1X5jasPrwvs5kXnSJtfbji4iZaq6R',
share: 92
},
{
address: '3MtckfRX4VRJ1yUmPHpKZstAQ8S3WfhRnNJLT8LqTZEr',
share: 5
}
]

Parameters

creators: { address: string; share: number }[]

Array of creators
authorityAddress: PublicKey

Address of the auctionhouse authority
authorityRoyaltyPercentage: number = 4.25

Percentage of royalties to be added to the marketplace

Returns { address: string; share: number }[]

uploadNFTFileToStorage

uploadNFTFileToStorage(image: null | File, metadataJson: MetadataObject, isAnimation?: boolean, nftStorageKey?: string): Promise<undefined | readonly [string, string] | readonly [string]>

- Defined in packages/core/src/utils.ts:63
Uploads an NFT's image or video or file to decentralized storage.

Parameters
- image: null | File
- metadataJson: MetadataObject
- isAnimation: boolean = false
- nftStorageKey: string = NFT_STORAGE_API_KEY
  
  API key provided by https://nft.storage. See documentation at:
Returns Promise<undefined | readonly [string, string] | readonly [string]>

Index

Namespaces

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

Attribute

Type declaration

Optional display_type?: string

Optional trait_type?: string

value: string | number

IAuctionOptions

Type declaration

connection: Connection

wallet: Wallet

Receipt

ReceiptAddress

ReceiptType

TransactionSignature

Variables

Const AUCTION_HOUSE

Const AUCTION_HOUSE_PROGRAM_ID

Const MINT_CONFIG

Type declaration

mintRoyalties: number

seller_fee_basis_points: number

Const MIRAGE_AUCTION_HOUSE

Const MIRAGE_AUCTION_HOUSE_AUTHORITY

Const NFT_STORAGE_API_KEY

Const SIGNER

Const SPL_ASSOCIATED_TOKEN_ACCOUNT_PROGRAM_ID

Const TOKEN_METADATA_PROGRAM_ID

Const WRAPPED_SOL_MINT

Functions

getAccountInfo

Parameters

connection: Connection

address: PublicKey

Optional commitment: Commitment

programId: PublicKey = TOKEN_PROGRAM_ID

Returns Promise<{ address: PublicKey; amount: any; closeAuthority: any; delegate: any; delegatedAmount: any; isFrozen: boolean; isInitialized: boolean; isNative: boolean; mint: any; owner: any; rentExemptReserve: any }>

getAtaForMint

Parameters

mint: PublicKey

address: PublicKey

Returns [PublicKey, number]

getMetadata

Parameters

mint: PublicKey

Returns PublicKey

getNftOwner

Parameters

mint: string | PublicKey

connection: Connection

Returns Promise<readonly [string, PublicKey, Buffer | ParsedAccountData]>

getTokenTransactions

Parameters

mint: string | PublicKey

auctionHouse: PublicKey

connection: Connection

Returns Promise<(TransactionReceipt | undefined)[]>

isPdaAddressInitialize

Parameters

connection: Connection

pdaAddress: PublicKey

Returns Promise<boolean>

processCreatorShares

Parameters

creators: { address: string; share: number }[]

authorityAddress: PublicKey

authorityRoyaltyPercentage: number = 4.25

Returns { address: string; share: number }[]

uploadNFTFileToStorage

Parameters

image: null | File

metadataJson: MetadataObject

isAnimation: boolean = false