AssetMintingLib | mirrorworld-program-libary-sdks

Hierarchy

AssetMintingLib

Constructors

constructor

new AssetMintingLib(programId: PublicKey, connection: Connection, wallet: Wallet): AssetMintingLib

- Defined in asset-minting/src/asset-minting-lib.ts:35
Parameters
- programId: PublicKey
- connection: Connection
- wallet: Wallet
Returns AssetMintingLib

Properties

connection

connection: Connection

program

program: Program<AssetMinting>

Methods

addAssetEventListener

addAssetEventListener(callback: ((event: AssetEvent) => void)): number

- Defined in asset-minting/src/asset-minting-lib.ts:488
Add asset event listener.

Parameters
- callback: ((event: AssetEvent) => void)
  
  Callback for the event to manage the event response on emit.
  - - (event: AssetEvent): void
    - Parameters
      - event: AssetEvent
      Returns void
Returns number

addCollectionEventListener

addCollectionEventListener(callback: ((event: CollectionEvent) => void)): number

- Defined in asset-minting/src/asset-minting-lib.ts:472
Add collection event listener.

Parameters
- callback: ((event: CollectionEvent) => void)
  
  Callback for the event to manage the event response on emit.
  - - (event: CollectionEvent): void
    - Parameters
      - event: CollectionEvent
      Returns void
Returns number

addFeePayerAndRecentBlockHashInTransaction

addFeePayerAndRecentBlockHashInTransaction(tx: Transaction, feePayer: PublicKey): Promise<Transaction>

- Defined in asset-minting/src/asset-minting-lib.ts:71
Add signature in the transaction.

Parameters
- tx: Transaction
  
  Transaction object where signature needs to add.
- feePayer: PublicKey
  
  public key of the address which going to pay the fee.
Returns Promise<Transaction>

addMintEventListener

addMintEventListener(callback: ((event: MintEvent) => void)): number

- Defined in asset-minting/src/asset-minting-lib.ts:464
Add mint event listener.

Parameters
- callback: ((event: MintEvent) => void)
  
  Callback for the event to manage the event response on emit.
  - - (event: MintEvent): void
    - Parameters
      - event: MintEvent
      Returns void
Returns number

addSignatureInTransaction

addSignatureInTransaction(tx: Transaction, signerAddress: PublicKey, signature: Buffer): Transaction

- Defined in asset-minting/src/asset-minting-lib.ts:60
Add signature in the transaction.

Parameters
- tx: Transaction
  
  Transaction object where signature needs to add.
- signerAddress: PublicKey
  
  Signer public key from which secret key transaction is signed.
- signature: Buffer
  
  Signed transaction message signature.
Returns Transaction

addSubCollectionEventListener

addSubCollectionEventListener(callback: ((event: SubCollectionEvent) => void)): number

- Defined in asset-minting/src/asset-minting-lib.ts:480
Add sub collection event listener.

Parameters
- callback: ((event: SubCollectionEvent) => void)
  
  Callback for the event to manage the event response on emit.
  - - (event: SubCollectionEvent): void
    - Parameters
      - event: SubCollectionEvent
      Returns void
Returns number

createAndAddCreatorSignMetadataInstruction

createAndAddCreatorSignMetadataInstruction(tx: Transaction, uuid: string, creatorPublicKey: PublicKey, mplProgram?: PublicKey): Promise<Transaction>

- Defined in asset-minting/src/asset-minting-lib.ts:515
Create and add creator sign metadata instruction.

Parameters
- tx: Transaction
  
  Transaction object where instruction needs to add.
- uuid: string
  
  Seed for the mint account
- creatorPublicKey: PublicKey
  
  Creator public key
- mplProgram: PublicKey = METADATA_PROGRAM_ID
  
  Metadata program id
Returns Promise<Transaction>

createAssetTokenTransaction

createAssetTokenTransaction(assetUuid: string, collectionUuid: string, payer: PublicKey, signingAuthority: PublicKey, user: PublicKey, assetMintAuthority: PublicKey, tokenName: string, tokenSymbol: string, tokenUrl: string, tokenIsMutable: boolean, tokenSellerPoint: number, creators: CreatorType[], configName?: string, collectionUpdateAuthority?: PublicKey, systemProgram?: PublicKey, rent?: PublicKey, associatedTokenProgram?: PublicKey, tokenProgram?: PublicKey, mplProgram?: PublicKey): Promise<Transaction>

- Defined in asset-minting/src/asset-minting-lib.ts:391
Create asset token transaction

Parameters
- assetUuid: string
  
  asset uuid
- collectionUuid: string
  
  seed for the collection mint account
- payer: PublicKey
  
  transaction fee payer public key
- signingAuthority: PublicKey
  
  signing authority public key
- user: PublicKey
  
  user public key
- assetMintAuthority: PublicKey
- tokenName: string
  
  token name
- tokenSymbol: string
  
  token symbol
- tokenUrl: string
  
  token url
- tokenIsMutable: boolean
  
  token is mutable
- tokenSellerPoint: number
  
  token seller point
- creators: CreatorType[]
  
  List of the creators
- configName: string = NAME
  
  config account seed for pda
- collectionUpdateAuthority: PublicKey = signingAuthority
  
  collection update authority (by default it's singing )
- systemProgram: PublicKey = SystemProgram.programId
  
  system program id
- rent: PublicKey = SYSVAR_RENT_PUBKEY
  
  rent program id
- associatedTokenProgram: PublicKey = ASSOCIATED_TOKEN_PROGRAM_ID
  
  associated token program id
- tokenProgram: PublicKey = TOKEN_PROGRAM_ID
  
  token program id
- mplProgram: PublicKey = METADATA_PROGRAM_ID
  
  Metadata program id
Returns Promise<Transaction>

createCollectionTokenTransaction

createCollectionTokenTransaction(collectionUuid: string, payer: PublicKey, signingAuthority: PublicKey, collectionMintAuthority: PublicKey, collectionOwner: PublicKey, tokenName: string, tokenSymbol: string, tokenUrl: string, tokenIsMutable: boolean, tokenSellerPoint: number, creators: CreatorType[], configName?: string, systemProgram?: PublicKey, rent?: PublicKey, associatedTokenProgram?: PublicKey, tokenProgram?: PublicKey, mplProgram?: PublicKey): Promise<Transaction>

- Defined in asset-minting/src/asset-minting-lib.ts:243
Create collection token transaction

Parameters
- collectionUuid: string
  
  seed for the collection mint account
- payer: PublicKey
  
  transaction fee payer public key
- signingAuthority: PublicKey
  
  signing authority public key
- collectionMintAuthority: PublicKey
  
  collection mint authority public key
- collectionOwner: PublicKey
  
  collection owner
- tokenName: string
  
  token name
- tokenSymbol: string
  
  token symbol
- tokenUrl: string
  
  token url
- tokenIsMutable: boolean
  
  token is mutable
- tokenSellerPoint: number
  
  token seller point
- creators: CreatorType[]
  
  List of the creators
- configName: string = NAME
  
  config account seed for pda
- systemProgram: PublicKey = SystemProgram.programId
  
  system program id
- rent: PublicKey = SYSVAR_RENT_PUBKEY
  
  rent program id
- associatedTokenProgram: PublicKey = ASSOCIATED_TOKEN_PROGRAM_ID
  
  associated token program id
- tokenProgram: PublicKey = TOKEN_PROGRAM_ID
  
  token program id
- mplProgram: PublicKey = METADATA_PROGRAM_ID
  
  Metadata program id
Returns Promise<Transaction>

createInitializeConfigTransaction

createInitializeConfigTransaction(payer: PublicKey, signingAuthority: PublicKey, configName?: string, systemProgram?: PublicKey, rent?: PublicKey): Promise<Transaction>

- Defined in asset-minting/src/asset-minting-lib.ts:164
Create initialize config transaction

Parameters
- payer: PublicKey
  
  transaction fee payer public key
- signingAuthority: PublicKey
  
  signing authority public key
- configName: string = NAME
  
  config account seed for pda
- systemProgram: PublicKey = SystemProgram.programId
  
  system program id
- rent: PublicKey = SYSVAR_RENT_PUBKEY
  
  rent program id
Returns Promise<Transaction>

createMintTokenTransaction

createMintTokenTransaction(assetUuid: string, payer: PublicKey, signingAuthority: PublicKey, mintAuthority: PublicKey, configName?: string, systemProgram?: PublicKey, rent?: PublicKey, associatedTokenProgram?: PublicKey, tokenProgram?: PublicKey): Promise<Transaction>

- Defined in asset-minting/src/asset-minting-lib.ts:194
Create mint token transaction

Parameters
- assetUuid: string
  
  seed for the mint account
- payer: PublicKey
  
  transaction fee payer public key
- signingAuthority: PublicKey
  
  signing authority public key
- mintAuthority: PublicKey
  
  token mint authority
- configName: string = NAME
  
  config account seed for pda
- systemProgram: PublicKey = SystemProgram.programId
  
  system program id
- rent: PublicKey = SYSVAR_RENT_PUBKEY
  
  rent program id
- associatedTokenProgram: PublicKey = ASSOCIATED_TOKEN_PROGRAM_ID
  
  associated token program id
- tokenProgram: PublicKey = TOKEN_PROGRAM_ID
  
  token program id
Returns Promise<Transaction>

createSubCollectionTokenTransaction

createSubCollectionTokenTransaction(collectionUuid: string, subCollectionUuid: string, payer: PublicKey, signingAuthority: PublicKey, subCollectionMintAuthority: PublicKey, subCollectionOwner: PublicKey, tokenName: string, tokenSymbol: string, tokenUrl: string, tokenIsMutable: boolean, tokenSellerPoint: number, creators: CreatorType[], configName?: string, collectionUpdateAuthority?: PublicKey, systemProgram?: PublicKey, rent?: PublicKey, associatedTokenProgram?: PublicKey, tokenProgram?: PublicKey, mplProgram?: PublicKey): Promise<Transaction>

- Defined in asset-minting/src/asset-minting-lib.ts:313
Create sub collection token transaction

Parameters
- collectionUuid: string
  
  seed for the collection mint account
- subCollectionUuid: string
  
  seed for the sub collection mint account
- payer: PublicKey
  
  transaction fee payer public key
- signingAuthority: PublicKey
  
  signing authority public key
- subCollectionMintAuthority: PublicKey
  
  sub collection mint authority public key
- subCollectionOwner: PublicKey
  
  sub collection owner public key
- tokenName: string
  
  token name
- tokenSymbol: string
  
  token symbol
- tokenUrl: string
  
  token url
- tokenIsMutable: boolean
  
  token is mutable
- tokenSellerPoint: number
  
  token seller point
- creators: CreatorType[]
  
  List of the creators
- configName: string = NAME
  
  config account seed for pda
- collectionUpdateAuthority: PublicKey = signingAuthority
  
  collection update authority (By default it's singing authority)
- systemProgram: PublicKey = SystemProgram.programId
  
  system program id
- rent: PublicKey = SYSVAR_RENT_PUBKEY
  
  rent program id
- associatedTokenProgram: PublicKey = ASSOCIATED_TOKEN_PROGRAM_ID
  
  associated token program id
- tokenProgram: PublicKey = TOKEN_PROGRAM_ID
  
  token program id
- mplProgram: PublicKey = METADATA_PROGRAM_ID
  
  Metadata program id
Returns Promise<Transaction>

creatorSignMetadataInstruction

creatorSignMetadataInstruction(uuid: string, creatorPublicKey: PublicKey, mplProgram?: PublicKey): Promise<TransactionInstruction>

- Defined in asset-minting/src/asset-minting-lib.ts:498
Creator sign metadata instruction.

Parameters
- uuid: string
  
  Seed for the mint account
- creatorPublicKey: PublicKey
  
  Creator public key
- mplProgram: PublicKey = METADATA_PROGRAM_ID
  
  Metadata program id
Returns Promise<TransactionInstruction>

getConfigAccountData

getConfigAccountData(configAccountPda: PublicKey): Promise<any>

- Defined in asset-minting/src/asset-minting-lib.ts:143
Get config account pda data

Parameters
- configAccountPda: PublicKey
  
  pda address for data
Returns Promise<any>

getConfigAccountPdaAndBump

getConfigAccountPdaAndBump(name?: String): Promise<[PublicKey, number]>

- Defined in asset-minting/src/asset-minting-lib.ts:92
get the config account pda and bump.

Parameters
- name: String = NAME
  
  seed for the config account.
Returns Promise<[PublicKey, number]>

getCurrentBlockTime

getCurrentBlockTime(): Promise<BN>

- Defined in asset-minting/src/asset-minting-lib.ts:150
Get current block time

Returns Promise<BN>

getMasterEditionAccountPda

getMasterEditionAccountPda(mintAccountPda: PublicKey, mplProgramId?: PublicKey): Promise<[PublicKey, number]>

- Defined in asset-minting/src/asset-minting-lib.ts:127
Get master edition account pda.

Parameters
- mintAccountPda: PublicKey
  
  token mint account
- mplProgramId: PublicKey = METADATA_PROGRAM_ID
  
  metadata program id
Returns Promise<[PublicKey, number]>

getMetadataAccountPda

getMetadataAccountPda(mintAccountPda: PublicKey, mplProgramId?: PublicKey): Promise<[PublicKey, number]>

- Defined in asset-minting/src/asset-minting-lib.ts:111
Get metadata account pda.

Parameters
- mintAccountPda: PublicKey
  
  token mint account
- mplProgramId: PublicKey = METADATA_PROGRAM_ID
  
  metadata program id
Returns Promise<[PublicKey, number]>

getMintAccountPdaAndBump

getMintAccountPdaAndBump(uuid: String): Promise<[PublicKey, number]>

- Defined in asset-minting/src/asset-minting-lib.ts:101
get the mint account pda and bump.

Parameters
- uuid: String
  
  seed for the mint account.
Returns Promise<[PublicKey, number]>

isPdaAddressInitialize

isPdaAddressInitialize(pdaAddress: PublicKey): Promise<boolean>

- Defined in asset-minting/src/asset-minting-lib.ts:81
Is pda address initialize.

Parameters
- pdaAddress: PublicKey
Returns Promise<boolean>

removeEventListener

removeEventListener(eventId: number): Promise<void>

- Defined in asset-minting/src/asset-minting-lib.ts:456
Remove event listener.

Parameters
- eventId: number
  
  Event id which need to remove.
Returns Promise<void>

signTransaction

signTransaction(tx: Transaction, secretKey: string): Transaction

- Defined in asset-minting/src/asset-minting-lib.ts:46
Sign the transaction and add the signature in the transaction.

Parameters
- tx: Transaction
  
  Transaction object which needs to sign.
- secretKey: string
  
  Transaction signer secret key (secret key in base58 string).
Returns Transaction

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

programId: PublicKey

connection: Connection

wallet: Wallet

Returns AssetMintingLib

Properties

connection

program

Methods

addAssetEventListener

Parameters

callback: ((event: AssetEvent) => void)

Parameters

event: AssetEvent

Returns void

Returns number

addCollectionEventListener

Parameters

callback: ((event: CollectionEvent) => void)

Parameters

event: CollectionEvent

Returns void

Returns number

addFeePayerAndRecentBlockHashInTransaction

Parameters

tx: Transaction

feePayer: PublicKey

Returns Promise<Transaction>

addMintEventListener

Parameters

callback: ((event: MintEvent) => void)

Parameters

event: MintEvent

Returns void

Returns number

addSignatureInTransaction

Parameters

tx: Transaction

signerAddress: PublicKey

signature: Buffer

Returns Transaction

addSubCollectionEventListener

Parameters

callback: ((event: SubCollectionEvent) => void)

Parameters

event: SubCollectionEvent

Returns void

Returns number

createAndAddCreatorSignMetadataInstruction

Parameters

tx: Transaction

uuid: string

creatorPublicKey: PublicKey

mplProgram: PublicKey = METADATA_PROGRAM_ID

Returns Promise<Transaction>

createAssetTokenTransaction

Parameters

assetUuid: string

collectionUuid: string

payer: PublicKey

signingAuthority: PublicKey

user: PublicKey

assetMintAuthority: PublicKey

tokenName: string

tokenSymbol: string

tokenUrl: string

tokenIsMutable: boolean

tokenSellerPoint: number

creators: CreatorType[]

configName: string = NAME

collectionUpdateAuthority: PublicKey = signingAuthority

systemProgram: PublicKey = SystemProgram.programId

rent: PublicKey = SYSVAR_RENT_PUBKEY