Class BaseSale

Hierarchy (view full)

MetrixContract
- BaseSale

Index

Constructors

Properties

Methods

balance call cancelSale core createSale getEventLogs getSale owner pause paused purchase renounceOwnership send transferOwnership unpause

Constructors

constructor

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

Properties

abi

abi: any[]

address

address: string

bytecode

bytecode: undefined | string

provider

provider: Provider

Methods

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

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

cancelSale

cancelSale(assetAddress, tokenId, gasLimit?): Promise<Transaction>
Cancels an MRC721 sale
Parameters
- assetAddress: string
  the EVM adddress of the MRC721 contract
- tokenId: bigint
  the uint256 id of the token
- gasLimit: undefined | number = 300000
  optionally the maximum units of gas which can be consumed
Returns Promise<Transaction>
an array of TransactionReceipt objects
- Defined in src/metriverse/auction/BaseSale.ts:19

core

core(): Promise<string>
Gets the MetriverseCore contract

Returns Promise<string>
the EVM style address of the MetriverseCore contract
- Defined in src/metriverse/auction/BaseSale.ts:42

createSale

createSale(assetAddress, tokenId, price, beneficiaryAddress, gasLimit?): Promise<Transaction>
Create a new MRC721 sale
Parameters
- assetAddress: string
  the EVM adddress of the MRC721 contract
- tokenId: bigint
  the uint256 id of the token
- price: bigint
  the price in satoshi MRX
- beneficiaryAddress: string
  the EVM adddress which the proceeds will go to
- gasLimit: undefined | number = 300000
  optionally the maximum units of gas which can be consumed
Returns Promise<Transaction>
an array of TransactionReceipt objects
- Defined in src/metriverse/auction/BaseSale.ts:56

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

getSale

getSale(assetAddress, tokenId): Promise<[tokenId: bigint, price: bigint, beneficiaryAddress: string]>
Get a sale object from the contract state
Parameters
- assetAddress: string
  the EVM adddress of the MRC721 contract
- tokenId: bigint
  the uint256 id of the token
Returns Promise<[tokenId: bigint, price: bigint, beneficiaryAddress: string]>
the Auction object
- Defined in src/metriverse/auction/BaseSale.ts:88

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/auction/BaseSale.ts:112

pause

pause(): Promise<Transaction>
Pause new sales from being created

Returns Promise<Transaction>
an array of TransactionReceipt objects
- Defined in src/metriverse/auction/BaseSale.ts:121

paused

paused(): Promise<boolean>
Check if the contract is paused

Returns Promise<boolean>
if the contract is paused
- Defined in src/metriverse/auction/BaseSale.ts:134

purchase

purchase(assetAddress, tokenId, price?, gasLimit?): Promise<Transaction>
Purchase an MRC721 token which is for sale.
Parameters
- assetAddress: string
  the EVM adddress of the MRC721 contract
- tokenId: bigint
  the uint256 id of the token
- price: undefined | string = '0'
  the amount in MRX as a string
- gasLimit: undefined | number = 300000
  optionally the maximum units of gas which can be consumed
Returns Promise<Transaction>
an array of TransactionReceipt objects
- Defined in src/metriverse/auction/BaseSale.ts:147

renounceOwnership

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

Returns Promise<Transaction>
an array of TransactionReceipt objects
- Defined in src/metriverse/auction/BaseSale.ts:171

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

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/auction/BaseSale.ts:185

unpause

unpause(): Promise<Transaction>
Unpause allowing new sales to be created

Returns Promise<Transaction>
an array of TransactionReceipt objects
- Defined in src/metriverse/auction/BaseSale.ts:198

Class BaseSale

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BaseSale

Properties

abi

address

bytecode

provider

Methods

balance

Returns Promise<bigint>

call

Parameters

Returns Promise<undefined | Result>

cancelSale

Parameters

Returns Promise<Transaction>

core

Returns Promise<string>

createSale

Parameters

Returns Promise<Transaction>

getEventLogs

Returns Promise<EventLogs>

getSale

Parameters

Returns Promise<[tokenId: bigint, price: bigint, beneficiaryAddress: string]>

owner

Returns Promise<string>

pause

Returns Promise<Transaction>

paused

Returns Promise<boolean>

purchase

Parameters

Returns Promise<Transaction>

renounceOwnership

Returns Promise<Transaction>

send

Parameters

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

transferOwnership

Parameters

Returns Promise<Transaction>

unpause

Returns Promise<Transaction>

Settings

On This Page

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