Offering

Represents an Asset Offering in the Polymesh blockchain

Hierarchy

• Entity‹UniqueIdentifiers, HumanReadable›

  ↳ Offering

Index

Properties

• asset

• context

• id

• uuid

Methods

• close

• details

• exists

• freeze

• getInvestments

• getInvestmentsV2

• invest

• isEqual

• modifyTimes

• toHuman

• unfreeze

• generateUuid

• unserialize

Properties

asset

• asset: Asset

Defined in src/api/entities/Offering/index.ts:68

Asset being offered

---

Protected context

• context: Context

Inherited from CheckpointSchedule.context

Defined in src/api/entities/Entity.ts:48

---

id

• id: BigNumber

Defined in src/api/entities/Offering/index.ts:63

identifier number of the Offering

---

uuid

• uuid: string

Inherited from CheckpointSchedule.uuid

Defined in src/api/entities/Entity.ts:46

Methods

close

▸ close(opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/Offering/index.ts:161

Close the Offering

note this method is of type NoArgsProcedureMethod, which means you can call close.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name	Type
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

---

details

▸ details(): Promise‹OfferingDetails›

Defined in src/api/entities/Offering/index.ts:114

Retrieve the Offering's details

note can be subscribed to

Returns: Promise‹OfferingDetails›

▸ details(callback: SubCallback‹OfferingDetails›): Promise‹UnsubCallback›

Defined in src/api/entities/Offering/index.ts:115

Parameters:

Name	Type
callback	SubCallback‹OfferingDetails›

Returns: Promise‹UnsubCallback›

---

exists

▸ exists(): Promise‹boolean›

Overrides Entity.exists

Defined in src/api/entities/Offering/index.ts:335

Determine whether this Offering exists on chain

Returns: Promise‹boolean›

---

freeze

▸ freeze(opts?: ProcedureOpts): Promise‹TransactionQueue‹Offering››

Defined in src/api/entities/Offering/index.ts:171

Freeze the Offering

note this method is of type NoArgsProcedureMethod, which means you can call freeze.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name	Type
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹Offering››

---

getInvestments

▸ getInvestments(opts: object): Promise‹ResultSet‹Investment››

Defined in src/api/entities/Offering/index.ts:223

Retrieve all investments made on this Offering

note supports pagination

note uses the middleware

Parameters:

▪Default value opts: object= {}

Name	Type	Description
size?	BigNumber	page size
start?	BigNumber	page offset

Returns: Promise‹ResultSet‹Investment››

---

getInvestmentsV2

▸ getInvestmentsV2(opts: object): Promise‹ResultSet‹Investment››

Defined in src/api/entities/Offering/index.ts:286

Retrieve all investments made on this Offering

note supports pagination

note uses the middleware V2

Parameters:

▪Default value opts: object= {}

Name	Type	Description
size?	BigNumber	page size
start?	BigNumber	page offset

Returns: Promise‹ResultSet‹Investment››

---

invest

▸ invest(args: InvestInOfferingParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/Offering/index.ts:210

Invest in the Offering

note required roles:

• Purchase Portfolio Custodian

• Funding Portfolio Custodian

note this method is of type ProcedureMethod, which means you can call invest.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name	Type
args	InvestInOfferingParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

---

isEqual

▸ isEqual(entity: Entity‹unknown, unknown›): boolean

Inherited from CheckpointSchedule.isEqual

Defined in src/api/entities/Entity.ts:61

Determine whether this Entity is the same as another one

Parameters:

Name	Type
entity	Entity‹unknown, unknown›

Returns: boolean

---

modifyTimes

▸ modifyTimes(args: ModifyStoTimesParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/Offering/index.ts:196

Modify the start/end time of the Offering

throws if:

• Trying to modify the start time on an Offering that already started

• Trying to modify anything on an Offering that already ended

• Trying to change start or end time to a past date

note this method is of type ProcedureMethod, which means you can call modifyTimes.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name	Type
args	ModifyStoTimesParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››

---

toHuman

▸ toHuman(): HumanReadable

Overrides Entity.toHuman

Defined in src/api/entities/Offering/index.ts:353

Return the Offering's ID and Asset ticker

Returns: HumanReadable

---

unfreeze

▸ unfreeze(opts?: ProcedureOpts): Promise‹TransactionQueue‹Offering››

Defined in src/api/entities/Offering/index.ts:181

Unfreeze the Offering

note this method is of type NoArgsProcedureMethod, which means you can call unfreeze.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Parameters:

Name	Type
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹Offering››

---

Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Inherited from CheckpointSchedule.generateUuid

Defined in src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type parameters:

▪ Identifiers

Parameters:

Name	Type	Description
identifiers	Identifiers

Returns: string

---

Static unserialize

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Inherited from CheckpointSchedule.unserialize

Defined in src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type parameters:

▪ Identifiers

Parameters:

Name	Type	Description
serialized	string	UUID to unserialize

Returns: Identifiers