Skip to main content

Interface: TokenCreateRequest

Request object to create a token.

Properties​

access​

• Optional access: 0 | 1 | 2 | 3 | 4

Access type of the token

accessAwards​

• Optional accessAwards: any[]

Build5 id of the awards. If present only members with the given awards can purchase this token.

accessCollections​

• Optional accessCollections: any[]

Build5 id of the collections. If present only members having NFTs from the give collections can purchase this token.

allocations​

• Optional allocations: { isPublicSale?: boolean ; percentage: number ; title: string }[]

Token supply allocations.

autoProcessAt100Percent​

• Optional autoProcessAt100Percent: boolean

If true, purchases will be fullfilled once reuqest reach 100%.

coolDownLength​

• Optional coolDownLength: number

Length of the cool down period. Minimum 0, maximum 2678400000

decimals​

• decimals: number

Decimal value for the token. Minimum 0, maximum 20.

description​

• Optional description: string

Description of the token.

icon​

• Optional icon: string

Build5 url pointing to the token icon.

• Optional links: string[]

Usefull links for the token.

name​

• name: string

Name of the token.

overviewGraphics​

• Optional overviewGraphics: string

Build5 url pointing to the overview graphics of the token.

pricePerToken​

• Optional pricePerToken: number

Price per token. Minimum 0.000001, maximum 1000000000000.

saleLength​

• Optional saleLength: number

Length of the sale in milliseconds. Minimum 240000, maximum 2678400000

saleStartDate​

• Optional saleStartDate: Date

Starting date of the token sale. Has to be 7 days in the future.

shortDescription​

• Optional shortDescription: string

Short description of the token.

shortDescriptionTitle​

• Optional shortDescriptionTitle: string

Short description title of the token.

space​

• Optional space: string

Build5 id of the space.

symbol​

• symbol: string

Unique symbol of the token.

termsAndConditions​

• Optional termsAndConditions: string

Terms and conditions of the token.

title​

• Optional title: string

Title of the token.

totalSupply​

• totalSupply: number

Total token supply. Minimum 100, maximum 1e+26

tradingDisabled​

• Optional tradingDisabled: boolean

If true, trading is disabled for this token.