Contract | NULS JS - API Reference

Hierarchy

Contract

Index

Constructors

constructor

Properties

Methods

Object literals

_info

Constructors

Protected constructor

new Contract(): Contract

- Defined in packages/contract/protocol/contract.ts:300
Returns Contract

Properties

Protected _api

_api: ContractApi

Protected _config

_config: ContractConfig

Protected _contractAddress

_contractAddress: Address

Protected _methods

_methods: IContractGetMethodsResponse

Methods

account

account(account: Account): this
account(address: string, privateKey: string): this

- Defined in packages/contract/protocol/contract.ts:314
Parameters
- account: Account
Returns this
- Defined in packages/contract/protocol/contract.ts:315
Parameters
- address: string
- privateKey: string
Returns this

config

config(config?: ContractConfig): this

- Defined in packages/contract/protocol/contract.ts:304
Parameters
- Optional config: ContractConfig
Returns this

info

info(): ContractInfo

- Defined in packages/contract/protocol/contract.ts:344
Returns ContractInfo

Static at

at(contractAddress: string, config?: ContractConfig): Promise<Contract>

- Defined in packages/contract/protocol/contract.ts:40
Parameters
- contractAddress: string
- Optional config: ContractConfig
Returns Promise<Contract>

Static Protected call

call(contractAddress: string, method: IContractMethod, args: ContractCallArgs, config: ContractConfig & ContractMethodCallConfig): PromiEvent<TransactionReceipt>

- Defined in packages/contract/protocol/contract.ts:101
Parameters
- contractAddress: string
- method: IContractMethod
- args: ContractCallArgs
- config: ContractConfig & ContractMethodCallConfig
Returns PromiEvent<TransactionReceipt>

Static Protected prepareCall

prepareCall(contractAddress: string, method: IContractMethod, args: ContractCallArgs, config: ContractConfig & ContractMethodCallConfig): Promise<ContractCallTransaction>

- Defined in packages/contract/protocol/contract.ts:124
Parameters
- contractAddress: string
- method: IContractMethod
- args: ContractCallArgs
- config: ContractConfig & ContractMethodCallConfig
Returns Promise<ContractCallTransaction>

Static Protected validateArgs

validateArgs(method: IContractMethod, args: ContractCallArgs): boolean

- Defined in packages/contract/protocol/contract.ts:219
Parameters
- method: IContractMethod
- args: ContractCallArgs
Returns boolean

Static Protected view

view(contractAddress: string, method: IContractMethod, args: ContractCallArgs, config?: ContractConfig, api?: ContractApi): Promise<any>

- Defined in packages/contract/protocol/contract.ts:169
Parameters
- contractAddress: string
- method: IContractMethod
- args: ContractCallArgs
- Default value config: ContractConfig = {}
- Optional api: ContractApi
Returns Promise<any>

Object literals

Protected _info

_info: object

methods

methods: object

Type declaration

name

name: string = "Unknown"