@ticketto/protocol/dist/esm/events/calls.d.ts

Library that defines the interfaces of the ticketto protocol to be implemented on a client

import type { AccountId, Event, EventId } from "@ticketto/types";
type EventReadonly = "id" | "organiser" | "date" | "state";
/**
 * Calls to interact with events module.
 */
export interface EventsCalls {
    /**
     * Creates a new event, to be owned by `owner`
     * @param owner The {@link AccountId} associated to the owner of the event.
     * @param event The details of the event to be created
     * @returns The {@link EventId} of the newly created event
     * @throws In case the event couldn't be created
     */
    createEvent(event: Omit<Event, EventReadonly>): Promise<EventId>;
    /**
     * Updates the information of an event.
     * @param id The {@link EventId} of the event to be updated
     * @param event The details of the event to update
     *
     * @throws An error in case the signer is not the organiser of the event, or the event
     * couldn't be updated, due to being on an invalid state.
     */
    update(id: EventId, event: Partial<Omit<Event, EventReadonly>>): Promise<void>;
    /**
     * Attempts to bump the current state of the event.
     *
     * @param id The {@link EventId} of the event to be bumped.
     * @throws In case the state transition is not possible, depending on the
     * rules defined by the .
     */
    bumpState(id: EventId): Promise<void>;
    /**
     * Sets the ownership on another account.
     * @param event The event to be created
     * @throws An error if the signer of the command is not the owner of the event
     */
    transferOrganiser(id: EventId, newOrganiser: AccountId): Promise<void>;
}
export {};