Class Contract<M>

Generate contract ACI object with predefined js methods for contract usage - can be used for creating a reference to already deployed contracts

Param

Options object

Returns

JS Contract API

Example

const contractIns = await aeSdk.initializeContract({ sourceCode })
await contractIns.$deploy([321]) or await contractIns.init(321)
const callResult = await contractIns.$call('setState', [123])
const staticCallResult = await contractIns.$call('setState', [123], { callStatic: true })

Also you can call contract like: await contractIns.setState(123, options) Then sdk decide to make on-chain or static call(dry-run API) transaction based on function is stateful or not

Type Parameters

M extends ContractMethodsBase

Hierarchy

Contract

Index

Constructors

constructor

new Contract<M>(__namedParameters): Contract<M>
Type Parameters
- M extends ContractMethodsBase
Parameters
- __namedParameters: {
      aci: Aci;
      address?: `ct_${string}`;
      bytecode?: `cb_${string}`;
      fileSystem?: Record<string, string>;
      onCompiler?: CompilerBase;
      onNode: Node;
      sourceCode?: string;
      sourceCodePath?: string;
  } & Partial<BuildTxOptions<ContractCallTx, "callData" | "callerId" | "contractId">> & {
      omitUnknown?: boolean;
  } & GetContractNameByEventOptions & Omit<SendTransactionOptions, "onNode" | "onAccount"> & Omit<{
      combine?: boolean;
      onNode: Node;
      top?: number | `kh_${string}` | `mh_${string}`;
      txEvents?: boolean;
  }, "onNode"> & {
      callStatic?: boolean;
      onAccount?: AccountBase;
      onNode?: Node;
  } & Partial<BuildTxOptions<ContractCreateTx, "code" | "ownerId" | "callData">>
Returns Contract<M>
- Defined in contract/Contract.ts:539

Properties

$options

$options: Omit<{
    aci: Aci;
    address?: `ct_${string}`;
    bytecode?: `cb_${string}`;
    fileSystem?: Record<string, string>;
    onCompiler?: CompilerBase;
    onNode: Node;
    sourceCode?: string;
    sourceCodePath?: string;
} & Partial<BuildTxOptions<ContractCallTx, "callData" | "callerId" | "contractId">> & {
    omitUnknown?: boolean;
} & GetContractNameByEventOptions & Omit<SendTransactionOptions, "onNode" | "onAccount"> & Omit<{
    combine?: boolean;
    onNode: Node;
    top?: number | `kh_${string}` | `mh_${string}`;
    txEvents?: boolean;
}, "onNode"> & {
    callStatic?: boolean;
    onAccount?: AccountBase;
    onNode?: Node;
} & Partial<BuildTxOptions<ContractCreateTx, "code" | "ownerId" | "callData">>, "aci">

_aci

_aci: Aci

_calldata

_calldata: Encoder

_name

_name: string

Methods

$call

$call<Fn>(fn, params, options?): Promise<SendAndProcessReturnType & Partial<GetCallResultByHashReturnType<M, Fn>>>
Call contract function
Type Parameters
- Fn extends string
Parameters
- fn: Fn
  
  Function name
- params: MethodParameters<M, Fn>
  
  Array of function arguments
- options: Partial<BuildTxOptions<ContractCallTx, "callData" | "callerId" | "contractId">> & {
      omitUnknown?: boolean;
  } & GetContractNameByEventOptions & Omit<SendTransactionOptions, "onNode" | "onAccount"> & Omit<{
      combine?: boolean;
      onNode: Node;
      top?: number | `kh_${string}` | `mh_${string}`;
      txEvents?: boolean;
  }, "onNode"> & {
      callStatic?: boolean;
      onAccount?: AccountBase;
      onNode?: Node;
  } = {}
  
  Array of function arguments
Returns Promise<SendAndProcessReturnType & Partial<GetCallResultByHashReturnType<M, Fn>>>
CallResult
- Defined in contract/Contract.ts:299

$compile

$compile(): Promise<`cb_${string}`>
Compile contract

Returns Promise<`cb_${string}`>
bytecode
- Defined in contract/Contract.ts:133

$decodeEvents

$decodeEvents(events, options?): DecodedEvent[]
Decode Events
Parameters
- events: Event[]
  
  Array of encoded events (callRes.result.log)
- options: {
  omitUnknown?: boolean;
  } & GetContractNameByEventOptions = {}
  
  Options
Returns DecodedEvent[]
DecodedEvents
- Defined in contract/Contract.ts:426

$deploy

$deploy(params, options?): Promise<Omit<SendAndProcessReturnType, "hash"> & {
    address?: `ct_${string}`;
    decodedEvents?: DecodedEvent[];
    owner?: `ak_${string}`;
    transaction?: `th_${string}`;
}>
Deploy contract
Parameters
- params: M extends {
          init: any;
      }
      ? Parameters<M["init"]>
      : []
  
  Contract init function arguments array
- Optional options: Partial<BuildTxOptions<ContractCallTx, "callData" | "callerId" | "contractId">> & {
      omitUnknown?: boolean;
  } & GetContractNameByEventOptions & Omit<SendTransactionOptions, "onNode" | "onAccount"> & Omit<{
      combine?: boolean;
      onNode: Node;
      top?: number | `kh_${string}` | `mh_${string}`;
      txEvents?: boolean;
  }, "onNode"> & {
      callStatic?: boolean;
      onAccount?: AccountBase;
      onNode?: Node;
  } & Partial<BuildTxOptions<ContractCreateTx, "code" | "ownerId" | "callData">>
  
  Options
Returns Promise<Omit<SendAndProcessReturnType, "hash"> & {
    address?: `ct_${string}`;
    decodedEvents?: DecodedEvent[];
    owner?: `ak_${string}`;
    transaction?: `th_${string}`;
}>
deploy info
- Defined in contract/Contract.ts:229

$getCallResultByTxHash

$getCallResultByTxHash<Fn>(hash, fnName, options?): Promise<GetCallResultByHashReturnType<M, Fn> & {
result: ContractCallObject;
}>
Type Parameters
- Fn extends string
Parameters
- hash: `th_${string}`
- fnName: Fn
- Optional options: {
  omitUnknown?: boolean;
  } & GetContractNameByEventOptions
Returns Promise<GetCallResultByHashReturnType<M, Fn> & {
result: ContractCallObject;
}>
- Defined in contract/Contract.ts:195

_estimateGas

_estimateGas<Fn>(name, params, options?): Promise<number>
Type Parameters
- Fn extends string
Parameters
- name: Fn
- params: MethodParameters<M, Fn>
- options: Omit<undefined | Partial<BuildTxOptions<ContractCallTx, "callData" | "callerId" | "contractId">> & {
      omitUnknown?: boolean;
  } & GetContractNameByEventOptions & Omit<SendTransactionOptions, "onNode" | "onAccount"> & Omit<{
      combine?: boolean;
      onNode: Node;
      top?: number | `kh_${string}` | `mh_${string}`;
      txEvents?: boolean;
  }, "onNode"> & {
      callStatic?: boolean;
      onAccount?: AccountBase;
      onNode?: Node;
  }, "callStatic"> = {}
Returns Promise<number>
- Defined in contract/Contract.ts:211

`Static` initialize

initialize<M>(__namedParameters): Promise<Contract<M>>
Type Parameters
- M extends ContractMethodsBase
Parameters
- __namedParameters: Omit<{
      aci: Aci;
      address?: `ct_${string}`;
      bytecode?: `cb_${string}`;
      fileSystem?: Record<string, string>;
      onCompiler?: CompilerBase;
      onNode: Node;
      sourceCode?: string;
      sourceCodePath?: string;
  } & Partial<BuildTxOptions<ContractCallTx, "callData" | "callerId" | "contractId">> & {
      omitUnknown?: boolean;
  } & GetContractNameByEventOptions & Omit<SendTransactionOptions, "onNode" | "onAccount"> & Omit<{
      combine?: boolean;
      onNode: Node;
      top?: number | `kh_${string}` | `mh_${string}`;
      txEvents?: boolean;
  }, "onNode"> & {
      callStatic?: boolean;
      onAccount?: AccountBase;
      onNode?: Node;
  } & Partial<BuildTxOptions<ContractCreateTx, "code" | "ownerId" | "callData">>, "address" | "aci"> & {
      aci?: Aci;
      address?: `${string}.chain` | `ct_${string}`;
      validateBytecode?: boolean;
  }
Returns Promise<Contract<M>>
- Defined in contract/Contract.ts:453

Class Contract<M>

Param

Returns

Example

Type Parameters

M extends ContractMethodsBase

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

M extends ContractMethodsBase

Parameters

Returns Contract<M>

Properties

$options

_aci

_calldata

_name

Methods

$call

Type Parameters

Fn extends string

Parameters

fn: Fn

params: MethodParameters<M, Fn>

Returns Promise<SendAndProcessReturnType & Partial<GetCallResultByHashReturnType<M, Fn>>>

$compile

Returns Promise<`cb_${string}`>

$decodeEvents

Parameters

events: Event[]

options: { omitUnknown?: boolean; } & GetContractNameByEventOptions = {}

Returns DecodedEvent[]

$deploy

Parameters

params: M extends { init: any; } ? Parameters<M["init"]> : []

Returns Promise<Omit<SendAndProcessReturnType, "hash"> & { address?: `ct_${string}`; decodedEvents?: DecodedEvent[]; owner?: `ak_${string}`; transaction?: `th_${string}`; }>

$getCallResultByTxHash

Type Parameters

Fn extends string

Parameters

hash: `th_${string}`

fnName: Fn

Optional options: { omitUnknown?: boolean; } & GetContractNameByEventOptions

Returns Promise<GetCallResultByHashReturnType<M, Fn> & { result: ContractCallObject; }>

_estimateGas

Type Parameters

Fn extends string

Parameters

name: Fn

params: MethodParameters<M, Fn>

Returns Promise<number>

Static initialize

Type Parameters

M extends ContractMethodsBase

Parameters

Returns Promise<Contract<M>>

Settings

Member Visibility

Theme

On This Page

options: {
omitUnknown?: boolean;
} & GetContractNameByEventOptions = {}

params: M extends {
init: any;
}
? Parameters<M["init"]>
: []

Returns Promise<Omit<SendAndProcessReturnType, "hash"> & {
address?: `ct_${string}`;
decodedEvents?: DecodedEvent[];
owner?: `ak_${string}`;
transaction?: `th_${string}`;
}>

`Optional` options: {
omitUnknown?: boolean;
} & GetContractNameByEventOptions

Returns Promise<GetCallResultByHashReturnType<M, Fn> & {
result: ContractCallObject;
}>

`Static` initialize