api.entities.Offering.types

@polymeshassociation/polymesh-sdk / api/entities/Offering/types

api/entities/Offering/types

Enumerations

OfferingBalanceStatus

Defined in: api/entities/Offering/types.ts:21

Enumeration Members

Available

Available: "Available"

Defined in: api/entities/Offering/types.ts:25

There still are Asset tokens available for purchase

Residual

Residual: "Residual"

Defined in: api/entities/Offering/types.ts:35

There are remaining Asset tokens, but their added value is lower than the Offering's minimum investment, so they cannot be purchased. The Offering should be manually closed to retrieve them

SoldOut

SoldOut: "SoldOut"

Defined in: api/entities/Offering/types.ts:29

All Asset tokens in the Offering have been sold

---

OfferingSaleStatus

Defined in: api/entities/Offering/types.ts:38

Enumeration Members

Closed

Closed: "Closed"

Defined in: api/entities/Offering/types.ts:54

Sale was manually closed after the end date was reached

ClosedEarly

ClosedEarly: "ClosedEarly"

Defined in: api/entities/Offering/types.ts:50

Sale was manually closed before the end date was reached

Frozen

Frozen: "Frozen"

Defined in: api/entities/Offering/types.ts:42

Sale temporarily paused, can be resumed (unfrozen)

Live

Live: "Live"

Defined in: api/entities/Offering/types.ts:46

Investments can be made

---

OfferingTimingStatus

Defined in: api/entities/Offering/types.ts:6

Enumeration Members

Expired

Expired: "Expired"

Defined in: api/entities/Offering/types.ts:18

End date reached

NotStarted

NotStarted: "NotStarted"

Defined in: api/entities/Offering/types.ts:10

Start date not reached yet

Started

Started: "Started"

Defined in: api/entities/Offering/types.ts:14

Between start and end date

Interfaces

Investment

Defined in: api/entities/Offering/types.ts:88

Properties

investedAmount

investedAmount: BigNumber

Defined in: api/entities/Offering/types.ts:91

investor

investor: Identity

Defined in: api/entities/Offering/types.ts:89

soldAmount

soldAmount: BigNumber

Defined in: api/entities/Offering/types.ts:90

---

OffChainFundingReceipt

Defined in: api/entities/Offering/types.ts:103

Properties

expiresAt

expiresAt: Date

Defined in: api/entities/Offering/types.ts:123

Timestamp at which the receipt expires

metadata

metadata: string | undefined

Defined in: api/entities/Offering/types.ts:119

(optional) Metadata value that can be used to attach messages to the receipt

signature

signature: OffChainSignature

Defined in: api/entities/Offering/types.ts:115

Signature confirming the receipt details

signer

signer: string | Account

Defined in: api/entities/Offering/types.ts:111

Signer of this receipt

uid

uid: BigNumber

Defined in: api/entities/Offering/types.ts:107

Unique receipt number set by the signer for their receipts

---

OfferingDetails

Defined in: api/entities/Offering/types.ts:72

Properties

creator

creator: Identity

Defined in: api/entities/Offering/types.ts:73

end

end: Date | null

Defined in: api/entities/Offering/types.ts:81

minInvestment

minInvestment: BigNumber

Defined in: api/entities/Offering/types.ts:83

name

name: string

Defined in: api/entities/Offering/types.ts:74

offeringPortfolio

offeringPortfolio: DefaultPortfolio | NumberedPortfolio

Defined in: api/entities/Offering/types.ts:75

raisingCurrency

raisingCurrency: string

Defined in: api/entities/Offering/types.ts:77

raisingPortfolio

raisingPortfolio: DefaultPortfolio | NumberedPortfolio

Defined in: api/entities/Offering/types.ts:76

start

start: Date

Defined in: api/entities/Offering/types.ts:80

status

status: OfferingStatus

Defined in: api/entities/Offering/types.ts:82

tiers

tiers: Tier[]

Defined in: api/entities/Offering/types.ts:78

totalAmount

totalAmount: BigNumber

Defined in: api/entities/Offering/types.ts:84

totalRemaining

totalRemaining: BigNumber

Defined in: api/entities/Offering/types.ts:85

venue

venue: Venue

Defined in: api/entities/Offering/types.ts:79

---

OfferingStatus

Defined in: api/entities/Offering/types.ts:57

Properties

balance

balance: OfferingBalanceStatus

Defined in: api/entities/Offering/types.ts:59

sale

sale: OfferingSaleStatus

Defined in: api/entities/Offering/types.ts:60

timing

timing: OfferingTimingStatus

Defined in: api/entities/Offering/types.ts:58

---

OfferingTier

Defined in: api/entities/Offering/types.ts:63

Extended by

• Tier

Properties

amount

amount: BigNumber

Defined in: api/entities/Offering/types.ts:64

price

price: BigNumber

Defined in: api/entities/Offering/types.ts:65

---

Tier

Defined in: api/entities/Offering/types.ts:68

Extends

• OfferingTier

Properties

amount

amount: BigNumber

Defined in: api/entities/Offering/types.ts:64

Inherited from

OfferingTier.amount

price

price: BigNumber

Defined in: api/entities/Offering/types.ts:65

Inherited from

OfferingTier.price

remaining

remaining: BigNumber

Defined in: api/entities/Offering/types.ts:69

Type Aliases

OffChainFundingDetails

OffChainFundingDetails = { enabled: false; } | { enabled: true; offChainTicker: string; }

Defined in: api/entities/Offering/types.ts:94