Class EntryFunction

Hierarchy

EntryFunction

Index

Constructors

Properties

args function_name module_name ty_args

Methods

serialize deserialize natual natural

Constructors

constructor

new EntryFunction(module_name: ModuleId, function_name: Identifier, ty_args: Seq<TypeTag>, args: Seq<Uint8Array>): EntryFunction
Contains the payload to run a function within a module.

Example
A coin transfer function has one type argument "CoinType".
```
public(script) fun transfer<CoinType>(from: &signer, to: address, amount: u64,)
```
Example
A coin transfer function has three arugments "from", "to" and "amount".
```
public(script) fun transfer<CoinType>(from: &signer, to: address, amount: u64,)
```
Parameters
- module_name: ModuleId
  
  Fully qualified module name. ModuleId consists of account address and module name.
- function_name: Identifier
  
  The function to run.
- ty_args: Seq<TypeTag>
  
  Type arguments that move function requires.
- args: Seq<Uint8Array>
  
  Arugments to the move function.
Returns EntryFunction
- Defined in src/aptos_types/transaction.ts:144

Properties

`Readonly` args

args: Seq<Uint8Array>

Arugments to the move function.

`Readonly` function_name

function_name: Identifier

The function to run.

`Readonly` module_name

module_name: ModuleId

Fully qualified module name. ModuleId consists of account address and module name.

`Readonly` ty_args

ty_args: Seq<TypeTag>

Type arguments that move function requires.

Methods

serialize

serialize(serializer: Serializer): void
Parameters
- serializer: Serializer
Returns void
- Defined in src/aptos_types/transaction.ts:184

`Static` deserialize

deserialize(deserializer: Deserializer): EntryFunction
Parameters
- deserializer: Deserializer
Returns EntryFunction
- Defined in src/aptos_types/transaction.ts:195

`Static` natual

natual(module: string, func: string, ty_args: Seq<TypeTag>, args: Seq<Uint8Array>): EntryFunction
natual is deprecated, please use natural

@deprecated.
Parameters
- module: string
- func: string
- ty_args: Seq<TypeTag>
- args: Seq<Uint8Array>
Returns EntryFunction
- Defined in src/aptos_types/transaction.ts:180

`Static` natural

natural(module: string, func: string, ty_args: Seq<TypeTag>, args: Seq<Uint8Array>): EntryFunction
Example
A coin transfer function has one type argument "CoinType".
```
public(script) fun transfer<CoinType>(from: &signer, to: address, amount: u64,)
```
Example
A coin transfer function has three arugments "from", "to" and "amount".
```
public(script) fun transfer<CoinType>(from: &signer, to: address, amount: u64,)
```
Returns
Parameters
- module: string
  
  Fully qualified module name in format "AccountAddress::module_name" e.g. "0x1::coin"
- func: string
  
  Function name
- ty_args: Seq<TypeTag>
  
  Type arguments that move function requires.
- args: Seq<Uint8Array>
  
  Arugments to the move function.
Returns EntryFunction
- Defined in src/aptos_types/transaction.ts:171

Generated using TypeDoc