Class KioskTransaction

constructor

• new KioskTransaction(
      __namedParameters: KioskTransactionParams,
  ): KioskTransaction

  Parameters

  • __namedParameters: KioskTransactionParams

  Returns KioskTransaction

Optionalkiosk

OptionalkioskCap

kioskClient

transaction

borrow

• borrow(__namedParameters: ItemId): [TransactionArgument, TransactionArgument]

  Borrows an item from the kiosk. This will fail if the item is listed for sale.

  Requires calling return.

  Parameters

  • __namedParameters: ItemId

  Returns [TransactionArgument, TransactionArgument]

borrowTx

• borrowTx(
      __namedParameters: ItemId,
      callback: (item: TransactionArgument) => void,
  ): void

  A function to borrow an item from a kiosk & execute any function with it. Example: You could borrow a Fren out of a kiosk, attach an accessory (or mix), and return it.

  Parameters

  • __namedParameters: ItemId
  • callback: (item: TransactionArgument) => void

  Returns void

convertToPersonal

• convertToPersonal(borrow?: boolean): KioskTransaction

  Converts a kiosk to a Personal (Soulbound) Kiosk. Requires initialization by either calling ktxb.create() or ktxb.setCap().

  Parameters

  • Optionalborrow: boolean

  Returns KioskTransaction

create

• create(): KioskTransaction

  Creates a kiosk and saves kiosk and kioskOwnerCap in state. Helpful if we want to chain some actions before sharing + transferring the cap to the specified address.

  Returns KioskTransaction

createAndShare

• createAndShare(address: string): void

  Single function way to create a kiosk, share it and transfer the cap to the specified address.

  Parameters

  • address: string

  Returns void

createPersonal

• createPersonal(borrow?: boolean): KioskTransaction

  Creates a personal kiosk & shares it. The PersonalKioskCap is transferred to the signer.

  Parameters

  • Optionalborrow: boolean

    If true, the kioskOwnerCap is borrowed from the PersonalKioskCap to be used in next transactions.

  Returns KioskTransaction

delist

• delist(__namedParameters: ItemId): KioskTransaction

  A function to delist an item from the kiosk.

  Parameters

  • __namedParameters: ItemId

  Returns KioskTransaction

finalize

• finalize(): void

  A function that ends up the kiosk building tx & returns the kioskOwnerCap back to the PersonalKioskCap, in case we are operating on a personal kiosk. It will also share the kiosk if it's not shared, and finalize the transfer of the personal cap if it's pending.

  Returns void

getKiosk

• getKiosk(): TransactionObjectArgument

  Returns TransactionObjectArgument

getKioskCap

• getKioskCap(): TransactionObjectArgument

  Returns TransactionObjectArgument

list

• list(__namedParameters: ItemId & { price: string | bigint }): KioskTransaction

  A function to list an item in the kiosk.

  Parameters

  • __namedParameters: ItemId & { price: string | bigint }

  Returns KioskTransaction

lock

• lock(
      __namedParameters: ItemReference & {
          itemId?: string;
          policy: ObjectArgument;
      },
  ): KioskTransaction

  A function to take lock an item in the kiosk.

  Parameters

  • __namedParameters: ItemReference & { itemId?: string; policy: ObjectArgument }

  Returns KioskTransaction

place

• place(__namedParameters: ItemReference): KioskTransaction

  A function to place an item in the kiosk.

  Parameters

  • __namedParameters: ItemReference

  Returns KioskTransaction

placeAndList

• placeAndList(__namedParameters: ItemReference & Price): KioskTransaction

  A function to place an item in the kiosk and list it for sale in one transaction.

  Parameters

  • __namedParameters: ItemReference & Price

  Returns KioskTransaction

purchase

• purchase(
      __namedParameters: ItemId & Price & { sellerKiosk: ObjectArgument },
  ): [TransactionObjectArgument, TransactionObjectArgument]

  Purchase an item from a seller's kiosk. Returns [item, transferRequest] Can be called like: const [item, transferRequest] = kioskTx.purchase({...})

  Parameters

  • __namedParameters: ItemId & Price & { sellerKiosk: ObjectArgument }

  Returns [TransactionObjectArgument, TransactionObjectArgument]

purchaseAndResolve

• purchaseAndResolve(
      __namedParameters: ItemId & Price & { sellerKiosk: ObjectArgument } & PurchaseOptions,
  ): Promise<KioskTransaction>

  A function to purchase and resolve a transfer policy. If the transfer policy has the lock rule, the item is locked in the kiosk. Otherwise, the item is placed in the kiosk.

  Parameters

  • __namedParameters: ItemId & Price & { sellerKiosk: ObjectArgument } & PurchaseOptions

  Returns Promise<KioskTransaction>

return

• return(
      __namedParameters: ItemValue & { promise: TransactionArgument },
  ): KioskTransaction

  Returns the item back to the kiosk. Accepts the parameters returned from the borrow function.

  Parameters

  • __namedParameters: ItemValue & { promise: TransactionArgument }

  Returns KioskTransaction

setCap

• setCap(cap: KioskOwnerCap): undefined | KioskTransaction

  A function to setup the client using an existing ownerCap, as return from the kioskClient.getOwnedKiosks function.

  Parameters

  • cap: KioskOwnerCap

    KioskOwnerCap object as returned from getOwnedKiosks SDK call.

  Returns undefined | KioskTransaction

setKiosk

• setKiosk(kiosk: TransactionObjectArgument): KioskTransaction

  Parameters

  • kiosk: TransactionObjectArgument

  Returns KioskTransaction

setKioskCap

• setKioskCap(cap: TransactionObjectArgument): KioskTransaction

  Parameters

  • cap: TransactionObjectArgument

  Returns KioskTransaction

share

• share(): void

  Shares the kiosk.

  Returns void

shareAndTransferCap

• shareAndTransferCap(address: string): void

  Should be called only after create is called. It shares the kiosk & transfers the cap to the specified address.

  Parameters

  • address: string

  Returns void

take

• take(__namedParameters: ItemId): TransactionObjectArgument

  A function to take an item from the kiosk. The transaction won't succeed if the item is listed or locked.

  Parameters

  • __namedParameters: ItemId

  Returns TransactionObjectArgument

transfer

• transfer(__namedParameters: ItemId & { address: string }): KioskTransaction

  Transfer a non-locked/non-listed item to an address.

  Parameters

  • __namedParameters: ItemId & { address: string }

  Returns KioskTransaction

withdraw

• withdraw(address: string, amount?: string | number | bigint): KioskTransaction

  A function to withdraw from kiosk

  Parameters

  • address: string

    Where to trasnfer the coin.
  • Optionalamount: string | number | bigint

    The amount we aim to withdraw.

  Returns KioskTransaction