IReceivable

Git Source

Inherits: IReceivableEvent

Functions

initialize

Initializes the Receivable.

function initialize(address initialGovernor_) external;

Parameters

Name	Type	Description
initialGovernor_	address	The address of the governor.

createReceivable

Mint a new receivable.

The event faceAmount is converted to decimal with 6 decimals.

function createReceivable(Receivable.Create memory create_) external returns (uint256 tokenId_);

Parameters

Name	Type	Description
create_	Receivable.Create	The struct containing the information of the receivable to be created.

Returns

Name	Type	Description
tokenId_	uint256	The id of the newly created receivable.

getReceivableInfoById

Get the information of a receivable.

function getReceivableInfoById(uint256 tokenId_) external view returns (Receivable.Info memory info_);

Parameters

Name	Type	Description
tokenId_	uint256	The id of the receivable.

Returns

Name	Type	Description
info_	Receivable.Info	The struct containing the information of the receivable.

burnReceivable

Burn a receivable.

function burnReceivable(uint256 tokenId_) external;

Parameters

Name	Type	Description
tokenId_	uint256	The id of the receivable.

governor

Returns the addres of the governor.

function governor() external view returns (address governor_);

Returns

Name	Type	Description
governor_	address	The address of the governor.