Offerings
Last updated
Was this helpful?
Last updated
Was this helpful?
Handles all Security Token Offering related functionality
Namespace‹›
↳ Offerings
Protected
contextInherited from void
Launch a Security Token Offering
param
portfolio in which the Tokens to be sold are stored (optional, defaults to the default portfolio of the Security Token's Primary Issuance Agent)
param
portfolio in which the raised funds will be stored
param
ticker symbol of the currency in which the funds are being raised (i.e. 'USD' or 'CAD'). Other Security Tokens can be used as currency as well
param
venue through which all offering related trades will be settled (optional, defaults to the first Sto
type Venue owned by the owner of the Offering Portfolio. If passed, it must be of type Sto
)
param
start date of the Offering (optional, defaults to right now)
param
end date of the Offering (optional, defaults to never)
param
array of sale tiers. Each tier consists of an amount of Tokens to be sold at a certain price. Tokens in a tier can only be bought when all Tokens in previous tiers have been bought
param
minimum amount that can be spent on this offering
note
required roles:
Security Token Primary Issuance Agent
Offering Portfolio Custodian
Raising Portfolio Custodian
Protected
parentInherited from void
Retrieve all of the Token's Offerings. Can be filtered using parameters
Parameters:
▪Default value
opts: object= {}
Name
Type
Description
status?
status of the offerings to fetch. If defined, only STOs that have all passed statuses will be returned
• context:
Defined in
• launch: ProcedureMethod‹LaunchStoParams, ›
Defined in
• parent:
Defined in
▸ get(opts
: object): Promise‹[]›
Defined in
Partial‹›
Returns: Promise‹[]›