arianee-api-client
The ariane-api-client allows you to interact with the Arianee blockchain data through the Arianee API.
Multichain Methods
Fetch data on any Arianee's blockchain..
Fetch Events
getEvents(chainType, smartContractName, eventName, filters?)
Returns an array of BlockchainEvent
objects representing an event in the blockchain.
chainType
: AChainType
enum value representing the chain type (mainnet or testnet).smartContractName
: ASmartContractNames
enum value representing the smart contract name.eventName
: AblockchainEventsName
enum value representing the event name.filters
(optional): An object containing additional parameters to filter the events.
const events = await client.multichain.getEvents('mainnet', 'ArianeeSmartAsset', 'Transfer');
Fetch Owned NFTs
getOwnedNfts(chainType, address)
Returns an array of smartAssetInfo
objects representing the owned NFTs by the specified address.
chainType
: AChainType
enum value representing the chain type (mainnet or testnet).address
: A string representing the owner's address.
const nfts = await client.multichain.getOwnedNfts('mainnet', '0x1234567890123456789012345678901234567890');
Fetch Received Messages
getReceivedMessages(chainType, address)
Returns an array of decentralizedMessageInfo
objects representing the received decentralized messages by the specified address.
chainType
: AChainType
enum value representing the chain type (mainnet or testnet).address
: A string representing the recipient's address.
const messages = await client.multichain.getReceivedMessages('mainnet', '0x1234567890123456789012345678901234567890');
Fetch Identity
getIdentity(address)
Returns a brandIdentityInfo
object representing the brand identity associated with the specified address.
address
: A string representing the brand identity address.
const identity = await client.multichain.getIdentity('0x1234567890123456789012345678901234567890');
Network Methods
Fetch data on a specific Arianee's blockchain.
Fetch Events
getEvents(chainId, contractAddress, eventName, filters?)
Returns an array of BlockchainEvent
objects corresponding to the specified parameters.
chainId
: A string representing the chain identifier.contractAddress
: A string representing the smart contract address.eventName
: AblockchainEventsName
enum value representing the event name.filters
(optional): An object containing additional parameters to filter the events.
const events = await client.network.getEvents('polygon', '0x1234567890123456789012345678901234567890', 'Transfer');
Count Events
countEvents(chainId, contractAddress, eventName, filters?)
Returns the number of events corresponding to the specified parameters.
chainId
: A string representing the chain identifier.contractAddress
: A string representing the smart contract address.eventName
: AblockchainEventsName
enum value representing the event name.filters
(optional): An object containing additional parameters to filter the events.
const events = await client.network.countEvents('polygon', '0x1234567890123456789012345678901234567890', 'Transfer');
Fetch Owned NFTs
getOwnedNfts(protocol, address)
Returns an array of smartAssetInfo
objects representing the owned NFTs by the specified address on a specific network.
protocol
: A Protocol object representing the protocol (mainnet, testnet, polygon, arialabs...).address
: A string representing the owner's address.
const events = await client.network.getOwnedNfts('polygon', '0x1234567890123456789012345678901234567890');
Fetch NFT
getNft(protocol, tokenId)
Returns smartAssetInfo
objects representing a specific NFT on a particular network.
protocol
: A Protocol object representing the protocol (mainnet, testnet, polygon, arialabs...).tokenId
: A string representing the token ID.
const events = await client.network.smartAssetInfo('polygon', '12');
Fetch Specific NFT Events
getNftArianeeEvents(protocol, tokenId)
Returns an array of BlockchainEvent
objects representing an event in the blockchain for a specific NFT.
protocol
: A Protocol object representing the protocol (mainnet, testnet, polygon, arialabs...).tokenId
: A string representing the token ID.
const events = await client.network.smartAssetInfo('polygon', '12');
Fetch NFT Owner
getNftOwner(protocol, tokenId)
Returns a string representing the owner of the specified NFT
protocol
: A Protocol object representing the protocol (mainnet, testnet, polygon, arialabs...).tokenId
: A string representing the token ID.
const events = await client.network.getNftOwner('polygon', '12');
Fetch Identity
getIdentity(protocol, address)
Returns a brandIdentityInfo
object representing the brand identity associated with the specified address.
protocol
: A Protocol object representing the protocol (mainnet, testnet, polygon, arialabs...).address
: A string representing the brand identity address.
const events = await client.network.getIdentity('polygon', '0x1234567890123456789012345678901234567890');
Updated 5 months ago