Offering

Represents an Asset Offering in the Polymesh blockchain

Hierarchy

Index

Properties

Methods

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:

NameType

opts?

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: SubCallbackOfferingDetails›): Promise‹UnsubCallback

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

Parameters:

NameType

callback

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‹TransactionQueueOffering››

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:

NameType

opts?

Returns: Promise‹TransactionQueueOffering››


getInvestments

getInvestments(opts: object): Promise‹ResultSetInvestment››

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= {}

NameTypeDescription

size?

BigNumber

page size

start?

BigNumber

page offset

Returns: Promise‹ResultSetInvestment››


getInvestmentsV2

getInvestmentsV2(opts: object): Promise‹ResultSetInvestment››

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= {}

NameTypeDescription

size?

BigNumber

page size

start?

BigNumber

page offset

Returns: Promise‹ResultSetInvestment››


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:

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:

NameType

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:

NameType

args

ModifyStoTimesParams

opts?

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‹TransactionQueueOffering››

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:

NameType

opts?

Returns: Promise‹TransactionQueueOffering››


Static generateUuid

generateUuidIdentifiers›(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:

NameTypeDescription

identifiers

Identifiers

Returns: string


Static unserialize

unserializeIdentifiers›(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:

NameTypeDescription

serialized

string

UUID to unserialize

Returns: Identifiers

Last updated