Get $ARIA20 & Manage Credits

Request $ARIA20 - Testnet

💡

Method for test purposes.

If no address is passed, the creator's address will be used.

Method

creator.requestTestnetAria20(address?)

Parameter	Type	Required	Description
`address`	String	❌	Recipient wallet address.

Get $ARIA20 allowance

Get the $ARIA20 allowance of the passed address for the passed spender address. This method allows the Store smart contract to spend aria from the creator's wallet.

⚠️
Getting $ARIA20 allowance is mandatory to buy credits.

💡
If no address is passed, the creator's address will be used.

Method

creator.getAriaAllowance(spender, address?)

Parameter	Type	Required	Description
`spender`	String	✅	Spender wallet address.
`address`	String	❌	Target wallet address.

Get native balance

Get the native balance.

💡
If no address is passed, the creator's address will be used.

Method

creator.getNativeBalance(address?)

Parameter	Type	Required	Description
`address`	String	✅	Target wallet address.

Return Payload

promise returns bigint.

Get credit balance

Get the balance of the passed credit type.

💡
If no address is passed, the creator's address will be used.

Method

creator.getCreditBalance(type, address?)

Parameter	Type	Required	Description
`type`	String	✅	The type of credit: → `smartAsset` = 0: type of credit to mint digital passport. → `message` = 1: type of credit to mint and sent messages to digital passports. → `arianeeEvent` = 2: type of credit to create, mint, and link an Arianee Event to a digital passport. → `update` = 3: type of credit to update minted NFT.
`address`	String	❌	Target wallet address.

Return Payload

promise returns bigint.

Get credit price

Get the credit price of the target credit type on the protocol.

Method

creator.getCreditPrice(creditType)

Parameter	Type	Required	Description
`creditType`	String	✅	The type of credit: → `smartAsset` = 0: type of credit to mint digital passport. → `message` = 1: type of credit to mint and sent messages to digital passports. → `arianeeEvent` = 2: type of credit to create, mint, and link an Arianee Event to a digital passport. → `update` = 3: type of credit to update minted digital passport.

Return Payload

promise returns bigint.

Buy credits

Credits are mandatory to use each charged feature on the Arianee Protocol.

⚠️
This method performs a blockchain transaction. It costs $ARIA20.

Method

creator.buyCredit(creditType, amount, overrideTransaction?:NonPayableOverrides)

Parameter	Type	Required	Description
`creditType`	String	✅	The type of credit: → `smartAsset` = 0: type of credit to mint digital passport. → `message` = 1: type of credit to mint and sent messages to digital passports. → `arianeeEvent` = 2: type of credit to create, mint, and link an Arianee Event to a digital passport. → `update` = 3: type of credit to update minted digital passport.
`amount`	Number	✅	Number of credits to buy.
`overrides`	`gasPrice`, `gasLimit`, `maxFeePerGas`, `maxPriorityPerGas`	❌	Allows you to override the gas/gasprice part to be able to move transactions through more quickly if needed.

Return Payload

promise returns object: The receipt of the blockchain transaction.