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

Hierarchy

  • Contract

Constructors

constructor

Properties

$options _aci _calldata _name

Methods

$call $compile $decodeEvents $deploy $getCallResultByTxHash _estimateGas initialize

Constructors

constructor

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

$compile

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

  • Compile contract

    Returns

    bytecode

    Returns Promise<`cb_${string}`>

$decodeEvents

$deploy

  • $deploy(params: M extends {
        init: any;
    } ? Parameters<M["init"]> : [], 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">>): Promise<Omit<SendAndProcessReturnType, "hash"> & {
        address?: `ct_${string}`;
        decodedEvents?: DecodedEvent[];
        owner?: `ak_${string}`;
        transaction?: `th_${string}`;
    }>

  • Deploy contract

    Returns

    deploy info

    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}`;
    }>

$getCallResultByTxHash

_estimateGas

Static initialize

  • Type Parameters

    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>>

Settings

Member Visibility

Theme

Generated using TypeDoc