@taikai/dappkit

Index

Namespaces

Defaults

Interfaces

Type Aliases

Functions

Type Aliases

Call

Call<T>: ((options?: CallOptions, callback?: ((err: Error, result: any) => void)) => Promise<T>)

Type Parameters

T = any

Type declaration

- (options?: CallOptions, callback?: ((err: Error, result: any) => void)): Promise<T>
- Parameters
  - Optional options: CallOptions
  - Optional callback: ((err: Error, result: any) => void)
    - - (err: Error, result: any): void
      - Parameters
        err: Error
        result: any
        Returns void
  Returns Promise<T>

ContractCallMethod

ContractCallMethod<ReturnData>: { call: Call<ReturnData> } & ContractSendMethod

Type Parameters

ReturnData = any

MinimalModel

MinimalModel: Pick<Model, NeedsFromModel>

NeedsFromModel

NeedsFromModel: "sendTx" | "sendUnsignedTx" | "callTx" | "contract" | "connection" | "account"

UseModelParams

UseModelParams<ModelMethods>: Pick<Model<ModelMethods>, NeedsFromModel>

Type Parameters

ModelMethods = any

XEvents

XEvents<V>: { [ K in keyof EventData]: EventData[K] extends V ? V : any }

Type Parameters

V

XPromiseEvent

XPromiseEvent<V>: Promise<XEvents<V>[]>

Type Parameters

V

Functions

benefactor

benefactor(__namedParameters: Benefactor, transactionalTokenDecimals?: number): Benefactor

- Defined in src/utils/benefactor.ts:5
Parameters
- __namedParameters: Benefactor
- transactionalTokenDecimals: number = 18
Returns Benefactor

bounty

bounty(__namedParameters: Bounty, networkTokenDecimals?: number, transactionalTokenDecimals?: number, rewardTokenDecimals?: number): Bounty

- Defined in src/utils/bounty.ts:8
Parameters
- __namedParameters: Bounty
- networkTokenDecimals: number = 18
- transactionalTokenDecimals: number = 18
- rewardTokenDecimals: number = 18
Returns Bounty

eip4361Params

eip4361Params(domain: string, verifyingContract: string, statement: string, uri: string, version: string, chainId: number, nonce: string, issuedAt: string, expirationTime: string, notBefore: string, requestId: string, resources: string[], contractName: string): EIP4361TypedData

- Defined in src/utils/eip4361.ts:4
Parameters
- domain: string
- verifyingContract: string
- statement: string
- uri: string
- version: string
- chainId: number
- nonce: string
- issuedAt: string
- expirationTime: string
- notBefore: string
- requestId: string
- resources: string[]
- contractName: string
Returns EIP4361TypedData

fromDecimals

fromDecimals(value: string | number, decimals?: number): string

- Defined in src/utils/numbers.ts:35
alias
fromSmartContractDecimals

Parameters
- value: string | number
- decimals: number = 18
Returns string

fromSmartContractDate

fromSmartContractDate(date: number): number

- Defined in src/utils/numbers.ts:53
converts from a smart contract date (s) to javascript date (ms)

Parameters
- date: number
Returns number

fromSmartContractDecimals

fromSmartContractDecimals(value: string | number | BigNumber, decimals?: number, rounding?: null | number): string

- Defined in src/utils/numbers.ts:25
convert a ERC20 token value into javascript number

Parameters
- value: string | number | BigNumber
- decimals: number = 18
- rounding: null | number = null
Returns string

jsonRpcParams

jsonRpcParams(method: string, params: string[], version?: string): { jsonrpc: string; method: string; params: string[] }

- Defined in src/utils/json-rpc-params.ts:1
Parameters
- method: string
- params: string[]
- Optional version: string
Returns { jsonrpc: string; method: string; params: string[] }
- jsonrpc: string
- method: string
- params: string[]

lockedTokensInfo

lockedTokensInfo(tokensInfo: Params, decimals?: number): LockedTokensInfo

- Defined in src/utils/locked-tokens-info.ts:5
Parameters
- tokensInfo: Params
- decimals: number = 18
Returns LockedTokensInfo

nameType

nameType(name: string, type: string): { name: string; type: string }

- Defined in src/utils/eip4361.ts:40
Parameters
- name: string
- type: string
Returns { name: string; type: string }
- name: string
- type: string

oraclesResume

oraclesResume(oracles: Oracle, delegations: Delegation[], settlerTokenDecimals?: number): OraclesResume

- Defined in src/utils/oracles-resume.ts:7
Parameters
- oracles: Oracle
- delegations: Delegation[]
- settlerTokenDecimals: number = 18
Returns OraclesResume

proposal

proposal(__namedParameters: Proposal, decimals?: number): Proposal

- Defined in src/utils/proposal.ts:7
Parameters
- __namedParameters: Proposal
- decimals: number = 18
Returns Proposal

proposalDetail

proposalDetail(__namedParameters: ProposalDetail): ProposalDetail

- Defined in src/utils/proposal-detail.ts:3
Parameters
- __namedParameters: ProposalDetail
Returns ProposalDetail

pullRequest

pullRequest(__namedParameters: PullRequest): PullRequest

- Defined in src/utils/pull-request.ts:3
Parameters
- __namedParameters: PullRequest
Returns PullRequest

toSmartContractDate

toSmartContractDate(date: number | Date): number

- Defined in src/utils/numbers.ts:44
converts a javascript date (ms) to a smart contract date (s)

Parameters
- date: number | Date
Returns number

toSmartContractDecimals

toSmartContractDecimals(value: string | number, decimals?: number, rounding?: null | number): string

- Defined in src/utils/numbers.ts:14
convert a simple number into a big number representation, usually used to convert to ERC20 token correct number

Parameters
- value: string | number
- decimals: number = 18
- rounding: null | number = null
Returns string

transactionHandler

transactionHandler(transaction: PromiEvent<Contract | TransactionReceipt>, resolve: ResolveReject, reject: ResolveReject, debug?: boolean): void

- Defined in src/utils/transaction-handler.ts:6
Parameters
- transaction: PromiEvent<Contract | TransactionReceipt>
- resolve: ResolveReject
- reject: ResolveReject
- Optional debug: boolean
Returns void

Generated using TypeDoc