Class Attendify

Attendify is an utility library for the Proof of Attendance infrastructure on the XRPL.

Hierarchy

  • Attendify

Constructors

constructor

Methods

addParticipant addParticipants calcDepositValues cancelEvent checkAccountExists checkAuthorizedMinter checkNFTOwnership checkOwnerReserve checkPayment checkSellOffer closeEvent createEvent createSellOffer fetchNFTs getClaim getEvent getEventsAll getEventsExpired getEventsFiltered getEventsOwned getMinterStatus getNetworkConfig getOffers getOrganizers getStats getUser getUsers init isReady mintEvent prepareTickets refundDeposit scanTransactionHistory updateUser

Constructors

constructor

Properties

Private maxTickets

maxTickets: number

Private networkConfigs

networkConfigs: NetworkConfig[]

Private nextEventId

nextEventId: number

Private ready

ready: boolean

Methods

addParticipant

  • Add a single participant to an existing event

    Parameters

    • eventId: number

      event identifier

    • walletAddress: string

      wallet address of the new participant

    • createOffer: boolean

      immediately create an NFT sell offer

    • checkIsManaged: boolean

      validate whether the event is managed, restrict access accordingly

    Returns Promise<Record<string, any>>

addParticipants

  • Add several participants to an existing event

    Parameters

    • eventId: number

      event identifier

    • walletAddress: string

      event owner wallet address

    • attendeeWalletAddresses: string[]

      list of wallet addresses of new participants

    • createOffer: boolean

      immediately create an NFT sell offer

    Returns Promise<void>

calcDepositValues

  • Calculate the deposit value in drops for an event

    Parameters

    Returns Promise<[bigint, bigint]>

    deposit requirements

cancelEvent

  • Cancel an event

    Parameters

    • eventId: number

      event identifier

    Returns Promise<void>

checkAccountExists

  • Check if an account exists on a particular network

    Parameters

    • networkId: NetworkIdentifier

      network identifier

    • walletAddress: string

      account wallet address

    Returns Promise<boolean>

    true, if the ledger account exists

checkAuthorizedMinter

  • Check if an account has set the platform as authorized minter

    Parameters

    • networkId: NetworkIdentifier

      network identifier

    • walletAddress: string

      account wallet address

    Returns Promise<boolean>

    true, if the minter is configured correctly

checkNFTOwnership

  • Check in the ledger if an account owns an NFT of an event

    Parameters

    • networkId: NetworkIdentifier

      network identifier

    • walletAddress: string

      account wallet address

    • ownerWalletAddress: string

      issuer wallet address

    • eventId: number

      event identifier (NFT taxon)

    Returns Promise<boolean>

    true, if the account is a legit participant

checkOwnerReserve

  • Check if the vault account has enough balance to create N ledger objects

    Parameters

    Returns Promise<[bigint, bigint, boolean]>

    reserve and balance info

checkPayment

  • Verify an event deposit transaction

    Parameters

    Returns Promise<boolean>

    true, if the payment was successful

checkSellOffer

  • Check if an NFT sell offer exists on chain

    Parameters

    • networkId: NetworkIdentifier

      network identifier

    • tokenId: string

      NFT identifier

    • offerIndex: string

      NFT sell offer index

    Returns Promise<boolean>

    true, if sell offer exists

closeEvent

createEvent

  • Create a new event

    Parameters

    • networkId: NetworkIdentifier

      network identifier

    • walletAddress: string

      event owner wallet address

    • metadata: Metadata

      event information/details

    • isManaged: boolean

      event signup permissions

    Returns Promise<number>

    new event id

createSellOffer

  • Create a sell offer for an NFT

    Parameters

    • networkId: NetworkIdentifier

      network identifier

    • eventId: number

      event identifier

    • walletAddress: string

      recipient wallet address (offer can only be accepted by this account)

    • tokenId: string

      NFT identifier

    Returns Promise<[string, bigint]>

    sell offer index and tx fee costs

fetchNFTs

  • Find all NFTs owned by a particular account

    Parameters

    • networkId: NetworkIdentifier

      network identifier

    • walletAddress: string

      request wallet address

    • Optional taxon: number

      optional filter

    Returns Promise<string[]>

    array of token identifier

getClaim

  • Fetch an NFT offer for a specific event from the database

    Parameters

    • walletAddress: string

      request wallet address

    • eventId: number

      event identifier

    Returns Promise<null | Record<string, any>>

    offer json object

getEvent

  • Fetch a specific event from the database

    Parameters

    • eventId: number

      event identifier

    • wasMasked: boolean

      whether the request used a masked id

    • Optional walletAddress: string

      optional request wallet address to filter results depending on access level

    Returns Promise<undefined | Record<string, any>>

    event json object (details depend on access level)

getEventsAll

  • Fetch all events from the database

    Parameters

    • networkId: NetworkIdentifier

      network identifier

    • limit: number = 100

      maximum number of returned results

    Returns Promise<Record<string, any>[]>

    list of event json objects

getEventsExpired

  • Fetch active events that have ended (used by daemon)

    Parameters

    • networkId: NetworkIdentifier

      network identifier

    • Optional walletAddress: string

      optionally filter by owner wallet address

    Returns Promise<Record<string, any>[]>

    list of event json objects

getEventsFiltered

  • Fetch specific events (used by daemon)

    Parameters

    • networkId: NetworkIdentifier

      network identifier

    • Optional status: EventStatus

      optionally filter by status

    • Optional walletAddress: string

      optionally filter by owner wallet address

    Returns Promise<Record<string, any>[]>

    list of event json objects

getEventsOwned

  • Fetch user owned events from the database

    Parameters

    • networkId: NetworkIdentifier

      network identifier

    • walletAddress: string

      wallet address of the user

    • limit: number = 100

      maximum number of returned results

    Returns Promise<Record<string, any>[]>

    list of event json objects

getMinterStatus

  • Fetch authorized minter status for an account

    Parameters

    • networkId: NetworkIdentifier

      network identifier

    • walletAddress: string

      account wallet address

    Returns Promise<[string, boolean]>

    status info

getNetworkConfig

  • Get the configuration for a specific network

    Parameters

    Returns [Client, Wallet]

    fresh wallet and client instance for a network

getOffers

  • Fetch NFT offers associated with a user from the database

    Parameters

    • networkId: NetworkIdentifier

      network identifier

    • walletAddress: string

      wallet address of the user

    • limit: number = 100

      maximum number of returned results

    Returns Promise<Record<string, any>[]>

    list of offer json objects (including associated event info)

getOrganizers

  • Fetch a list of all organizers

    Parameters

    Returns Promise<Record<string, any>[]>

    list of user json objects

getStats

getUser

  • Fetch a specific user from the database

    Parameters

    • walletAddress: string

      wallet address of the user

    • includeEvents: boolean

      include a list of events the user is attending

    • allowCreation: boolean

      create new user, if it doesn't exist

    • isOrganizer: boolean

      when creating a new user, add organizer permissions

    Returns Promise<undefined | Record<string, any>>

    • user json object

getUsers

  • Fetch a list of all users

    Parameters

    Returns Promise<Record<string, any>[]>

    list of user json objects

init

  • Initializes a new instance of the Attendify class. This MUST be called before using the library.

    Returns Promise<void>

isReady

mintEvent

  • Pre-mint NFTs for a pending event

    Parameters

    • eventId: number

      event identifier

    Returns Promise<void>

prepareTickets

  • Prepare ledger Ticket objects for NFT batch minting

    Parameters

    • networkId: NetworkIdentifier

      network identifier

    • target: number

      number of tickets that should be set up

    Returns Promise<[number[], bigint]>

    array of at least target ticket sequence numbers and tx fee costs

refundDeposit

  • Refund event deposit

    Parameters

    • eventId: number

      event identifier

    Returns Promise<null | string>

    tx hash

scanTransactionHistory

  • Scan vault account history for payment transactions (used by daemon)

    Parameters

    Returns Promise<void>

updateUser

  • Update a specific user in the database

    Parameters

    • walletAddress: string

      wallet address of the user

    • firstName: null | string

      optional first name

    • lastName: null | string

      optional last name

    • email: null | string

      optional email address

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc