Kip17ContractApi

Kip17ContractApi

new Kip17ContractApi()

Version:
  • 1.0

Kip17Contract service.

Methods

deployContract(opts, callback)

Deploy Contract Deploys a new KIP-17 contract with the given parameters. You can find the tutorial for KIP-17 contract deployment here. Even if you see `Submitted` in the response, it doesn't mean that the transaction is `Committed`. To confirm transaction status, use Get Contract List /v1/contract or Get Transaction Receipt from the Wallet API /v2/tx/{transaction-hash}.

Parameters:
Name Type Description
opts Object

Optional parameters

callback Kip17ContractApi~deployContractCallback

The callback function, accepting three arguments: error, data, response data is of type: Kip17DeployResponse

getContract(callback)

Get Contract Returns the data for a specified KIP-17 contract. You can use either the contract alias or contract address.<p></p>

Parameters:
Name Type Description
callback Kip17ContractApi~getContractCallback

The callback function, accepting three arguments: error, data, response data is of type: Kip17ContractInfoResponse

listContractsInDeployerPool(opts, callback)

Get Contract List Returns a list of KIP-17 contracts created from a KAS account.<p></p>

Parameters:
Name Type Description
opts Object

Optional parameters

callback Kip17ContractApi~listContractsInDeployerPoolCallback

The callback function, accepting three arguments: error, data, response data is of type: Kip17ContractListResponse

updateContract(opts, callback)

Update Contract Updates the fee payment method for a contract. ##### Options With `options` you can set the transaction fee payment method. You can find more details in Fee Payer Options.

Parameters:
Name Type Description
opts Object

Optional parameters

callback Kip17ContractApi~updateContractCallback

The callback function, accepting three arguments: error, data, response data is of type: Kip17ContractInfoResponse

Type Definitions

deployContractCallback(error, data, response)

Callback function to receive the result of the deployContract operation.

Parameters:
Name Type Description
error String

Error message, if any.

data Kip17DeployResponse

The data returned by the service call.

response String

The complete HTTP response.

getContractCallback(error, data, response)

Callback function to receive the result of the getContract operation.

Parameters:
Name Type Description
error String

Error message, if any.

data Kip17ContractInfoResponse

The data returned by the service call.

response String

The complete HTTP response.

listContractsInDeployerPoolCallback(error, data, response)

Callback function to receive the result of the listContractsInDeployerPool operation.

Parameters:
Name Type Description
error String

Error message, if any.

data Kip17ContractListResponse

The data returned by the service call.

response String

The complete HTTP response.

updateContractCallback(error, data, response)

Callback function to receive the result of the updateContract operation.

Parameters:
Name Type Description
error String

Error message, if any.

data Kip17ContractInfoResponse

The data returned by the service call.

response String

The complete HTTP response.

Kip17ContractApi

new Kip17ContractApi(apiClientopt)

Constructs a new Kip17ContractApi.

Parameters:
Name Type Attributes Description
apiClient ApiClient <optional>

Optional API client implementation to use, default to ApiClient#instance if unspecified.

Methods

deployContract(opts, callback)

Deploy Contract Deploys a new KIP-17 contract with the given parameters. You can find the tutorial for KIP-17 contract deployment here. Even if you see `Submitted` in the response, it doesn't mean that the transaction is `Committed`. To confirm transaction status, use Get Contract List /v1/contract or Get Transaction Receipt from the Wallet API /v2/tx/{transaction-hash}.

Parameters:
Name Type Description
opts Object

Optional parameters

callback Kip17ContractApi~deployContractCallback

The callback function, accepting three arguments: error, data, response data is of type: Kip17DeployResponse

getContract(callback)

Get Contract Returns the data for a specified KIP-17 contract. You can use either the contract alias or contract address.<p></p>

Parameters:
Name Type Description
callback Kip17ContractApi~getContractCallback

The callback function, accepting three arguments: error, data, response data is of type: Kip17ContractInfoResponse

listContractsInDeployerPool(opts, callback)

Get Contract List Returns a list of KIP-17 contracts created from a KAS account.<p></p>

Parameters:
Name Type Description
opts Object

Optional parameters

callback Kip17ContractApi~listContractsInDeployerPoolCallback

The callback function, accepting three arguments: error, data, response data is of type: Kip17ContractListResponse

updateContract(opts, callback)

Update Contract Updates the fee payment method for a contract. ##### Options With `options` you can set the transaction fee payment method. You can find more details in Fee Payer Options.

Parameters:
Name Type Description
opts Object

Optional parameters

callback Kip17ContractApi~updateContractCallback

The callback function, accepting three arguments: error, data, response data is of type: Kip17ContractInfoResponse

Type Definitions

deployContractCallback(error, data, response)

Callback function to receive the result of the deployContract operation.

Parameters:
Name Type Description
error String

Error message, if any.

data Kip17DeployResponse

The data returned by the service call.

response String

The complete HTTP response.

getContractCallback(error, data, response)

Callback function to receive the result of the getContract operation.

Parameters:
Name Type Description
error String

Error message, if any.

data Kip17ContractInfoResponse

The data returned by the service call.

response String

The complete HTTP response.

listContractsInDeployerPoolCallback(error, data, response)

Callback function to receive the result of the listContractsInDeployerPool operation.

Parameters:
Name Type Description
error String

Error message, if any.

data Kip17ContractListResponse

The data returned by the service call.

response String

The complete HTTP response.

updateContractCallback(error, data, response)

Callback function to receive the result of the updateContract operation.

Parameters:
Name Type Description
error String

Error message, if any.

data Kip17ContractInfoResponse

The data returned by the service call.

response String

The complete HTTP response.