StarknetSwapData

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:67

Represents swap data for executing PrTLC (on-chain) or HTLC (lightning) based swaps

Extends

• SwapData

Constructors

Constructor

new StarknetSwapData(args): StarknetSwapData;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:128

Creates a new swap data based on the provided arguments

Parameters

Parameter	Type	Description
args	StarknetSwapDataCtorArgs

Returns

StarknetSwapData

Overrides

SwapData.constructor

Constructor

new StarknetSwapData(data): StarknetSwapData;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:135

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

Parameters

Parameter	Type	Description
data	Serialized<StarknetSwapData> & object

Returns

StarknetSwapData

Overrides

SwapData.constructor

Properties

amount

amount: bigint;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:111

---

claimData

claimData: string;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:108

---

claimer

claimer: string;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:96

---

claimerBounty

claimerBounty: bigint;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:115

---

claimHandler

claimHandler: string;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:100

---

deserializers

static deserializers: object = {};

Defined in: atomiq-base/src/swaps/SwapData.ts:14

A mapping of deserializers for different escrow swap data types coming from different smart chain implementations

Index Signature

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

Inherited from

SwapData.deserializers

---

extraData?

optional extraData: string;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:117

---

feeToken

feeToken: string;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:113

---

kind

kind: ChainSwapType;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:121

---

offerer

offerer: string;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:95

---

payIn

payIn: boolean;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:104

---

payOut

payOut: boolean;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:103

---

refundData

refundData: string;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:109

---

refundHandler

refundHandler: string;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:99

---

reputation

reputation: boolean;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:105

---

securityDeposit

securityDeposit: bigint;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:114

---

sequence

sequence: bigint;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:106

---

successAction?

optional successAction: StarknetSuccessAction;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:119

---

token

token: string;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:97

Methods

deserialize()

static deserialize<T>(data): T;

Defined in: atomiq-base/src/swaps/SwapData.ts:23

Deserializer parsing the chain-specific escrow swap data from a JSON-compatible object representation

Type Parameters

Type Parameter
T extends SwapData

Parameters

Parameter	Type	Description
data	any

Returns

T

Inherited from

SwapData.deserialize

---

equals()

equals(other): boolean;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:473

Checks equality between 2 swap data objects

Parameters

Parameter	Type	Description
other	StarknetSwapData

Returns

boolean

Overrides

SwapData.equals

---

fromSerializedFeltArray()

static fromSerializedFeltArray(span, claimHandlerImpl): StarknetSwapData;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:527

Deserializes swap data from the provided felt252 array,

Parameters

Parameter	Type	Description
span	BigNumberish[]	a felt252 array of length 16 or more
claimHandlerImpl	IClaimHandler<any, any>	Claim handler implementation to parse the swap type, this is checked for internally and this throws an error if the passed claimHandlerImpl doesn't match the claim handler address in the passed swap data

Returns

StarknetSwapData

---

getAmount()

getAmount(): bigint;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:252

Gets the amount of token deposited into the vault by the offerer

Returns

bigint

Overrides

SwapData.getAmount

---

getClaimer()

getClaimer(): string;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:204

Gets the claim, which receives funds from the escrow

Returns

string

Overrides

SwapData.getClaimer

---

getClaimerBounty()

getClaimerBounty(): bigint;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:408

Gets the claimer bounty, an amount of native tokens deposited by the caller (initiator) on escrow initialization, that is paid out to a caller which claims the escrow as a reward, otherwise returned to the claimer if escrow is refunded

Returns

bigint

Overrides

SwapData.getClaimerBounty

---

getClaimHash()

getClaimHash(): string;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:344

Returns the claim hash of the escrow, this specifies a condition that needs to be satisfied to claim the funds from the escrow

Returns

string

Overrides

SwapData.getClaimHash

---

getConfirmationsHint()

getConfirmationsHint(): number;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:360

Retrieves required number of confirmations as a hint from the extra data provided, or null if no extra data has been provided when creating the escrow

Returns

number

Overrides

SwapData.getConfirmationsHint

---

getDepositToken()

getDepositToken(): string;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:422

Returns the token used for the deposit (security deposit & claimer bounty) (usually a native token of the underlying smart chain)

Returns

string

Overrides

SwapData.getDepositToken

---

getEscrowHash()

getEscrowHash(): string;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:308

Returns a unique hash of this escrow

Returns

string

Overrides

SwapData.getEscrowHash

---

getExpiry()

getExpiry(): bigint;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:280

Returns the expiration time of this escrow, after the timeout an offerer is able to refund unilaterally. taking back funds from the escrow

Returns

bigint

Overrides

SwapData.getExpiry

---

getExtraData()

getExtraData(): string;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:387

Gets the extraneous data specified when creating this escrow, this provides helpers for 3rd party claimers

Returns

string

Overrides

SwapData.getExtraData

---

getHTLCHashHint()

getHTLCHashHint(): string;

Defined in: atomiq-base/src/swaps/SwapData.ts:164

Retrieves a hint providing an HTLC hash from the extra data provided, or null if no extra data has been provided when creating the escrow

Returns

string

Inherited from

SwapData.getHTLCHashHint

---

getNonceHint()

getNonceHint(): bigint;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:369

Retrieves the PrTLC transaction nonce as a hint from the extra data provided, or null if no extra data has been provided when creating the escrow

Returns

bigint

Overrides

SwapData.getNonceHint

---

getOfferer()

getOfferer(): string;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:189

Gets the offerer, which funds the escrow

Returns

string

Overrides

SwapData.getOfferer

---

getSecurityDeposit()

getSecurityDeposit(): bigint;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:401

Gets the security deposit, which is an amount of native tokens deposited by the caller (initiator) on escrow initialization to guarantee the execution, this acts as a compensation for offerer if he has to refund the escrow, otherwise it is returned back to claimer after a successful claim of the escrow

Returns

bigint

Overrides

SwapData.getSecurityDeposit

---

getSequence()

getSequence(): bigint;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:353

Returns a random variable sequence of this vault, used to ensure the escrow hash is always different

Returns

bigint

Overrides

SwapData.getSequence

---

getToken()

getToken(): string;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:259

Gets the address of the deposited token in a vault

Returns

string

Overrides

SwapData.getToken

---

getTotalDeposit()

getTotalDeposit(): bigint;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:415

Returns the total deposit in native token to be deposited by the caller (initiator) on escrow initialization, due to how claimer bounty and security deposits work, this is basically a max(claimer bounty, security deposit), because either a swap is claimed (and claimer bounty is paid) or a swap is refunded (and security deposit is paid), never both!

Returns

bigint

Overrides

SwapData.getTotalDeposit

---

getTxoHashHint()

getTxoHashHint(): string;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:378

Retrieves the PrTLC transaction txo (transaction output) hash as a hint from the extra data provided, or null if no extra data has been provided when creating the escrow

Returns

string

Overrides

SwapData.getTxoHashHint

---

getType()

getType(): ChainSwapType;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:273

Returns the type of this escrow

Returns

ChainSwapType

Overrides

SwapData.getType

---

hasSuccessAction()

hasSuccessAction(): boolean;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:581

Checks whether the escrow contains an execution action (swap+)

Returns

boolean

Overrides

SwapData.hasSuccessAction

---

isClaimData()

isClaimData(data): boolean;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:465

Checks if the passed data match the swap's claim data

Parameters

Parameter	Type	Description
data	string

Returns

boolean

---

isClaimer()

isClaimer(address): boolean;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:437

Checks whether the provided address is a claimer for this escrow

Parameters

Parameter	Type	Description
address	string

Returns

boolean

Overrides

SwapData.isClaimer

---

isClaimHandler()

isClaimHandler(address): boolean;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:455

Checks whether the passed address is specified as a claim handler for the swap

Parameters

Parameter	Type	Description
address	string

Returns

boolean

---

isDepositToken()

isDepositToken(token): boolean;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:429

Checks whether a provided token is used as a deposit token (security deposit & claimer bounty) for the escrow

Parameters

Parameter	Type	Description
token	string

Returns

boolean

Overrides

SwapData.isDepositToken

---

isOfferer()

isOfferer(address): boolean;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:445

Checks whether the provided address is an offerer for this escrow

Parameters

Parameter	Type	Description
address	string

Returns

boolean

Overrides

SwapData.isOfferer

---

isPayIn()

isPayIn(): boolean;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:287

Whether this escrow will be funded from the offerer's wallet or from the offerer's vault inside the contract, when true it takes funds normally from the offerer's address, when false it pulls the funds from the offerer's vault inside the contract

Returns

boolean

Overrides

SwapData.isPayIn

---

isPayOut()

isPayOut(): boolean;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:294

Whether this escrow will pay out the claimer, when true it pays out normally to the claimer's address, when false it instead keeps the funds inside the contract and assigns them to the claimer's vault inside the contract

Returns

boolean

Overrides

SwapData.isPayOut

---

isToken()

isToken(token): boolean;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:266

Checks whether the provided token address is the actual token used by this escrow

Parameters

Parameter	Type	Description
token	string

Returns

boolean

Overrides

SwapData.isToken

---

isTrackingReputation()

isTrackingReputation(): boolean;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:301

Whether the outcome of this escrow should be used to track reputation of the claimer

Returns

boolean

Overrides

SwapData.isTrackingReputation

---

serialize()

serialize(): Serialized<StarknetSwapData> & object;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:221

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

Returns

Serialized<StarknetSwapData> & object

Overrides

SwapData.serialize

---

setClaimer()

setClaimer(newClaimer): void;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:211

Sets the claimer which receives funds from the escrow

Parameters

Parameter	Type	Description
newClaimer	string

Returns

void

Overrides

SwapData.setClaimer

---

setExtraData()

setExtraData(extraData): void;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:394

Sets the extra data with hints for this escrow

Parameters

Parameter	Type	Description
extraData	string

Returns

void

Overrides

SwapData.setExtraData

---

setOfferer()

setOfferer(newOfferer): void;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:196

Sets the offerer to fund the escrow

Parameters

Parameter	Type	Description
newOfferer	string

Returns

void

Overrides

SwapData.setOfferer

---

toEscrowStruct()

toEscrowStruct(): StringToPrimitiveType;

Defined in: atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:494

Serializes the swap data into starknet.js struct representation

Returns

StringToPrimitiveType