Economy

To interact with Arianee Protocol, you need the native crypto tokens and $ARIA20.

Request $ARIA20 - Testnet

Method for test purposes.

πŸ’‘

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

Method

creator.requestTestnetAria20(address?)
ParameterTypeRequiredDescription
addressString❌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?)
ParameterTypeRequiredDescription
spenderStringβœ…Spender wallet address.
addressString❌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?)
ParameterTypeRequiredDescription
addressStringβœ…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?)
ParameterTypeRequiredDescription
typeStringβœ…The type of credit:
β†’ smartAsset = 0: type of credit to mint NFT.
β†’ message = 1: type of credit to mint and sent messages to NFTs.
β†’ arianeeEvent = 2: type of credit to create, mint, and link an Arianee Event to an NFT.
β†’ update = 3: type of credit to update minted NFT.
addressString❌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)
ParameterTypeRequiredDescription
creditTypeStringβœ…The type of credit:
β†’ smartAsset = 0: type of credit to mint NFT.
β†’ message = 1: type of credit to mint and sent messages to NFTs.
β†’ arianeeEvent = 2: type of credit to create, mint, and link an Arianee Event to an NFT.
β†’ update = 3: type of credit to update minted NFT.

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)
ParameterTypeRequiredDescription
creditTypeStringβœ…The type of credit:
β†’ smartAsset = 0: type of credit to mint NFT.
β†’ message = 1: type of credit to mint and sent messages to NFTs.
β†’ arianeeEvent = 2: type of credit to create, mint, and link an Arianee Event to an NFT.
β†’ update = 3: type of credit to update minted NFT.
amountNumberβœ…Number of credits to buy.
overridesgasPrice, 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.