Class KioskClient

constructor

• new KioskClient(options: KioskClientOptions): KioskClient

  Parameters

  • options: KioskClientOptions

  Returns KioskClient

client

network

OptionalpackageIds

rules

addRuleResolver

• addRuleResolver(rule: TransferPolicyRule): void

  Parameters

  • rule: TransferPolicyRule

  Returns void

getKiosk

• getKiosk(id: { id: string; options?: FetchKioskOptions }): Promise<KioskData>

  Fetches the kiosk contents.

  Parameters

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

    The ID of the kiosk to fetch.

  Returns Promise<KioskData>

getKioskExtension

• getKioskExtension(
      kioskId: { kioskId: string; type: string },
  ): Promise<KioskExtension | null>

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

  Parameters

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

    The ID of the kiosk to lookup

  Returns Promise<KioskExtension | null>

getOwnedKiosks

• getOwnedKiosks(
      address: { address: string; pagination?: PaginationArguments<string> },
  ): Promise<OwnedKiosks>

  Get an addresses's owned kiosks.

  Parameters

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

    The address for which we want to retrieve the kiosks.

  Returns Promise<OwnedKiosks>

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

getOwnedTransferPolicies

• getOwnedTransferPolicies(
      address: { address: string },
  ): Promise<TransferPolicyCap[] | undefined>

  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.

  Returns Promise<TransferPolicyCap[] | undefined>

getOwnedTransferPoliciesByType

• getOwnedTransferPoliciesByType(
      type: { address: string; type: string },
  ): Promise<TransferPolicyCap[]>

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

  Parameters

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

    The Type T for the object

  Returns Promise<TransferPolicyCap[]>

getRulePackageId

• getRulePackageId(
      rule:
          | "royaltyRulePackageId"
          | "kioskLockRulePackageId"
          | "personalKioskRulePackageId"
          | "floorPriceRulePackageId",
  ): 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: { type: string }): 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)

  Returns Promise<TransferPolicy[]>