Class EncodingApi

Hierarchy

EncodingApi
- EncodingApi

Index

Constructors

Properties

basePath axios configuration

Methods

Constructors

constructor

new EncodingApi(configuration?, basePath?, axios?): x.EncodingApi
Parameters
- Optional configuration: Configuration
- Optional basePath: string
- Optional axios: AxiosInstance
Returns x.EncodingApi
Inherited from imx.EncodingApi.constructor
- Defined in packages/internal/generated-clients/dist/imx/base.d.ts:43

Properties

`Protected` basePath

basePath: string

`Protected` axios

axios: AxiosInstance

`Protected` configuration

configuration: undefined | Configuration

Methods

encodeAsset

encodeAsset(requestParameters, options?): Promise<AxiosResponse<EncodeAssetResponse, any>>
Retrieves the Starkex Encoded format for a given asset so that it can be used as parameter for Starkex smart contracts
Parameters
- requestParameters: EncodingApiEncodeAssetRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<EncodeAssetResponse, any>>

Summary
Retrieves the Starkex Encoded format for a given asset

Throws

Memberof
EncodingApi
Inherited from imx.EncodingApi.encodeAsset
- Defined in packages/internal/generated-clients/dist/imx/domain/encoding-api.d.ts:96

Generated using TypeDoc