Class KioskClient

constructor

• new KioskClient(options): KioskClient

• Parameters

  • options: KioskClientOptions

  Returns KioskClient

client

network

OptionalpackageIds

rules

addRuleResolver

• addRuleResolver(rule): void

• Parameters

  • rule: TransferPolicyRule

  Returns void

getKiosk

• getKiosk(__namedParameters): Promise<KioskData>

• Fetches the kiosk contents.

  Parameters

  • __namedParameters: {
        id: string;
        options?: FetchKioskOptions;
    }

    • id: string

    • Optionaloptions?: FetchKioskOptions

  Returns Promise<KioskData>

getKioskExtension

• getKioskExtension(__namedParameters): Promise<null | KioskExtension>

• Fetch the extension data (if any) for a kiosk, by type

  Parameters

  • __namedParameters: {
        kioskId: string;
        type: string;
    }

    • kioskId: string

    • type: string

  Returns Promise<null | KioskExtension>

getOwnedKiosks

• getOwnedKiosks(__namedParameters): Promise<OwnedKiosks>

• Get an addresses's owned kiosks.

  Parameters

  • __namedParameters: {
        address: string;
        pagination?: PaginationArguments<string>;
    }

    • address: string

    • Optionalpagination?: PaginationArguments<string>

  Returns Promise<OwnedKiosks>

  An Object containing all the kioskOwnerCap objects as well as the kioskIds.

getOwnedTransferPolicies

• getOwnedTransferPolicies(address): Promise<undefined | TransferPolicyCap[]>

• Query all the owned transfer policies for an address. Returns TransferPolicyCap which uncludes policyId, policyCapId, type.

  Parameters

  • address: {
        address: string;
    }

    The address we're searching the owned transfer policies for.

    • address: string

  Returns Promise<undefined | TransferPolicyCap[]>

getOwnedTransferPoliciesByType

• getOwnedTransferPoliciesByType(__namedParameters): Promise<TransferPolicyCap[]>

• Query the Transfer Policy Cap for type T, owned by address

  Parameters

  • __namedParameters: {
        address: string;
        type: string;
    }

    • address: string

    • type: string

  Returns Promise<TransferPolicyCap[]>

getRulePackageId

• getRulePackageId(rule): string

• A convenient helper to get the packageIds for our supported ruleset, based on kioskClient configuration.

  Parameters

  • rule:
        | "royaltyRulePackageId"
        | "kioskLockRulePackageId"
        | "personalKioskRulePackageId"
        | "floorPriceRulePackageId"

  Returns string

getTransferPolicies

• getTransferPolicies(type): Promise<TransferPolicy[]>

• Query the Transfer Policy(ies) for type T.

  Parameters

  • type: {
        type: string;
    }

    The Type we're querying for (E.g 0xMyAddress::hero::Hero)

    • type: string

  Returns Promise<TransferPolicy[]>