IDO | @senswap/sen-js

Hierarchy

Tx
- IDO

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new IDO(idoProgramAddress?: string, spltProgramAddress?: string, splataProgramAddress?: string, nodeUrl: string): IDO

Overrides Tx.constructor
- Defined in ido.ts:52
Parameters
- idoProgramAddress: string = ...
- spltProgramAddress: string = ...
- splataProgramAddress: string = ...
- nodeUrl: string
Returns IDO

Properties

connection

connection: Connection

idoProgramId

idoProgramId: PublicKey

nodeUrl

nodeUrl: string

splataProgramId

splataProgramId: PublicKey

spltProgramId

spltProgramId: PublicKey

Methods

collect

collect(amount: bigint, idoAddress: string, wallet: WalletInterface): Promise<{ dstAddress: string; txId: string }>

- Defined in ido.ts:818
Collect being-raised tokens from the pool (The action must be done after the IDO ends)

remarks

IDO owner only

Parameters
- amount: bigint
  
  The collected amount of being-raised tokens
- idoAddress: string
  
  IDO address
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ dstAddress: string; txId: string }>

Transaction hash txId and the associated address dstAddress that receives the being-sold tokens

deriveTicketAddress

deriveTicketAddress(ownerAddress: string, idoAddress: string): Promise<string>

- Defined in ido.ts:190
Derive ticket address

Parameters
- ownerAddress: string
  
  Owner address of the ticket account
- idoAddress: string
  
  Corresponding ido address to the ticket account
Returns Promise<string>

Ticket account address

getIDOData

getIDOData(idoAddress: string): Promise<IDOData>

- Defined in ido.ts:149
Get ido data

Parameters
- idoAddress: string
  
  IDO account address
Returns Promise<IDOData>

Readable json data respect to FARM_SCHEMA

getTicketData

getTicketData(ticketAddress: string): Promise<TicketData>

- Defined in ido.ts:174
Get ticket data

Parameters
- ticketAddress: string
  
  Ticket account address
Returns Promise<TicketData>

Readable json data respect to FARM_SCHEMA

initializeIDO

initializeIDO(amount: bigint, startdate: bigint, middledate: bigint, enddate: bigint, redeemdate: bigint, soldMintAddress: string, raisedMintAddress: string, wallet: WalletInterface): Promise<{ idoAddress: string; txId: string }>

- Defined in ido.ts:223
Initialize an IDO

Parameters
- amount: bigint
  
  The number of being-sold tokens in the IDO
- startdate: bigint
  
  Start date of IDO
- middledate: bigint
  
  The end of phase #1 and start of phase #2
- enddate: bigint
  
  -End of the IDO
- redeemdate: bigint
  
  The unlock date that users can redeem the being-sold tokens
- soldMintAddress: string
  
  Mint address for selling
- raisedMintAddress: string
  
  Mint address for raising
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ idoAddress: string; txId: string }>

Transaction hash txId and IDO address idoAddress

initializeTicket

initializeTicket(idoAddress: string, wallet: WalletInterface): Promise<{ ticketAddress: string; txId: string }>

- Defined in ido.ts:331
Initialize a ticket

Parameters
- idoAddress: string
  
  IDO address
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ ticketAddress: string; txId: string }>

Transaction hash txId and ticket address ticketAddress

parseIDOData

parseIDOData(data: Buffer): IDOData

- Defined in ido.ts:137
Parse ido buffer data

Parameters
- data: Buffer
  
  Buffer data (raw data) that you get by connection.getAccountInfo
Returns IDOData

Readable json data respect to FARM_SCHEMA

parseTicketData

parseTicketData(data: Buffer): TicketData

- Defined in ido.ts:162
Parse ticket buffer data

Parameters
- data: Buffer
  
  Buffer data (raw data) that you get by connection.getAccountInfo
Returns TicketData

Readable json data respect to FARM_SCHEMA

redeem

redeem(idoAddress: string, wallet: WalletInterface): Promise<{ dstAddress: string; txId: string }>

- Defined in ido.ts:568
Redeem being-sold tokens from the pool (The action must be done after the IDO ends)

Parameters
- idoAddress: string
  
  IDO address
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ dstAddress: string; txId: string }>

Transaction hash txId and the associated address dstAddress that receives the being-sold tokens

seed

seed(amount: bigint, idoAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in ido.ts:663
Seed more being-sold tokens into the pool (The action must be done before the IDO starts)

remarks

IDO owner only

Parameters
- amount: bigint
  
  Additional amount
- idoAddress: string
  
  IDO address
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ txId: string }>

Transaction hash txId

stake

stake(amount: bigint, idoAddress: string, wallet: WalletInterface): Promise<{ ticketAddress: string; txId: string }>

- Defined in ido.ts:385
Stake being-raised tokens into the pool (The action must be done during the phase #1 of the IDO only)

Parameters
- amount: bigint
  
  Additional amount
- idoAddress: string
  
  IDO address
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ ticketAddress: string; txId: string }>

Transaction hash txId and ticket address ticketAddress

transferIDOOwnership

transferIDOOwnership(idoAddress: string, newOwnerAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in ido.ts:904
Transfer ido's ownership

remarks

IDO owner only

Parameters
- idoAddress: string
  
  IDO address
- newOwnerAddress: string
  
  New owner address
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ txId: string }>

Transaction hash txId

unseed

unseed(amount: bigint, idoAddress: string, wallet: WalletInterface): Promise<{ txId: string }>

- Defined in ido.ts:737
Unseed less being-sold tokens from the pool (The action must be done before the IDO starts)

remarks

IDO owner only

Parameters
- amount: bigint
  
  Subtractive amount
- idoAddress: string
  
  IDO address
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ txId: string }>

Transaction hash txId

unstake

unstake(amount: bigint, idoAddress: string, wallet: WalletInterface): Promise<{ ticketAddress: string; txId: string }>

- Defined in ido.ts:477
Unstake being-raised tokens from the pool (The action must be done during both the phase #1 and #2 of the IDO)

Parameters
- amount: bigint
  
  Subtractive amount
- idoAddress: string
  
  IDO address
- wallet: WalletInterface
  
  Wallet instance
Returns Promise<{ ticketAddress: string; txId: string }>

Transaction hash txId and ticket address ticketAddress

unwatch

unwatch(watchId: number): Promise<void>

- Defined in ido.ts:127
Unwatch a watcher by watch id

Parameters
- watchId: number
  
  The watchId was returned by watch function.
Returns Promise<void>

watch

watch(callback: (error: null | string, data: null | (Omit<IDOAccountChangeInfo, "data"> & { data: IDOData | TicketData })) => void, filters?: GetProgramAccountsFilter[]): number

- Defined in ido.ts:79
Watch account changes

Parameters
- callback: (error: null | string, data: null | (Omit<IDOAccountChangeInfo, "data"> & { data: IDOData | TicketData })) => void
  
  The callback will be called when there is any change
  - - (error: null | string, data: null | (Omit<IDOAccountChangeInfo, "data"> & { data: IDOData | TicketData })): void
    - Parameters
      - error: null | string
      - data: null | (Omit<IDOAccountChangeInfo, "data"> & { data: IDOData | TicketData })
      Returns void
- Optional filters: GetProgramAccountsFilter[]
  
  GetProgramAccountsFilter - Ref: https://solana-labs.github.io/solana-web3.js/modules.html#GetProgramAccountsFilter
Returns number

Watch id

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

idoProgramAddress: string = ...

spltProgramAddress: string = ...

splataProgramAddress: string = ...

nodeUrl: string

Returns IDO

Properties

connection

idoProgramId

nodeUrl

splataProgramId

spltProgramId

Methods

collect

Parameters

amount: bigint

idoAddress: string

wallet: WalletInterface

Returns Promise<{ dstAddress: string; txId: string }>

deriveTicketAddress

Parameters

ownerAddress: string

idoAddress: string

Returns Promise<string>

getIDOData

Parameters

idoAddress: string

Returns Promise<IDOData>

getTicketData

Parameters

ticketAddress: string

Returns Promise<TicketData>

initializeIDO

Parameters

amount: bigint

startdate: bigint

middledate: bigint

enddate: bigint

redeemdate: bigint

soldMintAddress: string

raisedMintAddress: string

wallet: WalletInterface

Returns Promise<{ idoAddress: string; txId: string }>

initializeTicket

Parameters

idoAddress: string

wallet: WalletInterface

Returns Promise<{ ticketAddress: string; txId: string }>

parseIDOData

Parameters

data: Buffer

Returns IDOData

parseTicketData

Parameters

data: Buffer

Returns TicketData

redeem

Parameters

idoAddress: string

wallet: WalletInterface

Returns Promise<{ dstAddress: string; txId: string }>

seed

Parameters

amount: bigint

idoAddress: string

wallet: WalletInterface

Returns Promise<{ txId: string }>

stake

Parameters

amount: bigint

idoAddress: string

wallet: WalletInterface

Returns Promise<{ ticketAddress: string; txId: string }>