StarknetSpvVaultData

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:43

Represents the state of the SPV vault (UTXO-controlled vault)

Extends

• SpvVaultData<StarknetSpvWithdrawalData>

Constructors

Constructor

new StarknetSpvVaultData(args): StarknetSpvVaultData;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:71

Creates a new spv vault data based on the provided arguments

Parameters

Parameter	Type	Description
args	StarknetSpvVaultDataCtorArgs

Returns

StarknetSpvVaultData

Overrides

SpvVaultData.constructor

Constructor

new StarknetSpvVaultData(data): StarknetSpvVaultData;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:78

Deserializes the spv vault data from its serialized implementation (returned from StarknetSpvVaultData.serialize)

Parameters

Parameter	Type	Description
data	Serialized<StarknetSpvVaultData> & object

Returns

StarknetSpvVaultData

Overrides

SpvVaultData<StarknetSpvWithdrawalData>.constructor

Properties

confirmations

readonly confirmations: number;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:60

---

depositCount

depositCount: number;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:64

---

deserializers

static deserializers: object = {};

Defined in: atomiq-base/src/spv_swap/SpvVaultData.ts:50

A mapping of deserializers for different spv vault data types coming from different smart chain implementations

Index Signature

[type: string]: (serialized) => any

Inherited from

SpvVaultData.deserializers

---

initialUtxo?

readonly optional initialUtxo: string;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:59

---

owner

readonly owner: string;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:45

---

relayContract

readonly relayContract: string;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:48

---

token0

readonly token0: object;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:49

multiplier

multiplier: bigint;

rawAmount

rawAmount: bigint;

token

token: string;

---

token1

readonly token1: object;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:54

multiplier

multiplier: bigint;

rawAmount

rawAmount: bigint;

token

token: string;

---

utxo

utxo: string;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:62

---

vaultId

readonly vaultId: bigint;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:46

---

withdrawCount

withdrawCount: number;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:63

Methods

calculateStateAfter()

calculateStateAfter(priorWithdrawalTxs): object;

Defined in: atomiq-base/src/spv_swap/SpvVaultData.ts:129

A helper function which calculates the vault balances after processing an array of claims (withdrawals)

Parameters

Parameter	Type	Description
priorWithdrawalTxs	StarknetSpvWithdrawalData[]

Returns

object

Name	Type	Defined in
balances	SpvVaultTokenBalance[]	atomiq-base/src/spv_swap/SpvVaultData.ts:129
withdrawalCount	number	atomiq-base/src/spv_swap/SpvVaultData.ts:129

Inherited from

SpvVaultData.calculateStateAfter

---

deserialize()

static deserialize<T>(data): T;

Defined in: atomiq-base/src/spv_swap/SpvVaultData.ts:59

Deserializer parsing the chain-specific spv vault data from a JSON-compatible object representation

Type Parameters

Type Parameter
T extends SpvVaultData<SpvWithdrawalTransactionData>

Parameters

Parameter	Type	Description
data	any

Returns

T

Inherited from

SpvVaultData.deserialize

---

getBalances()

getBalances(): SpvVaultTokenBalance[];

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:131

Returns the token balance currently available in the vault

Returns

SpvVaultTokenBalance[]

Overrides

SpvVaultData.getBalances

---

getConfirmations()

getConfirmations(): number;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:141

Gets the required number of confirmations that a bitcoin transaction has to get in order for the vault claim (withdrawal) to be authorized

Returns

number

Overrides

SpvVaultData.getConfirmations

---

getDepositCount()

getDepositCount(): number;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:253

Returns the current number of deposits deposited into the vault

Returns

number

Overrides

SpvVaultData.getDepositCount

---

getOwner()

getOwner(): string;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:148

Gets the owner of the vault

Returns

string

Overrides

SpvVaultData.getOwner

---

getTokenData()

getTokenData(): SpvVaultTokenData[];

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:155

Returns the configuration of the tokens supported by the vault

Returns

SpvVaultTokenData[]

Overrides

SpvVaultData.getTokenData

---

getUtxo()

getUtxo(): string;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:162

Returns the UTXO in [txId]:[vout] format which currently controls the vault

Returns

string

Overrides

SpvVaultData.getUtxo

---

getVaultId()

getVaultId(): bigint;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:169

Gets the vault ID, this along with the owner uniquely identifies a vault

Returns

bigint

Overrides

SpvVaultData.getVaultId

---

getWithdrawalCount()

getWithdrawalCount(): number;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:176

Returns the current number of claims (withdrawals) processed by the vault

Returns

number

Overrides

SpvVaultData.getWithdrawalCount

---

isOpened()

isOpened(): boolean;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:183

Checks whether a vault is opened and available to process claims (withdrawals)

Returns

boolean

Overrides

SpvVaultData.isOpened

---

serialize()

serialize(): Serialized<StarknetSpvVaultData> & object;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:190

Serializes the object to a JSON-compatible object (i.e. no bigints, functions, etc.)

Returns

Serialized<StarknetSpvVaultData> & object

Overrides

SpvVaultData.serialize

---

updateState()

updateState(withdrawalTxOrEvent): void;

Defined in: atomiq-chain-starknet/src/starknet/spv_swap/StarknetSpvVaultData.ts:217

Updates the state of the spv vault data from either an on-chain event or a SpvWithdrawalTransactionData

Parameters

Parameter	Type	Description
withdrawalTxOrEvent	| SpvVaultOpenEvent | SpvVaultDepositEvent | SpvVaultClaimEvent | SpvVaultCloseEvent | StarknetSpvWithdrawalData

Returns

void

Overrides

SpvVaultData.updateState