MinaTokensDashboard
Documentation

Auction

Suggest Edits

Class: Auction

Properties overview

  • auctioneer: PublicKey = PublicKey; ↗
  • auctionEndTime: UInt32 = UInt32; ↗
  • bidder: PublicKey = PublicKey; ↗
  • collection: PublicKey = PublicKey; ↗
  • isNFTtransferred: Bool = Bool; ↗
  • isNFTwithdrawn: Bool = Bool; ↗
  • isOwnerPaid: Bool = Bool; ↗
  • minimumPrice: UInt64 = UInt64; ↗
  • nft: PublicKey = PublicKey; ↗
  • owner: PublicKey = PublicKey; ↗
  • saleFee: UInt32 = UInt32; ↗
  • transferFee: UInt64 = UInt64; ↗
  • withdrawPeriod: UInt32 = UInt32; ↗

Methods overview

Defined in: packages/nft/src/marketplace/auction.ts:41

Extends

  • {
    auctioneer: PublicKey;
    auctionEndTime: UInt32;
    bidder: PublicKey;
    collection: PublicKey;
    isNFTtransferred: Bool;
    isNFTwithdrawn: Bool;
    isOwnerPaid: Bool;
    minimumPrice: UInt64;
    nft: PublicKey;
    owner: PublicKey;
    saleFee: UInt32;
    transferFee: UInt64;
    withdrawPeriod: UInt32;
    }

Constructors

new Auction()

new Auction(value: {
  auctioneer: PublicKey;
  auctionEndTime: UInt32;
  bidder: PublicKey;
  collection: PublicKey;
  isNFTtransferred: Bool;
  isNFTwithdrawn: Bool;
  isOwnerPaid: Bool;
  minimumPrice: UInt64;
  nft: PublicKey;
  owner: PublicKey;
  saleFee: UInt32;
  transferFee: UInt64;
  withdrawPeriod: UInt32;
 }): Auction

Defined in: node_modules/o1js/dist/node/lib/provable/types/struct.d.ts:103

Parameters

value
auctioneer

PublicKey = PublicKey

auctionEndTime

UInt32 = UInt32

bidder

PublicKey = PublicKey

collection

PublicKey = PublicKey

isNFTtransferred

Bool = Bool

isNFTwithdrawn

Bool = Bool

isOwnerPaid

Bool = Bool

minimumPrice

UInt64 = UInt64

nft

PublicKey = PublicKey

owner

PublicKey = PublicKey

saleFee

UInt32 = UInt32

The sale fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%).

transferFee

UInt64 = UInt64

withdrawPeriod

UInt32 = UInt32

Returns

Auction

Inherited from

Struct({
  owner: PublicKey,
  collection: PublicKey,
  nft: PublicKey,
  auctioneer: PublicKey,
  bidder: PublicKey,
  minimumPrice: UInt64,
  transferFee: UInt64,
  / The sale fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%). /
  saleFee: UInt32,
  auctionEndTime: UInt32,
  withdrawPeriod: UInt32, // in slots
  isOwnerPaid: Bool,
  isNFTtransferred: Bool,
  isNFTwithdrawn: Bool,
}).constructor

Properties

auctioneer

auctioneer: PublicKey = PublicKey;

Defined in: packages/nft/src/marketplace/auction.ts:45

Inherited from

Struct({
  owner: PublicKey,
  collection: PublicKey,
  nft: PublicKey,
  auctioneer: PublicKey,
  bidder: PublicKey,
  minimumPrice: UInt64,
  transferFee: UInt64,
  / The sale fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%). /
  saleFee: UInt32,
  auctionEndTime: UInt32,
  withdrawPeriod: UInt32, // in slots
  isOwnerPaid: Bool,
  isNFTtransferred: Bool,
  isNFTwithdrawn: Bool,
}).auctioneer

auctionEndTime

auctionEndTime: UInt32 = UInt32;

Defined in: packages/nft/src/marketplace/auction.ts:51

Inherited from

Struct({
  owner: PublicKey,
  collection: PublicKey,
  nft: PublicKey,
  auctioneer: PublicKey,
  bidder: PublicKey,
  minimumPrice: UInt64,
  transferFee: UInt64,
  / The sale fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%). /
  saleFee: UInt32,
  auctionEndTime: UInt32,
  withdrawPeriod: UInt32, // in slots
  isOwnerPaid: Bool,
  isNFTtransferred: Bool,
  isNFTwithdrawn: Bool,
}).auctionEndTime

bidder

bidder: PublicKey = PublicKey;

Defined in: packages/nft/src/marketplace/auction.ts:46

Inherited from

Struct({
  owner: PublicKey,
  collection: PublicKey,
  nft: PublicKey,
  auctioneer: PublicKey,
  bidder: PublicKey,
  minimumPrice: UInt64,
  transferFee: UInt64,
  / The sale fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%). /
  saleFee: UInt32,
  auctionEndTime: UInt32,
  withdrawPeriod: UInt32, // in slots
  isOwnerPaid: Bool,
  isNFTtransferred: Bool,
  isNFTwithdrawn: Bool,
}).bidder

collection

collection: PublicKey = PublicKey;

Defined in: packages/nft/src/marketplace/auction.ts:43

Inherited from

Struct({
  owner: PublicKey,
  collection: PublicKey,
  nft: PublicKey,
  auctioneer: PublicKey,
  bidder: PublicKey,
  minimumPrice: UInt64,
  transferFee: UInt64,
  / The sale fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%). /
  saleFee: UInt32,
  auctionEndTime: UInt32,
  withdrawPeriod: UInt32, // in slots
  isOwnerPaid: Bool,
  isNFTtransferred: Bool,
  isNFTwithdrawn: Bool,
}).collection

isNFTtransferred

isNFTtransferred: Bool = Bool;

Defined in: packages/nft/src/marketplace/auction.ts:54

Inherited from

Struct({
  owner: PublicKey,
  collection: PublicKey,
  nft: PublicKey,
  auctioneer: PublicKey,
  bidder: PublicKey,
  minimumPrice: UInt64,
  transferFee: UInt64,
  / The sale fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%). /
  saleFee: UInt32,
  auctionEndTime: UInt32,
  withdrawPeriod: UInt32, // in slots
  isOwnerPaid: Bool,
  isNFTtransferred: Bool,
  isNFTwithdrawn: Bool,
}).isNFTtransferred

isNFTwithdrawn

isNFTwithdrawn: Bool = Bool;

Defined in: packages/nft/src/marketplace/auction.ts:55

Inherited from

Struct({
  owner: PublicKey,
  collection: PublicKey,
  nft: PublicKey,
  auctioneer: PublicKey,
  bidder: PublicKey,
  minimumPrice: UInt64,
  transferFee: UInt64,
  / The sale fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%). /
  saleFee: UInt32,
  auctionEndTime: UInt32,
  withdrawPeriod: UInt32, // in slots
  isOwnerPaid: Bool,
  isNFTtransferred: Bool,
  isNFTwithdrawn: Bool,
}).isNFTwithdrawn

isOwnerPaid

isOwnerPaid: Bool = Bool;

Defined in: packages/nft/src/marketplace/auction.ts:53

Inherited from

Struct({
  owner: PublicKey,
  collection: PublicKey,
  nft: PublicKey,
  auctioneer: PublicKey,
  bidder: PublicKey,
  minimumPrice: UInt64,
  transferFee: UInt64,
  / The sale fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%). /
  saleFee: UInt32,
  auctionEndTime: UInt32,
  withdrawPeriod: UInt32, // in slots
  isOwnerPaid: Bool,
  isNFTtransferred: Bool,
  isNFTwithdrawn: Bool,
}).isOwnerPaid

minimumPrice

minimumPrice: UInt64 = UInt64;

Defined in: packages/nft/src/marketplace/auction.ts:47

Inherited from

Struct({
  owner: PublicKey,
  collection: PublicKey,
  nft: PublicKey,
  auctioneer: PublicKey,
  bidder: PublicKey,
  minimumPrice: UInt64,
  transferFee: UInt64,
  / The sale fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%). /
  saleFee: UInt32,
  auctionEndTime: UInt32,
  withdrawPeriod: UInt32, // in slots
  isOwnerPaid: Bool,
  isNFTtransferred: Bool,
  isNFTwithdrawn: Bool,
}).minimumPrice

nft

nft: PublicKey = PublicKey;

Defined in: packages/nft/src/marketplace/auction.ts:44

Inherited from

Struct({
  owner: PublicKey,
  collection: PublicKey,
  nft: PublicKey,
  auctioneer: PublicKey,
  bidder: PublicKey,
  minimumPrice: UInt64,
  transferFee: UInt64,
  / The sale fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%). /
  saleFee: UInt32,
  auctionEndTime: UInt32,
  withdrawPeriod: UInt32, // in slots
  isOwnerPaid: Bool,
  isNFTtransferred: Bool,
  isNFTwithdrawn: Bool,
}).nft

owner

owner: PublicKey = PublicKey;

Defined in: packages/nft/src/marketplace/auction.ts:42

Inherited from

Struct({
  owner: PublicKey,
  collection: PublicKey,
  nft: PublicKey,
  auctioneer: PublicKey,
  bidder: PublicKey,
  minimumPrice: UInt64,
  transferFee: UInt64,
  / The sale fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%). /
  saleFee: UInt32,
  auctionEndTime: UInt32,
  withdrawPeriod: UInt32, // in slots
  isOwnerPaid: Bool,
  isNFTtransferred: Bool,
  isNFTwithdrawn: Bool,
}).owner

saleFee

saleFee: UInt32 = UInt32;

Defined in: packages/nft/src/marketplace/auction.ts:50

The sale fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%).

Inherited from

Struct({
  owner: PublicKey,
  collection: PublicKey,
  nft: PublicKey,
  auctioneer: PublicKey,
  bidder: PublicKey,
  minimumPrice: UInt64,
  transferFee: UInt64,
  / The sale fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%). /
  saleFee: UInt32,
  auctionEndTime: UInt32,
  withdrawPeriod: UInt32, // in slots
  isOwnerPaid: Bool,
  isNFTtransferred: Bool,
  isNFTwithdrawn: Bool,
}).saleFee

transferFee

transferFee: UInt64 = UInt64;

Defined in: packages/nft/src/marketplace/auction.ts:48

Inherited from

Struct({
  owner: PublicKey,
  collection: PublicKey,
  nft: PublicKey,
  auctioneer: PublicKey,
  bidder: PublicKey,
  minimumPrice: UInt64,
  transferFee: UInt64,
  / The sale fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%). /
  saleFee: UInt32,
  auctionEndTime: UInt32,
  withdrawPeriod: UInt32, // in slots
  isOwnerPaid: Bool,
  isNFTtransferred: Bool,
  isNFTwithdrawn: Bool,
}).transferFee

withdrawPeriod

withdrawPeriod: UInt32 = UInt32;

Defined in: packages/nft/src/marketplace/auction.ts:52

Inherited from

Struct({
  owner: PublicKey,
  collection: PublicKey,
  nft: PublicKey,
  auctioneer: PublicKey,
  bidder: PublicKey,
  minimumPrice: UInt64,
  transferFee: UInt64,
  / The sale fee percentage (e.g., 1000 = 1%, 100 = 0.1%, 10000 = 10%, 100000 = 100%). /
  saleFee: UInt32,
  auctionEndTime: UInt32,
  withdrawPeriod: UInt32, // in slots
  isOwnerPaid: Bool,
  isNFTtransferred: Bool,
  isNFTwithdrawn: Bool,
}).withdrawPeriod

Methods

pack()

pack(): AuctionPacked

Defined in: packages/nft/src/marketplace/auction.ts:57

Returns

AuctionPacked

unpack()

static unpack(packed: AuctionPacked): Auction

Defined in: packages/nft/src/marketplace/auction.ts:82

Parameters

packed

AuctionPacked

Returns

Auction

Updated 10 days ago