Class Token

Hierarchy

Token

Implements

IStateful<ITokenState>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Token(id: Address, context: Arc): Token

- Defined in src/token.ts:87
Parameters
- id: Address
- context: Arc
Returns Token

Properties

address

address: string

context

context: Arc

id

Methods

allowance

allowance(owner: Address, spender: Address): Observable<BN>

- Defined in src/token.ts:185
Parameters
- owner: Address
- spender: Address
Returns Observable<BN>

approveForStaking

approveForStaking(spender: Address, amount: BN): IOperationObservable<ITransactionUpdate<any>>

- Defined in src/token.ts:226
Parameters
- spender: Address
- amount: BN
Returns IOperationObservable<ITransactionUpdate<any>>

balanceOf

balanceOf(owner: string): Observable<BN>

- Defined in src/token.ts:133
Parameters
- owner: string
Returns Observable<BN>

contract

contract(mode?: undefined | "readonly"): any

- Defined in src/token.ts:128
Parameters
- Optional mode: undefined | "readonly"
Returns any

mint

mint(beneficiary: Address, amount: BN): IOperationObservable<ITransactionUpdate<any>>

- Defined in src/token.ts:212
Parameters
- beneficiary: Address
- amount: BN
Returns IOperationObservable<ITransactionUpdate<any>>

state

state(apolloQueryOptions?: IApolloQueryOptions): Observable<ITokenState>

- Defined in src/token.ts:97
Parameters
- Default value apolloQueryOptions: IApolloQueryOptions = {}
Returns Observable<ITokenState>

transfer

transfer(beneficiary: Address, amount: BN): IOperationObservable<ITransactionUpdate<any>>

- Defined in src/token.ts:219
Parameters
- beneficiary: Address
- amount: BN
Returns IOperationObservable<ITransactionUpdate<any>>

Static search

search(context: Arc, options?: ITokenQueryOptions, apolloQueryOptions?: IApolloQueryOptions): Observable<Token[]>

- Defined in src/token.ts:52
Token.search(context, options) searches for token entities

Parameters
- context: Arc
  
  an Arc instance that provides connection information
- Default value options: ITokenQueryOptions = {}
  
  the query options, cf. ITokenQueryOptions
- Default value apolloQueryOptions: IApolloQueryOptions = {}
Returns Observable<Token[]>

an observable of Token objects

Generated using TypeDoc