Class SmartContract

An abstraction for deploying and interacting with Smart Contracts.

Implements

ISmartContract

Index

Constructors

constructor

new SmartContract(options?): SmartContract
Create a SmartContract object by providing its address on the Network.
Parameters
- options: {
  abi?: IAbi;
  address?: IAddress;
  } = {}
  - Optional abi?: IAbi
  - Optional address?: IAddress
Returns SmartContract
- Defined in src/smartcontracts/smartContract.ts:50

Properties

`Private` `Optional` abi

abi?: IAbi

`Private` address

address: IAddress = ...

`Readonly` methods

methods: {
[key: string]: ((args?) => Interaction);
} = {}

This object contains a function for each endpoint defined by the contract. (a bit similar to web3js's "contract.methods").

This is an alternative to methodsExplicit. Unlike methodsExplicit, automatic type inference (wrt. ABI) is applied when using methods.

Type declaration

[key: string]: ((args?) => Interaction)
- - (args?): Interaction
  - Parameters
    - Optional args: any[]
    Returns Interaction

`Readonly` methodsExplicit

methodsExplicit: {
[key: string]: ((args?) => Interaction);
} = {}

This object contains a function for each endpoint defined by the contract. (a bit similar to web3js's "contract.methods").

Type declaration

[key: string]: ((args?) => Interaction)
- - (args?): Interaction
  - Parameters
    - Optional args: TypedValue[]
    Returns Interaction

Methods

call

call(__namedParameters): Transaction
Creates a Transaction for calling (a function of) the Smart Contract.
Parameters
- __namedParameters: CallArguments
Returns Transaction
Implementation of ISmartContract.call
- Defined in src/smartcontracts/smartContract.ts:204

createQuery

createQuery(__namedParameters): Query
Parameters
- __namedParameters: QueryArguments
Returns Query
- Defined in src/smartcontracts/smartContract.ts:233

deploy

deploy(__namedParameters): Transaction
Creates a Transaction for deploying the Smart Contract to the Network.
Parameters
- __namedParameters: DeployArguments
Returns Transaction
Implementation of ISmartContract.deploy
- Defined in src/smartcontracts/smartContract.ts:112

`Private` ensureHasAddress

ensureHasAddress(): void
Returns void
- Defined in src/smartcontracts/smartContract.ts:245

`Private` getAbi

getAbi(): IAbi
Returns IAbi
- Defined in src/smartcontracts/smartContract.ts:100

getAddress

getAddress(): IAddress
Gets the address, as on Network.

Returns IAddress
Implementation of ISmartContract.getAddress
- Defined in src/smartcontracts/smartContract.ts:96

getEndpoint

getEndpoint(name): EndpointDefinition
Parameters
- name: string | ContractFunction
Returns EndpointDefinition
- Defined in src/smartcontracts/smartContract.ts:105

`Private` getMetadataPropertiesAsObject

getMetadataPropertiesAsObject(codeMetadata?): {
    payable: boolean;
    payableBySc: boolean;
    readable: boolean;
    upgradeable: boolean;
}
Parameters
- Optional codeMetadata: ICodeMetadata
Returns {
    payable: boolean;
    payableBySc: boolean;
    readable: boolean;
    upgradeable: boolean;
}
- payable: boolean
- payableBySc: boolean
- readable: boolean
- upgradeable: boolean
- Defined in src/smartcontracts/smartContract.ts:142

setAddress

setAddress(address): void
Sets the address, as on Network.
Parameters
- address: IAddress
Returns void
- Defined in src/smartcontracts/smartContract.ts:89

`Private` setupMethods

setupMethods(): void
Returns void
- Defined in src/smartcontracts/smartContract.ts:59

upgrade

upgrade(__namedParameters): Transaction
Creates a Transaction for upgrading the Smart Contract on the Network.
Parameters
- __namedParameters: UpgradeArguments
Returns Transaction
Implementation of ISmartContract.upgrade
- Defined in src/smartcontracts/smartContract.ts:168

`Static` computeAddress

computeAddress(owner, nonce): IAddress
Computes the address of a Smart Contract. The address is computed deterministically, from the address of the owner and the nonce of the deployment transaction.
Parameters
- owner: IAddress
  The owner of the Smart Contract
- nonce: INonce
  The owner nonce used for the deployment transaction
Returns IAddress
- Defined in src/smartcontracts/smartContract.ts:258

Class SmartContract

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional abi?: IAbi

Optional address?: IAddress

Returns SmartContract

Properties

Private Optional abi

Private address

Readonly methods

Type declaration

[key: string]: ((args?) => Interaction)

Parameters

Returns Interaction

Readonly methodsExplicit

Type declaration

[key: string]: ((args?) => Interaction)

Parameters

Returns Interaction

Methods

call

Parameters

Returns Transaction

createQuery

Parameters

Returns Query

deploy

Parameters

Returns Transaction

Private ensureHasAddress

Returns void

Private getAbi

Returns IAbi

getAddress

Returns IAddress

getEndpoint

Parameters

Returns EndpointDefinition

Private getMetadataPropertiesAsObject

Parameters

Returns { payable: boolean; payableBySc: boolean; readable: boolean; upgradeable: boolean; }

payable: boolean

payableBySc: boolean

readable: boolean

upgradeable: boolean

setAddress

Parameters

Returns void

Private setupMethods

Returns void

upgrade

Parameters

Returns Transaction

Static computeAddress

Parameters

Returns IAddress

Settings

Member Visibility

Theme

On This Page

`Optional` abi?: IAbi

`Optional` address?: IAddress

`Private` `Optional` abi

`Private` address

`Readonly` methods

`Readonly` methodsExplicit

`Private` ensureHasAddress

`Private` getAbi

`Private` getMetadataPropertiesAsObject

Returns {
payable: boolean;
payableBySc: boolean;
readable: boolean;
upgradeable: boolean;
}

`Private` setupMethods

`Static` computeAddress