Search K

Appearance

FUZD / fuzd-chain-protocol / starknet / StarknetChainProtocol

Class: StarknetChainProtocol ​

Implements ​

Constructors ​

new StarknetChainProtocol() ​

new StarknetChainProtocol(url, config): StarknetChainProtocol

Parameters ​

url ​

string | RequestRPC<Methods>

config ​
accountContractClassHash ​

String0x

contractTimestamp ​

String0x

expectedFinality ​

number

tokenContractAddress ​

String0x

worstCaseBlockTime ​

number

Returns ​

StarknetChainProtocol

Defined in ​

starknet/index.ts:97

Properties ​

config ​

readonly config: object

accountContractClassHash ​

accountContractClassHash: String0x

contractTimestamp? ​

optional contractTimestamp: String0x

expectedFinality ​

expectedFinality: number

tokenContractAddress ​

tokenContractAddress: String0x

worstCaseBlockTime ​

worstCaseBlockTime: number

Implementation of ​

ChainProtocol.config

Defined in ​

starknet/index.ts:99

offset ​

offset: number = 0

Defined in ​

starknet/index.ts:465

url ​

readonly url: string | RequestRPC<Methods>

Defined in ​

starknet/index.ts:98

Methods ​

_createFullTransaction() ​

_createFullTransaction(chainId, transactionData, broadcaster, transactionParameters): object

Parameters ​

chainId ​

IntegerString

transactionData ​

StarknetTransactionData

broadcaster ​

BroadcasterSignerData

transactionParameters ​

TransactionParametersUsed

Returns ​

object

hash ​

hash: String0x

rawTx ​

rawTx: FullStarknetTransactionData

transactionData ​

transactionData: StarknetTransactionData

Defined in ​

starknet/index.ts:547

_getStarknetSigner() ​

_getStarknetSigner(account, forAddress): Promise<{ private_key: string; public_key: string; }>

Parameters ​

account ​

ETHAccount

forAddress ​

String0x

Returns ​

Promise<{ private_key: string; public_key: string; }>

Defined in ​

starknet/index.ts:527

_validateDerivationParameters() ​

_validateDerivationParameters(parameters): Promise<{ success: true; } | { error: string; success: false; }>

Parameters ​

parameters ​

DerivationParameters

Returns ​

Promise<{ success: true; } | { error: string; success: false; }>

Defined in ​

starknet/index.ts:496

broadcastSignedTransaction() ​

broadcastSignedTransaction(tx): Promise<String0x>

Parameters ​

tx ​

any

Returns ​

Promise<String0x>

Implementation of ​

ChainProtocol.broadcastSignedTransaction

Defined in ​

starknet/index.ts:212

checkValidity() ​

checkValidity(chainId, transactionData, broadcaster, transactionParameters): Promise<{ revert: "unknown"; } | { notEnoughGas: boolean; revert: boolean; }>

Parameters ​

chainId ​

IntegerString

transactionData ​

StarknetTransactionData

broadcaster ​

BroadcasterSignerData

transactionParameters ​

TransactionParametersUsed

Returns ​

Promise<{ revert: "unknown"; } | { notEnoughGas: boolean; revert: boolean; }>

Implementation of ​

ChainProtocol.checkValidity

Defined in ​

starknet/index.ts:313

computeMaxCostAuthorized() ​

computeMaxCostAuthorized(chainId, transactionData, maxFeePerGasAuthorized): Promise<bigint>

Parameters ​

chainId ​

IntegerString

transactionData ​

StarknetTransactionData

maxFeePerGasAuthorized ​

String0x

Returns ​

Promise<bigint>

Implementation of ​

ChainProtocol.computeMaxCostAuthorized

Defined in ​

starknet/index.ts:353

generatePaymentTransaction() ​

generatePaymentTransaction(transactionData, maxFeePerGas, from, diffToCover): object

Parameters ​

transactionData ​

StarknetTransactionData

maxFeePerGas ​

bigint

from ​

String0x

diffToCover ​

bigint

Returns ​

object

cost ​

cost: bigint

transaction ​

transaction: StarknetTransactionData

valueSent ​

valueSent: bigint

Implementation of ​

ChainProtocol.generatePaymentTransaction

Defined in ​

starknet/index.ts:430

getBalance() ​

getBalance(account): Promise<bigint>

Parameters ​

account ​

String0x

Returns ​

Promise<bigint>

Implementation of ​

ChainProtocol.getBalance

Defined in ​

starknet/index.ts:197

getBroadcaster() ​

getBroadcaster(account, parameters, forAddress): Promise<BroadcasterSignerData>

Parameters ​

account ​

ETHAccount

parameters ​

DerivationParameters

forAddress ​

String0x

Returns ​

Promise<BroadcasterSignerData>

Implementation of ​

ChainProtocol.getBroadcaster

Defined in ​

starknet/index.ts:290

getDerivationParameters() ​

getDerivationParameters(account): Promise<DerivationParameters>

Parameters ​

account ​

ETHAccount

Returns ​

Promise<DerivationParameters>

Implementation of ​

ChainProtocol.getDerivationParameters

Defined in ​

starknet/index.ts:281

getGasFee() ​

getGasFee(executionData, importanceRatio): Promise<GasEstimate>

Parameters ​

executionData ​
maxFeePerGasAuthorized ​

String0x

importanceRatio ​

number

Returns ​

Promise<GasEstimate>

Implementation of ​

ChainProtocol.getGasFee

Defined in ​

starknet/index.ts:247

getNonce() ​

getNonce(account): Promise<String0x>

Parameters ​

account ​

String0x

Returns ​

Promise<String0x>

Implementation of ​

ChainProtocol.getNonce

Defined in ​

starknet/index.ts:233

getTimestamp() ​

getTimestamp(): Promise<number>

Returns ​

Promise<number>

Implementation of ​

ChainProtocol.getTimestamp

Defined in ​

starknet/index.ts:466

getTransactionStatus() ​

getTransactionStatus(transaction): Promise<TransactionStatus>

Parameters ​

transaction ​

Transaction

Returns ​

Promise<TransactionStatus>

Implementation of ​

ChainProtocol.getTransactionStatus

Defined in ​

starknet/index.ts:110

increaseTime() ​

increaseTime(amount): Promise<void>

Parameters ​

amount ​

number

Returns ​

Promise<void>

Implementation of ​

ChainProtocol.increaseTime

Defined in ​

starknet/index.ts:488

isTransactionPending() ​

isTransactionPending(txHash): Promise<boolean>

Parameters ​

txHash ​

String0x

Returns ​

Promise<boolean>

Implementation of ​

ChainProtocol.isTransactionPending

Defined in ​

starknet/index.ts:184

requiredPreliminaryTransaction() ​

requiredPreliminaryTransaction(chainId, broadcaster, account): StarknetTransactionData

Parameters ​

chainId ​

string

broadcaster ​

BroadcasterSignerData

account ​

String0x

Returns ​

StarknetTransactionData

Implementation of ​

ChainProtocol.requiredPreliminaryTransaction

Defined in ​

starknet/index.ts:396

signTransaction() ​

signTransaction(chainId, data, broadcaster, transactionParameters): Promise<{ hash: String0x; rawTx: any; }>

Parameters ​

chainId ​

IntegerString

data ​

StarknetTransactionData

broadcaster ​

BroadcasterSignerData

transactionParameters ​

TransactionParametersUsed

Returns ​

Promise<{ hash: String0x; rawTx: any; }>

Implementation of ​

ChainProtocol.signTransaction

Defined in ​

starknet/index.ts:364

validateDerivationParameters() ​

validateDerivationParameters(parameters): Promise<{ success: true; } | { error: string; success: false; }>

Parameters ​

parameters ​

DerivationParameters

Returns ​

Promise<{ success: true; } | { error: string; success: false; }>

Implementation of ​

ChainProtocol.validateDerivationParameters

Defined in ​

starknet/index.ts:270