Functions

All Functions Evaluate To Array

Allowl's five predefined functions always evaluate to an array. The resulting array can be empty. There is no provision for a user of the language to define new functions.

• Array_Function_GetEthereumNfts – List Ethereum Nfts for a given owner.
• Array_Function_GetSolanaNfts – List Solana Nfts for a given owner.
• Array_Function_GetIdentities – List Vatom identities for a given user.
• Array_Function_GetPoints – List points for a given user.
• Array_Function_GetVatoms – List Vatoms for a given user.

Array_Function_GetEthereumNfts

The GetEthereumNfts function requires three parameters:

• owner – a string containing an ERC address to identify the owner
• contract – a string identifying the contract
• chain – a string matching one of the following supported chains: “avalanche”, “bsc”, “eth”, “fanton”, “polygon”

This function will return an array of ETH NFTs that match the input parameters.

Array_Function_GetSolanaNfts

The GetSolanaNfts function requires one parameter:

• owner – a string containing a SOL address to identify the owner

This function will return an array of Solana NFTs for the given owner.

Array_Function_GetIdentities

The GetIdentities function requires two parameters:

• user – a string containing a VatomInc user id
• type – a string matching one of the following supported types of identity: “eth”, “sol”

This function will return an array of VatomInc identities that match the input parameters.

Array_Function_GetPoints

The GetPoints function accepts four parameters:

• user – a string containing a VatomInc user id
• business – a string containing a VatomInc user id
• campaign – a string containing a VatomInc user id
• channel – a string matching matching a channel id

This function will return an whole number point value based on the point total for given parameters. The fourth parameter, channel, is optional and if not specified, total points will be computed.

Array_Function_GetVatoms

The GetVatoms function accepts four parameters:

• user – a string containing a VatomInc user id
• business – a string containing a VatomInc user id
• campaign – a string containing a VatomInc user id
• objectDefinition – a string matching matching a channel id

This function will return an array of Vatoms matching the input parameters. Only the first parameter, user, is required. Any combination of the remaining three parameters can be optionally used as filters to narrow the results. If known, filters should be used since they enable optimizations delivering a faster response.

Credits

Grammar consistency testing and generation of images representing elements of the Allowl grammar were aided by Gunther Rademacher's open source Railroad Diagram Generator program. An online version is hosted at bottlecaps.de/rr/. The software was used with permission and according to its Apache License terms.