Class L1XCoreStubService

Represents a service for interacting with L1X core functionality through JSON-RPC communication. This service provides methods for querying chain state, account state, transaction receipts, events, and more.

See

Hierarchy

L1XTxService
- L1XCoreStubService

Constructors

constructor

new L1XCoreStubService(_client): L1XCoreStubService
Constructs a new instance of the L1XCoreStubService class.
Parameters
- _client: JSONRPCLib
  
  The JSON-RPC client for communication with the L1X core.
Returns L1XCoreStubService
Overrides L1XTxService.constructor
- Defined in src/services/L1XCoreStubService.ts:76

Properties

`Private` #client

#client: JSONRPCLib

The JSON-RPC client used for communication with the L1X core.

isClientConnected

isClientConnected: boolean = false

A boolean indicating whether the client is connected to the L1X core.

Methods

`Private` #handleFallbackValue

#handleFallbackValue(data, fallbackValue?): any
Private
Handles fallback values for data, providing a default if data is undefined or null.
Parameters
- data: any
  
  The data to handle fallback for.
- Optional fallbackValue: any
  
  The fallback value to use if data is undefined or null.
Returns any
- The original data or the fallback value if data is undefined or null.
- Defined in src/services/L1XCoreStubService.ts:99

`Private` #handleTransactionTypeTransformation

#handleTransactionTypeTransformation(transaction): any
Private
Handles transformation of transaction types, applying necessary value transformations.
Parameters
- transaction: any
  
  The transaction object to transform.
Returns any
- The transformed transaction object.
- Defined in src/services/L1XCoreStubService.ts:141

`Private` #transformTransactionEntity

#transformTransactionEntity(data): GetTransactionReceiptResponse
Private
Transforms the transaction entity to include required transformations.
Parameters
- data: any
  
  The data of the transaction entity to transform.
Returns GetTransactionReceiptResponse
- The transformed transaction entity.
- Defined in src/services/L1XCoreStubService.ts:272

`Private` #transformValue

#transformValue(data, option): any
Private
Transforms data based on the specified option.
Parameters
- data: any
  
  The data to transform.
- option: ValueTransformOption
  
  The transformation option to apply.
Returns any
- The transformed data.
- Defined in src/services/L1XCoreStubService.ts:117

broadcastTransaction

broadcastTransaction(txPayload): Promise<TransactionResponse>
Broadcasts a signed transaction payload to submit a native token (L1X coin) transfer.
Parameters
- txPayload: SignedTransactionPayload
  
  The signed transaction payload to be broadcasted.
Returns Promise<TransactionResponse>
- A promise that resolves to the transaction response containing the hash.
See
- SignedTransactionPayload
- TransactionResponse
- Defined in src/services/L1XCoreStubService.ts:721

calculateTransactionHash

calculateTransactionHash(signedPayload): Promise<string>
Calculate Transaction Hash
Parameters
- signedPayload: SignedTransactionPayload
  
  The signed transaction payload to calculate the hash for.
Returns Promise<string>
- A promise that resolves to the calculated transaction hash.
See
SignedTransactionPayload
- Defined in src/services/L1XCoreStubService.ts:679

estimateFeelimit

estimateFeelimit<k>(args): Promise<{
fee: string;
}>
Returns fee estimation for transaction
Type Parameters
- k extends keyof L1XVMTransaction
Parameters
- args: EstimateFeelimitArg<k>
  
  Transaction details
Returns Promise<{
fee: string;
}>
- Defined in src/services/L1XCoreStubService.ts:740

`Protected` generateCreateStakingPoolPayload

generateCreateStakingPoolPayload(payload): {
    contract_instance_address: any[];
    max_pool_balance: string;
    max_stake: string;
    min_pool_balance: string;
    min_stake: string;
    staking_period: string;
}
Parameters
- payload: TxCreateStakingPool
Returns {
    contract_instance_address: any[];
    max_pool_balance: string;
    max_stake: string;
    min_pool_balance: string;
    min_stake: string;
    staking_period: string;
}
- contract_instance_address: any[]
- max_pool_balance: string
- max_stake: string
- min_pool_balance: string
- min_stake: string
- staking_period: string
Inherited from L1XTxService.generateCreateStakingPoolPayload
- Defined in src/services/L1XTxService.ts:71

`Protected` generateNativeTransferPayload

generateNativeTransferPayload(payload): any
Parameters
- payload: TxNativeTokenTransfer
Returns any
Inherited from L1XTxService.generateNativeTransferPayload
- Defined in src/services/L1XTxService.ts:11

`Protected` generateSmartContractCallPayload

generateSmartContractCallPayload(payload): {
    arguments: any[];
    contract_instance_address: any[];
    deposit: string;
    function_name: any[];
}
Parameters
- payload: TxSmartContractFunctionCallV2
Returns {
    arguments: any[];
    contract_instance_address: any[];
    deposit: string;
    function_name: any[];
}
- arguments: any[]
- contract_instance_address: any[]
- deposit: string
- function_name: any[]
Inherited from L1XTxService.generateSmartContractCallPayload
- Defined in src/services/L1XTxService.ts:19

`Protected` generateSmartContractDeploymentPayload

generateSmartContractDeploymentPayload(payload): {
    access_type: AccessType;
    contract_code: any[];
    contract_type: ContractType;
    deposit: string;
    salt: any[];
}
Parameters
- payload: TxSmartContractDeploymentV2
Returns {
    access_type: AccessType;
    contract_code: any[];
    contract_type: ContractType;
    deposit: string;
    salt: any[];
}
- access_type: AccessType
- contract_code: any[]
- contract_type: ContractType
- deposit: string
- salt: any[]
Inherited from L1XTxService.generateSmartContractDeploymentPayload
- Defined in src/services/L1XTxService.ts:59

`Protected` generateSmartContractInitPayload

generateSmartContractInitPayload(payload): {
    arguments: any[];
    contract_code_address: any[];
    deposit: string;
}
Parameters
- payload: TxSmartContractInitV2
Returns {
    arguments: any[];
    contract_code_address: any[];
    deposit: string;
}
- arguments: any[]
- contract_code_address: any[]
- deposit: string
Inherited from L1XTxService.generateSmartContractInitPayload
- Defined in src/services/L1XTxService.ts:41

`Protected` generateStakePayload

generateStakePayload(payload): {
amount: string;
pool_address: any[];
}
Parameters
- payload: TxStake
Returns {
amount: string;
pool_address: any[];
}
- amount: string
- pool_address: any[]
Inherited from L1XTxService.generateStakePayload
- Defined in src/services/L1XTxService.ts:86

`Protected` generateUnStakePayload

generateUnStakePayload(payload): {
amount: string;
pool_address: any[];
}
Parameters
- payload: TxUnStake
Returns {
amount: string;
pool_address: any[];
}
- amount: string
- pool_address: any[]
Inherited from L1XTxService.generateUnStakePayload
- Defined in src/services/L1XTxService.ts:93

getAccountState

getAccountState(attrib): Promise<GetAccountStateResponse>
Retrieves the state of a specific account.
Parameters
- attrib: GetAccountStateArg
  
  The account state retrieval attributes.
Returns Promise<GetAccountStateResponse>
- A promise that resolves to the account state.
See
- GetAccountStateArg
- GetAccountStateResponse
- Defined in src/services/L1XCoreStubService.ts:360

getBlockByNumber

getBlockByNumber(attrib): Promise<GetBlockNumberResponse>
Retrieves information about a specific block using the block number.
Parameters
- attrib: GetBlockByNumberArg
  
  The attributes for block retrieval.
Returns Promise<GetBlockNumberResponse>
- A promise that resolves to the retrieved block information.
See
- GetBlockByNumberArg
- GetBlockNumberResponse
- Defined in src/services/L1XCoreStubService.ts:530

getChainState

getChainState(): Promise<GetChainStateResponse>
Retrieves the current chain state.

Returns Promise<GetChainStateResponse>
- A promise that resolves to the current chain state.
See
GetChainStateResponse
- Defined in src/services/L1XCoreStubService.ts:338

getCurrentNonce

getCurrentNonce(attrib): Promise<number>
Retrieves the current nonce for a given account.
Parameters
- attrib: GetCurrentNonceArg
  
  The attributes for nonce retrieval.
Returns Promise<number>
- A promise that resolves to the current nonce.
See
GetCurrentNonceArg
- Defined in src/services/L1XCoreStubService.ts:493

getEvents

getEvents(attrib): Promise<GetEventsResponse>
Retrieves events based on the provided attributes.
Parameters
- attrib: GetEventsArg
  
  The event retrieval attributes.
Returns Promise<GetEventsResponse>
- A promise that resolves to the retrieved events.
See
GetEventsArg
- Defined in src/services/L1XCoreStubService.ts:444

getSignedPayloadForTransfer

getSignedPayloadForTransfer(attrib): Promise<SignedTransactionPayload>
Generates a signed transaction payload for a native token (L1X coin) transfer operation.
Parameters
- attrib: NativeTokenTransferArg
  
  The attributes for the token transfer.
Returns Promise<SignedTransactionPayload>
- A promise that resolves to the signed transaction payload.
Throws
- Throws an error if there is an issue retrieving the current nonce.
See
- NativeTokenTransferArg
- SignedTransactionPayload
- Defined in src/services/L1XCoreStubService.ts:581

getStake

getStake(attrib): Promise<any>
WIP: Retrieves stake information based on the provided attributes.
Parameters
- attrib: GetStakeArg
  
  The attributes for stake retrieval.
Returns Promise<any>
- A promise that resolves to the retrieved stake information.
See
GetStakeArg
- Defined in src/services/L1XCoreStubService.ts:510

getTransactionReceipt

getTransactionReceipt(attrib): Promise<GetTransactionReceiptResponse>
Retrieves the receipt of a specific transaction.
Parameters
- attrib: GetTransactionReceiptArg
  
  The transaction receipt retrieval attributes.
Returns Promise<GetTransactionReceiptResponse>
- A promise that resolves to the transaction receipt.
See
- GetTransactionReceiptArg
- GetTransactionReceiptResponse
- Defined in src/services/L1XCoreStubService.ts:421

getTransactionsByAccount

getTransactionsByAccount(attrib): Promise<GetTransactionReceiptResponse[]>
Retrieves transactions associated with a specific account.
Parameters
- attrib: GetTransactionsByAccountArg
  
  The transaction retrieval attributes.
Returns Promise<GetTransactionReceiptResponse[]>
- A promise that resolves to an array of transaction receipts.
See
- GetTransactionsByAccountArg
- GetTransactionReceiptResponse
- Defined in src/services/L1XCoreStubService.ts:467

transfer

transfer(attrib): Promise<TransactionResponse>
Initiates a native token(L1X coin) transfer operation.
Parameters
- attrib: NativeTokenTransferArg
  
  The attributes for token transfer.
Returns Promise<TransactionResponse>
- A promise that resolves to the result of the token transfer.
See
NativeTokenTransferArg
- Defined in src/services/L1XCoreStubService.ts:567

Class L1XCoreStubService

See

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

_client: JSONRPCLib

Returns L1XCoreStubService

Properties

Private #client

isClientConnected

Methods

Private #handleFallbackValue

Parameters

data: any

Optional fallbackValue: any

Returns any

Private #handleTransactionTypeTransformation

Parameters

transaction: any

Returns any

Private #transformTransactionEntity

Parameters

data: any

Returns GetTransactionReceiptResponse

Private #transformValue

Parameters

data: any

option: ValueTransformOption

Returns any

broadcastTransaction

Parameters

txPayload: SignedTransactionPayload

Returns Promise<TransactionResponse>

See

calculateTransactionHash

Parameters

signedPayload: SignedTransactionPayload

Returns Promise<string>

See

estimateFeelimit

Type Parameters

k extends keyof L1XVMTransaction

Parameters

args: EstimateFeelimitArg<k>

Returns Promise<{ fee: string; }>

Protected generateCreateStakingPoolPayload

Parameters

payload: TxCreateStakingPool

Returns { contract_instance_address: any[]; max_pool_balance: string; max_stake: string; min_pool_balance: string; min_stake: string; staking_period: string; }

contract_instance_address: any[]

max_pool_balance: string

max_stake: string

min_pool_balance: string

min_stake: string

staking_period: string

Protected generateNativeTransferPayload

Parameters

payload: TxNativeTokenTransfer

Returns any

Protected generateSmartContractCallPayload

Parameters

payload: TxSmartContractFunctionCallV2

Returns { arguments: any[]; contract_instance_address: any[]; deposit: string; function_name: any[]; }

arguments: any[]

contract_instance_address: any[]

deposit: string

function_name: any[]

Protected generateSmartContractDeploymentPayload

Parameters

payload: TxSmartContractDeploymentV2

Returns { access_type: AccessType; contract_code: any[]; contract_type: ContractType; deposit: string; salt: any[]; }

access_type: AccessType

contract_code: any[]

contract_type: ContractType

deposit: string

`Private` #client

`Private` #handleFallbackValue

`Optional` fallbackValue: any

`Private` #handleTransactionTypeTransformation

`Private` #transformTransactionEntity

`Private` #transformValue

Returns Promise<{
fee: string;
}>

`Protected` generateCreateStakingPoolPayload

Returns {
contract_instance_address: any[];
max_pool_balance: string;
max_stake: string;
min_pool_balance: string;
min_stake: string;
staking_period: string;
}

`Protected` generateNativeTransferPayload

`Protected` generateSmartContractCallPayload

Returns {
arguments: any[];
contract_instance_address: any[];
deposit: string;
function_name: any[];
}

`Protected` generateSmartContractDeploymentPayload

Returns {
access_type: AccessType;
contract_code: any[];
contract_type: ContractType;
deposit: string;
salt: any[];
}

`Protected` generateSmartContractInitPayload

Returns {
arguments: any[];
contract_code_address: any[];
deposit: string;
}

`Protected` generateStakePayload

Returns {
amount: string;
pool_address: any[];
}

`Protected` generateUnStakePayload

Returns {
amount: string;
pool_address: any[];
}