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

Options object

Returns

JS Contract API

Example

const contractIns = await Contract.initialize({ ...aeSdk.getContext(), 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

Index

Constructors

constructor

new Contract<M extends ContractMethodsBase>(
    options: {
        aci: Aci;
        address?: `ct_${string}`;
        bytecode?: `cb_${string}`;
        fileSystem?: Record<string, string>;
        name?: `${string}.chain`;
        onCompiler?: CompilerBase;
        onNode: Node;
        sourceCode?: string;
        sourceCodePath?: string;
    } & Partial<
        BuildTxOptions<ContractCallTx, "contractId" | "callData" | "callerId">,
    > & { omitUnknown?: boolean } & GetContractNameByEventOptions & Pick<
        Partial<SendTransactionOptions>,
        "onNode" | "onAccount",
    > & Omit<SendTransactionOptions, "onNode" | "onAccount"> & Omit<
        {
            combine?: boolean;
            onNode: Node;
            top?: number
            | `kh_${string}`
            | `mh_${string}`;
            txEvents?: boolean;
        },
        "onNode",
    > & { callStatic?: boolean } & Partial<
        BuildTxOptions<ContractCreateTx, "code" | "ownerId" | "callData">,
    >,
): Contract<M>
Type Parameters
- M extends ContractMethodsBase
Parameters
- options: {
      aci: Aci;
      address?: `ct_${string}`;
      bytecode?: `cb_${string}`;
      fileSystem?: Record<string, string>;
      name?: `${string}.chain`;
      onCompiler?: CompilerBase;
      onNode: Node;
      sourceCode?: string;
      sourceCodePath?: string;
  } & Partial<
      BuildTxOptions<ContractCallTx, "contractId" | "callData" | "callerId">,
  > & { omitUnknown?: boolean } & GetContractNameByEventOptions & Pick<
      Partial<SendTransactionOptions>,
      "onNode" | "onAccount",
  > & Omit<SendTransactionOptions, "onNode" | "onAccount"> & Omit<
      {
          combine?: boolean;
          onNode: Node;
          top?: number
          | `kh_${string}`
          | `mh_${string}`;
          txEvents?: boolean;
      },
      "onNode",
  > & { callStatic?: boolean } & Partial<
      BuildTxOptions<ContractCreateTx, "code" | "ownerId" | "callData">,
  >
  Options
  - aci: Aci
  - Optionaladdress?: `ct_${string}`
  - Optionalbytecode?: `cb_${string}`
  - OptionalfileSystem?: Record<string, string>
  - Optionalname?: `${string}.chain`
    Supported only in Ceres
  - OptionalonCompiler?: CompilerBase
  - onNode: Node
  - OptionalsourceCode?: string
  - OptionalsourceCodePath?: string
  - OptionalomitUnknown?: boolean
  - OptionalcallStatic?: boolean
Returns Contract<M>
- Defined in contract/Contract.ts:612

Properties

_aci

_aci: Aci

_calldata

_calldata: Encoder

_name

_name: string

$options

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

Methods

_estimateGas

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

$call

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

$compile

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

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

$decodeEvents

$decodeEvents(
events: Event[],
options?: { omitUnknown?: boolean } & GetContractNameByEventOptions,
): 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:491

$deploy

$deploy(
    params: M extends { init: any } ? Parameters<M<M>["init"]> : [],
    options?: Partial<
        BuildTxOptions<ContractCallTx, "contractId" | "callData" | "callerId">,
    > & { omitUnknown?: boolean } & GetContractNameByEventOptions & Pick<
        Partial<SendTransactionOptions>,
        "onNode" | "onAccount",
    > & Omit<SendTransactionOptions, "onNode" | "onAccount"> & Omit<
        {
            combine?: boolean;
            onNode: Node;
            top?: number
            | `kh_${string}`
            | `mh_${string}`;
            txEvents?: boolean;
        },
        "onNode",
    > & { callStatic?: boolean } & Partial<
        BuildTxOptions<ContractCreateTx, "code" | "ownerId" | "callData">,
    >,
): 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<M>["init"]> : []
  Contract init function arguments array
- Optionaloptions: Partial<BuildTxOptions<ContractCallTx, "contractId" | "callData" | "callerId">> & {
      omitUnknown?: boolean;
  } & GetContractNameByEventOptions & Pick<
      Partial<SendTransactionOptions>,
      "onNode" | "onAccount",
  > & Omit<SendTransactionOptions, "onNode" | "onAccount"> & Omit<
      {
          combine?: boolean;
          onNode: Node;
          top?: number
          | `kh_${string}`
          | `mh_${string}`;
          txEvents?: boolean;
      },
      "onNode",
  > & { callStatic?: boolean } & 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:265

$getCallResultByTxHash

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

`Static`initialize

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

Class Contract<M>

Param: options

Returns

Example

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

aci: Aci

Optionaladdress?: `ct_${string}`

Optionalbytecode?: `cb_${string}`

OptionalfileSystem?: Record<string, string>

Optionalname?: `${string}.chain`

OptionalonCompiler?: CompilerBase

onNode: Node

OptionalsourceCode?: string

OptionalsourceCodePath?: string

OptionalomitUnknown?: boolean

OptionalcallStatic?: boolean

Returns Contract<M>

Properties

_aci

_calldata

_name

$options

Methods

_estimateGas

Type Parameters

Parameters

Returns Promise<number>

$call

Type Parameters

Parameters

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

$compile

Returns Promise<`cb_${string}`>

$decodeEvents

Parameters

Returns DecodedEvent[]

$deploy

Parameters

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

$getCallResultByTxHash

Type Parameters

Parameters

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

Staticinitialize

Type Parameters

Parameters

Returns Promise<Contract<M>>

Settings

On This Page

`Optional`address?: `ct_${string}`

`Optional`bytecode?: `cb_${string}`

`Optional`fileSystem?: Record<string, string>

`Optional`name?: `${string}.chain`

`Optional`onCompiler?: CompilerBase

`Optional`sourceCode?: string

`Optional`sourceCodePath?: string

`Optional`omitUnknown?: boolean

`Optional`callStatic?: boolean

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

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

`Static`initialize