External module DCore

Index

Classes

DcoreError

Interfaces

DcoreConfig

Variables

Functions

Variables

Let _account

_account: AccountModule

Let _assetModule

_assetModule: AssetModule

Let _chain

_chain: ChainApi

Let _connector

_connector: ApiConnector

Let _content

_content: ContentModule

Let _explorer

_explorer: ExplorerModule

Let _messaging

_messaging: MessagingModule

Let _mining

_mining: MiningModule

Let _proposal

_proposal: ProposalModule

Let _seeding

_seeding: SeedingModule

Let _subscription

_subscription: SubscriptionModule

Let _transactionBuilder

_transactionBuilder: TransactionBuilder

Functions

account

account(): AccountModule

- Defined in dcore.ts:118
Returns AccountModule

asset

asset(): AssetModule

- Defined in dcore.ts:126
Returns AssetModule

connection

connection(): ApiConnector

- Defined in dcore.ts:154
Returns ApiConnector

content

content(): ContentModule

- Defined in dcore.ts:114
Returns ContentModule

explorer

explorer(): ExplorerModule

- Defined in dcore.ts:122
Returns ExplorerModule

initialize

initialize(config: DcoreConfig, testConnection?: boolean, connectionStatusCallback?: function): void

- Defined in dcore.ts:51
Intialize dcorejs library with custom data that are used for library operations

Parameters
- config: DcoreConfig
  
  Configuration of dcore network yout about to connect to
- Default value testConnection: boolean = true
- Default value connectionStatusCallback: function = null
  - - (state: ConnectionState): void
    - Parameters
      - state: ConnectionState
      Returns void
Returns void

messaging

messaging(): MessagingModule

- Defined in dcore.ts:145
Returns MessagingModule

mining

mining(): MiningModule

- Defined in dcore.ts:129
Returns MiningModule

proposal

proposal(): ProposalModule

- Defined in dcore.ts:141
Returns ProposalModule

seeding

seeding(): SeedingModule

- Defined in dcore.ts:137
Returns SeedingModule

subscribe

subscribe(callback: ChainSubscriptionCallback): Promise<Subscription>

- Defined in dcore.ts:80
Subscribe for blockchain update notifications. Notifications is fired periodically. For development purposes.

Parameters
- callback: ChainSubscriptionCallback
  
  Callback to be called on subscribed event.
Returns Promise<Subscription>

Promise with subscription object

subscribeBlockApplied

subscribeBlockApplied(callback: ChainSubscriptionBlockAppliedCallback): Promise<Subscription>

- Defined in dcore.ts:90
Subscribe for blockchain block processed notifications. Notifications is fired when block is processed.

Parameters
- callback: ChainSubscriptionBlockAppliedCallback
  
  Callback method to handle subscription data.
Returns Promise<Subscription>

Promise with subscription object

subscribePendingTransaction

subscribePendingTransaction(callback: ChainSubscriptionCallback): Promise<Subscription>

- Defined in dcore.ts:100
Subscribe for events fired everytime new transaction is broadcasted to network

Parameters
- callback: ChainSubscriptionCallback
Returns Promise<Subscription>

Promise with subscription object

subscription

subscription(): SubscriptionModule

- Defined in dcore.ts:133
Returns SubscriptionModule

transactionBuilder

transactionBuilder(): TransactionBuilder

- Defined in dcore.ts:149
Returns TransactionBuilder

unsubscribe

unsubscribe(subscription: Subscription): boolean

- Defined in dcore.ts:110
Unsubscribe event callback.

Parameters
- subscription: Subscription
  
  Subscription object used to unsubscribe callback.
Returns boolean

If successfully removed, true is returned.

Powered by DECENT