These docs are for v1.0. Click to read the latest docs for v2.3.

Arianee Events

Methods related to event management.

Create Arianee event

โš ๏ธ

Fees

This method performs a blockchain transaction. It costs 1 credit and Gas.

Method

ArianeeWallets.methods.createArianeeEvent(data)
ParameterTypeMandatoryDescription
dataObjectโœ…Event creation data object.
data โ†’ uriStringโŒEvent uri.
data โ†’ contentImprintStringโŒEvent content imprint, either contentImprint or content need to be provided.
data โ†’ certificateIdNumberโœ…Arianee token ID of the NFT. Randomly generated if left empty.
data โ†’ arianeeEventIdNumberโŒArianee event ID. Randomly generated if left empty.
data โ†’ contentObjectโŒEvent content object, either contentImprint or content need to be provided.

Output

promise returns object: The receipt of the blockchain transaction and keys.

  • contentImprint - Arianee event content imprint.
  • arianeeEventId- Arianee event ID.

Example

const event={
    certificateId,
    content: {
        title:'title event',
        $schema: 'https://cert.arianee.org/version1/ArianeeEvent-i18n.json'
    }
}

const {  contentImprint, arianeeEventId } = await await wallet.methods.createArianeeEvent(event);

Store Arianee event content

Method

ArianeeWallets.methods.storeArianeeEvent(certificateId, arianeeEventId, content, url)
ParameterTypeMandatoryDescription
certificateIdNumberโœ…Arianee token ID of the NFT.
arianeeEventIdNumberโœ…Arianee event ID.
contentObjectโœ…Event content object.
uriStringโœ…URI of RPC server where you want to store the event content, usually brand's RPC server.

Output

promise returns any.

Example

await wallet
      .methods
      .storeArianeeEvent(
        certificateId, 
        arianeeEventId,
        event.content,
        'https://http://arianee.cleverapps.io/testnet/rpc');

Accept Arianee event

When accepting an Arianee event, it appears in the NFT history.

โš ๏ธ

Fees

This method performs a blockchain transaction. It costs Gas.

Method

ArianeeWallets.methods.acceptArianeeEvent(arianeeEventId)
ParameterTypeMandatoryDescription
arianeeEventIdNumberโœ…Arianee event ID.

Output

promise returns TransactionObject.

Example

await wallet.methods.acceptArianeeEvent(4433);

Refuse Arianee event

โš ๏ธ

Fees

This method performs a blockchain transaction. It costs Gas.

Method

ArianeeWallets.methods.refuseArianeeEvent(arianeeEventId)
ParameterTypeMandatoryDescription
arianeeEventIdNumberโœ…Arianee event ID.

Output

promise returns TransactionObject.

Example

await wallet.methods.refuseArianeeEvent(4433);