Class MetriverseCore

Hierarchy (view full)

MetrixContract
- MetriverseCore

Constructors

constructor

new MetriverseCore(address, provider): MetriverseCore
Parameters
- address: string
- provider: Provider
Returns MetriverseCore
Overrides MetrixContract.constructor
- Defined in src/metriverse/MetriVerseCore.ts:8

Properties

abi

abi: any[]

address

address: string

bytecode

bytecode: undefined | string

provider

provider: Provider

Methods

approveToken

approveToken(assetAddress, approved): Promise<Transaction>
Approve a token for trade on the inbuilt auctions
Parameters
- assetAddress: string
  the token address
- approved: boolean
  whether to approve
Returns Promise<Transaction>
an array of TransactionReceipt objects
- Defined in src/metriverse/MetriVerseCore.ts:18

approvedToken

approvedToken(tokenAddress): Promise<boolean>
Check if a token is an approved token
Parameters
- tokenAddress: string
  the EVM address to check
Returns Promise<boolean>
is token approve
- Defined in src/metriverse/MetriVerseCore.ts:38

auctionController

auctionController(): Promise<string>
Get the current auction controller

Returns Promise<string>
the MRC721AuctionController address
- Defined in src/metriverse/MetriVerseCore.ts:49

auctionFee

auctionFee(): Promise<bigint>
Get the current auction fee this number is divided by 10000 to get the percent.

Returns Promise<bigint>
the current auction fee pecent
- Defined in src/metriverse/MetriVerseCore.ts:58

balance

balance(): Promise<bigint>
Get this contract balance

Returns Promise<bigint>
the satoshi balance of this contract
Inherited from MetrixContract.balance
- Defined in src/mrx/MetrixContract.ts:30

burnableFactory

burnableFactory(): Promise<string>
Get the BurnableMRC721 factory address

Returns Promise<string>
the address of the MRC721Factory
- Defined in src/metriverse/MetriVerseCore.ts:67

call

call(method, args): Promise<undefined | Result>
Perform calltocontract
Parameters
- method: string
  The contract method to call
- args: any[]
  The arguments
Returns Promise<undefined | Result>
see Result
Inherited from MetrixContract.call
- Defined in src/mrx/MetrixContract.ts:44

controllers

controllers(operator): Promise<boolean>
Checks if a given address is a controller
Parameters
- operator: string
Returns Promise<boolean>
if the operator is a controller
- Defined in src/metriverse/MetriVerseCore.ts:77

createMRC721

createMRC721(name, symbol, baseURI, burnable, royalty, beneficiary, signature, gasLimit?): Promise<Transaction>
Create an MRC721 token
Parameters
- name: string
  the name of the token
- symbol: string
  the symbol of the token
- baseURI: string
  the baseURI of the token
- burnable: boolean
  if the token is burnable
- royalty: bigint
  the royalty of the token
- beneficiary: string
  the inital royalty beneficiary
- signature: string
  the signed message see permissionSlip
- gasLimit: undefined | number = 2500000
  this 2500000 and 3500000
Returns Promise<Transaction>
an array of TransactionReceipt objects
- Defined in src/metriverse/MetriVerseCore.ts:94

factory

factory(): Promise<string>
Get the MRC721 factory address

Returns Promise<string>
the address of the MRC721Factory
- Defined in src/metriverse/MetriVerseCore.ts:130

getAuctionRoyalty

getAuctionRoyalty(price): Promise<bigint>
Get the royalty for an auction or sale at a given price
Parameters
- price: bigint
  the price that the token sold at
Returns Promise<bigint>
the royalty that should be charged
- Defined in src/metriverse/MetriVerseCore.ts:140

getControllers

getControllers(operator): Promise<boolean>
Checks if a given address is a controller
Parameters
- operator: string
Returns Promise<boolean>
if the operator is a controller
- Defined in src/metriverse/MetriVerseCore.ts:152

getEventLogs

getEventLogs(): Promise<EventLogs>
Get receipts from a transaction

Returns Promise<EventLogs>
an EventLogs object
Inherited from MetrixContract.getEventLogs
- Defined in src/mrx/MetrixContract.ts:94

internalToken

internalToken(tokenAddress): Promise<boolean>
Check if a token is an internal token
Parameters
- tokenAddress: string
  the EVM address to check
Returns Promise<boolean>
is token internal
- Defined in src/metriverse/MetriVerseCore.ts:162

internalTokenCount

internalTokenCount(): Promise<bigint>
Get the count of internal tokens

Returns Promise<bigint>
the current internal token count
- Defined in src/metriverse/MetriVerseCore.ts:173

internalTokenIndex

internalTokenIndex(index): Promise<string>
Get the address of an internal token by it's index
Parameters
- index: bigint
  the uint256 index of the token
Returns Promise<string>
the address of the token or address 0 if it is not set
- Defined in src/metriverse/MetriVerseCore.ts:183

isApprovedToken

isApprovedToken(tokenAddress): Promise<boolean>
Check if a token is an approved token
Parameters
- tokenAddress: string
  the EVM address to check
Returns Promise<boolean>
is token approve
- Defined in src/metriverse/MetriVerseCore.ts:195

isInternalToken

isInternalToken(tokenAddress): Promise<boolean>
Check if a token is an internal token
Parameters
- tokenAddress: string
  the EVM address to check
Returns Promise<boolean>
is token internal
- Defined in src/metriverse/MetriVerseCore.ts:207

migrate

migrate(core): Promise<Transaction>
Migrate the factories and auction controller(s) to a new contract.
Parameters
- core: string
  the new MetriverseCore contract
Returns Promise<Transaction>
an array of TransactionReceipt objects
- Defined in src/metriverse/MetriVerseCore.ts:219

nonce

nonce(sender): Promise<bigint>
Get the nonce of the given address
Parameters
- sender: string
  the address to get the nonce of
Returns Promise<bigint>
the nonce of the address
- Defined in src/metriverse/MetriVerseCore.ts:233

owner

owner(): Promise<string>
Get the contract owner

Returns Promise<string>
the EVM style address of the owner of this contract
- Defined in src/metriverse/MetriVerseCore.ts:242

permissionSlip

permissionSlip(info, royalty, burnable, nonce, beneficiary): Promise<string>
Hash parameters which can be signed by a MetriverseController to allow an account to create an MRC721 from one of the factories
Parameters
- info: string
  a keccak256 hash of the token info see tokenInfo
- royalty: bigint
  a uint96 royalty rate
- burnable: boolean
  if the token will be burnable
- nonce: bigint
  the nonce of the token creator
- beneficiary: string
  the beneficiary of the token royalties
Returns Promise<string>
a keccak256 hash of the parameters
- Defined in src/metriverse/MetriVerseCore.ts:257

renounceOwnership

renounceOwnership(): Promise<Transaction>
Renounce ownership of this contract

Returns Promise<Transaction>
an array of TransactionReceipt objects
- Defined in src/metriverse/MetriVerseCore.ts:281

send

send(method, args, value?, gasLimit?, gasPrice?): Promise<{
    hash160: string;
    sender: string;
    txid: string;
}>
Perform sendtocontract
Parameters
- method: string
  The contract method to send to
- args: any[]
  The arguments to use
- value: undefined | string = '0'
  The amount to send to the contract
- gasLimit: undefined | number = 250000
  The amount of gas units allowed
- gasPrice: undefined | number = 5000
  The satoshi price per gas
Returns Promise<{
    hash160: string;
    sender: string;
    txid: string;
}>
see Result
Inherited from MetrixContract.send
- Defined in src/mrx/MetrixContract.ts:66

sendFunds

sendFunds(address, amount): Promise<Transaction>
Send MRX funds from the contract's balance
Parameters
- address: string
- amount: bigint
  the satoshi amount to send
Returns Promise<Transaction>
an array of TransactionReceipt objects
- Defined in src/metriverse/MetriVerseCore.ts:296

setAuctionController

setAuctionController(address): Promise<Transaction>
Set the MRC721 auction controller
Parameters
- address: string
  the MRC721AuctuionController
Returns Promise<Transaction>
an array of TransactionReceipt objects
- Defined in src/metriverse/MetriVerseCore.ts:313

setAuctionFee

setAuctionFee(fee): Promise<Transaction>
Set platform fee for inbuilt auctions
Parameters
- fee: bigint
  the uint96 fee (up to 1000 or 10%)
Returns Promise<Transaction>
an array of TransactionReceipt objects
- Defined in src/metriverse/MetriVerseCore.ts:327

setBurnableFactory

setBurnableFactory(address): Promise<Transaction>
Set the BurnableMRC721 factory address
Parameters
- address: string
  the address of the BurnableMRC721Factory contract
Returns Promise<Transaction>
an array of TransactionReceipt objects
- Defined in src/metriverse/MetriVerseCore.ts:343

setController

setController(operator, controller): Promise<Transaction>
Allow or disallow a controller of this contract, controllers are able to call the sign for the createMRC721 function.
Parameters
- operator: string
- controller: boolean
Returns Promise<Transaction>
an array of TransactionReceipt objects
- Defined in src/metriverse/MetriVerseCore.ts:358

setFactory

setFactory(address): Promise<Transaction>
Set the MRC721 factory address
Parameters
- address: string
  the address of the MRC721Factory contract
Returns Promise<Transaction>
an array of TransactionReceipt objects
- Defined in src/metriverse/MetriVerseCore.ts:378

tokenInfo

tokenInfo(name, symbol, baseURI): Promise<string>
Parameters
- name: string
  the name of the token
- symbol: string
  the symbol of the token
- baseURI: string
  the base uri of the token
Returns Promise<string>
a keccak256 hash of the data
- Defined in src/metriverse/MetriVerseCore.ts:394

transferOwnership

transferOwnership(address): Promise<Transaction>
Transfer ownership of this contract
Parameters
- address: string
  the EVM adddress of the receiver
Returns Promise<Transaction>
an array of TransactionReceipt objects
- Defined in src/metriverse/MetriVerseCore.ts:412

Class MetriverseCore

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MetriverseCore

Properties

abi

address

bytecode

provider

Methods

approveToken

Parameters

Returns Promise<Transaction>

approvedToken

Parameters

Returns Promise<boolean>

auctionController

Returns Promise<string>

auctionFee

Returns Promise<bigint>

balance

Returns Promise<bigint>

burnableFactory

Returns Promise<string>

call

Parameters

Returns Promise<undefined | Result>

controllers

Parameters

Returns Promise<boolean>

createMRC721

Parameters

Returns Promise<Transaction>

factory

Returns Promise<string>

getAuctionRoyalty

Parameters

Returns Promise<bigint>

getControllers

Parameters

Returns Promise<boolean>

getEventLogs

Returns Promise<EventLogs>

internalToken

Parameters

Returns Promise<boolean>

internalTokenCount

Returns Promise<bigint>

internalTokenIndex

Parameters

Returns Promise<string>

isApprovedToken

Parameters

Returns Promise<boolean>

isInternalToken

Parameters

Returns Promise<boolean>

migrate

Parameters

Returns Promise<Transaction>

nonce

Parameters

Returns Promise<bigint>

owner

Returns Promise<string>

permissionSlip

Parameters

Returns Promise<string>

renounceOwnership

Returns Promise<Transaction>

send

Parameters

Returns Promise<{ hash160: string; sender: string; txid: string; }>

sendFunds

Returns Promise<{
hash160: string;
sender: string;
txid: string;
}>