ContractApi | NULS JS - API Reference

Hierarchy

APIServerClass
- ContractApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ContractApi(conf?: IAPIConfig): ContractApi

Overrides APIServerClass.constructor
- Defined in packages/contract/api/contract.ts:56
Parameters
- Default value conf: IAPIConfig = config.nuls.api.explorer
Returns ContractApi

Properties

api

api: AxiosInstance

Optional resources

resources: Record<string, string>

url

url: string

Methods

gas

gas(body: IContractCallGasRequest): Promise<IContractCallGasResponse>

- Defined in packages/contract/api/contract.ts:104
Parameters
- body: IContractCallGasRequest
Returns Promise<IContractCallGasResponse>

getMethods

getMethods(contractAddress: string): Promise<IContractGetMethodsResponse>

- Defined in packages/contract/api/contract.ts:62
Parameters
- contractAddress: string
Returns Promise<IContractGetMethodsResponse>

Protected getResource

getResource(name: string, ...args: string[]): string

Inherited from APIServerClass.getResource
- Defined in packages/core/api/APIServer.ts:24
Parameters
- name: string
- Rest ...args: string[]
Returns string

Protected handleErrors

handleErrors(e: AxiosError): AxiosError

Inherited from APIServerClass.handleErrors
- Defined in packages/core/api/APIServer.ts:42
Parameters
- e: AxiosError
Returns AxiosError

validate

validate(body: IContractCallValidateRequest): Promise<IContractCallValidateResponse>

- Defined in packages/contract/api/contract.ts:120
Parameters
- body: IContractCallValidateRequest
Returns Promise<IContractCallValidateResponse>

view

view(contractAddress: string, methodName: string, methodDesc?: undefined | string, ...args: ContractCallArgs): Promise<IContractViewResponse>

- Defined in packages/contract/api/contract.ts:78
Parameters
- contractAddress: string
- methodName: string
- Optional methodDesc: undefined | string
- Rest ...args: ContractCallArgs
Returns Promise<IContractViewResponse>