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?)
Parameter | Mandatory | Type | 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.
creator.getAriaAllowance(spender, address?)
Parameter | Mandatory | Type | 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 | Mandatory | Type | Description |
---|---|---|---|
address | β | String | Target wallet address. |
Response: 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 | Mandatory | Type | Description |
---|---|---|---|
type | β | String | 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. |
address | β | String | Target wallet address. |
Response: promise
returns bigint
.
Get credit price
Get the credit price of the target credit type on the protocol.
Method:
creator.getCreditPrice(creditType)
Parameter | Mandatory | Type | Description |
---|---|---|---|
creditType | β | String | 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. |
Response: 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 | Mandatory | Type | Description |
---|---|---|---|
creditType | β | String | 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. |
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. |
Response:
promise
returns object
: The receipt of the blockchain transaction.
Updated about 1 year ago