Class AeSdkMethods

AeSdkMethods is the composition of:

chain methods
tx methods
aens methods
spend methods
oracle methods
contract methods
contract ga methods

While these methods can be used separately, this class provides a handy way to store their context (current account, network, and compiler to use).

Hierarchy

AeSdkMethods

Index

Constructors

Properties

Methods

_getOptions _resolveAccount buildTx initializeContract

Constructors

constructor

new AeSdkMethods(options?: AeSdkMethodsOptions): AeSdkMethods
Parameters
- options: AeSdkMethodsOptions = {}
  
  Options
Returns AeSdkMethods
- Defined in AeSdkMethods.ts:78

Properties

_options

_options: AeSdkMethodsOptions = {}

Methods

_getOptions

_getOptions(): AeSdkMethodsOptions & {
onAccount: AccountBase;
}
Returns AeSdkMethodsOptions & {
onAccount: AccountBase;
}
- Defined in AeSdkMethods.ts:96

_resolveAccount

_resolveAccount(account?: OnAccount): AccountBase
Resolves an account
Parameters
- Optional account: OnAccount
  
  ak-address, instance of AccountBase, or keypair
Returns AccountBase
- Defined in AeSdkMethods.ts:87

buildTx

buildTx(options: TxParamsAsync): Promise<`tx_${string}`>
Parameters
- options: TxParamsAsync
Returns Promise<`tx_${string}`>
- Defined in AeSdkMethods.ts:103

initializeContract

initializeContract<Methods>(options?: Omit<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;
}, "onNode"> & {
    onNode?: Node;
}): Promise<Contract<Methods>>
Type Parameters
- Methods extends ContractMethodsBase
Parameters
- Optional options: Omit<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;
  }, "onNode"> & {
      onNode?: Node;
  }
Returns Promise<Contract<Methods>>
- Defined in AeSdkMethods.ts:107

Generated using TypeDoc