# StarknetSwapData

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:67](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L67)

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

## Extends

* [`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md)

## Constructors

### Constructor

```
new StarknetSwapData(args): StarknetSwapData;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:128](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L128)

Creates a new swap data based on the provided arguments

#### Parameters

| Parameter | Type                       | Description |
| --------- | -------------------------- | ----------- |
| `args`    | `StarknetSwapDataCtorArgs` |             |

#### Returns

`StarknetSwapData`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`constructor`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#constructor)

### Constructor

```
new StarknetSwapData(data): StarknetSwapData;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:135](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L135)

Deserializes the spv vault data from its serialized implementation (returned from [StarknetSwapData.serialize](#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](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L111)

***

### claimData

```
claimData: string;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:108](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L108)

***

### claimer

```
claimer: string;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:96](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L96)

***

### claimerBounty

```
claimerBounty: bigint;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:115](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L115)

***

### claimHandler

```
claimHandler: string;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:100](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L100)

***

### deserializers

```
static deserializers: object = {};
```

Defined in: [atomiq-base/src/swaps/SwapData.ts:14](https://github.com/atomiqlabs/atomiq-base/blob/df344bedbab9ab3de863e3c2d9246e90bd861d04/src/swaps/SwapData.ts#L14)

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`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`deserializers`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#deserializers)

***

### extraData?

```
optional extraData: string;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:117](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L117)

***

### feeToken

```
feeToken: string;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:113](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L113)

***

### kind

```
kind: ChainSwapType;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:121](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L121)

***

### offerer

```
offerer: string;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:95](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L95)

***

### payIn

```
payIn: boolean;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:104](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L104)

***

### payOut

```
payOut: boolean;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:103](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L103)

***

### refundData

```
refundData: string;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:109](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L109)

***

### refundHandler

```
refundHandler: string;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:99](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L99)

***

### reputation

```
reputation: boolean;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:105](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L105)

***

### securityDeposit

```
securityDeposit: bigint;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:114](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L114)

***

### sequence

```
sequence: bigint;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:106](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L106)

***

### successAction?

```
optional successAction: StarknetSuccessAction;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:119](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L119)

***

### token

```
token: string;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:97](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L97)

## Methods

### deserialize()

```
static deserialize<T>(data): T;
```

Defined in: [atomiq-base/src/swaps/SwapData.ts:23](https://github.com/atomiqlabs/atomiq-base/blob/df344bedbab9ab3de863e3c2d9246e90bd861d04/src/swaps/SwapData.ts#L23)

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

#### Type Parameters

| Type Parameter                                                                                                |
| ------------------------------------------------------------------------------------------------------------- |
| `T` *extends* [`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md) |

#### Parameters

| Parameter | Type  | Description |
| --------- | ----- | ----------- |
| `data`    | `any` |             |

#### Returns

`T`

#### Inherited from

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`deserialize`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#deserialize)

***

### equals()

```
equals(other): boolean;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:473](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L473)

Checks equality between 2 swap data objects

#### Parameters

| Parameter | Type               | Description |
| --------- | ------------------ | ----------- |
| `other`   | `StarknetSwapData` |             |

#### Returns

`boolean`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`equals`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#equals)

***

### fromSerializedFeltArray()

```
static fromSerializedFeltArray(span, claimHandlerImpl): StarknetSwapData;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:527](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L527)

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](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L252)

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

#### Returns

`bigint`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`getAmount`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#getamount)

***

### getClaimer()

```
getClaimer(): string;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:204](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L204)

Gets the claim, which receives funds from the escrow

#### Returns

`string`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`getClaimer`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#getclaimer)

***

### getClaimerBounty()

```
getClaimerBounty(): bigint;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:408](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L408)

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`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`getClaimerBounty`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#getclaimerbounty)

***

### getClaimHash()

```
getClaimHash(): string;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:344](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L344)

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`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`getClaimHash`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#getclaimhash)

***

### getConfirmationsHint()

```
getConfirmationsHint(): number;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:360](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L360)

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`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`getConfirmationsHint`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#getconfirmationshint)

***

### getDepositToken()

```
getDepositToken(): string;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:422](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L422)

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

#### Returns

`string`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`getDepositToken`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#getdeposittoken)

***

### getEscrowHash()

```
getEscrowHash(): string;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:308](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L308)

Returns a unique hash of this escrow

#### Returns

`string`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`getEscrowHash`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#getescrowhash)

***

### getEscrowStruct()

```
getEscrowStruct(): any;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:588](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L588)

Returns the JSON-serialization safe representation of the underlying swap escrow struct committed (or to-be-committed) on-chain

#### Returns

`any`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`getEscrowStruct`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#getescrowstruct)

***

### getExpiry()

```
getExpiry(): bigint;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:280](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L280)

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`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`getExpiry`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#getexpiry)

***

### getExtraData()

```
getExtraData(): string;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:387](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L387)

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

#### Returns

`string`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`getExtraData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#getextradata)

***

### getHTLCHashHint()

```
getHTLCHashHint(): string;
```

Defined in: [atomiq-base/src/swaps/SwapData.ts:164](https://github.com/atomiqlabs/atomiq-base/blob/df344bedbab9ab3de863e3c2d9246e90bd861d04/src/swaps/SwapData.ts#L164)

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`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`getHTLCHashHint`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#gethtlchashhint)

***

### getNonceHint()

```
getNonceHint(): bigint;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:369](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L369)

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`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`getNonceHint`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#getnoncehint)

***

### getOfferer()

```
getOfferer(): string;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:189](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L189)

Gets the offerer, which funds the escrow

#### Returns

`string`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`getOfferer`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#getofferer)

***

### getSecurityDeposit()

```
getSecurityDeposit(): bigint;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:401](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L401)

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`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`getSecurityDeposit`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#getsecuritydeposit)

***

### getSequence()

```
getSequence(): bigint;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:353](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L353)

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

#### Returns

`bigint`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`getSequence`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#getsequence)

***

### getToken()

```
getToken(): string;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:259](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L259)

Gets the address of the deposited token in a vault

#### Returns

`string`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`getToken`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#gettoken)

***

### getTotalDeposit()

```
getTotalDeposit(): bigint;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:415](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L415)

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`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`getTotalDeposit`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#gettotaldeposit)

***

### getTxoHashHint()

```
getTxoHashHint(): string;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:378](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L378)

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`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`getTxoHashHint`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#gettxohashhint)

***

### getType()

```
getType(): ChainSwapType;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:273](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L273)

Returns the type of this escrow

#### Returns

`ChainSwapType`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`getType`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#gettype)

***

### hasSuccessAction()

```
hasSuccessAction(): boolean;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:581](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L581)

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

#### Returns

`boolean`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`hasSuccessAction`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#hassuccessaction)

***

### isClaimData()

```
isClaimData(data): boolean;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:465](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L465)

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](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L437)

Checks whether the provided address is a claimer for this escrow

#### Parameters

| Parameter | Type     | Description |
| --------- | -------- | ----------- |
| `address` | `string` |             |

#### Returns

`boolean`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`isClaimer`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#isclaimer)

***

### isClaimHandler()

```
isClaimHandler(address): boolean;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:455](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L455)

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](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L429)

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`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`isDepositToken`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#isdeposittoken)

***

### isOfferer()

```
isOfferer(address): boolean;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:445](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L445)

Checks whether the provided address is an offerer for this escrow

#### Parameters

| Parameter | Type     | Description |
| --------- | -------- | ----------- |
| `address` | `string` |             |

#### Returns

`boolean`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`isOfferer`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#isofferer)

***

### isPayIn()

```
isPayIn(): boolean;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:287](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L287)

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`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`isPayIn`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#ispayin)

***

### isPayOut()

```
isPayOut(): boolean;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:294](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L294)

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`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`isPayOut`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#ispayout)

***

### isToken()

```
isToken(token): boolean;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:266](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L266)

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

#### Parameters

| Parameter | Type     | Description |
| --------- | -------- | ----------- |
| `token`   | `string` |             |

#### Returns

`boolean`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`isToken`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#istoken)

***

### isTrackingReputation()

```
isTrackingReputation(): boolean;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:301](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L301)

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

#### Returns

`boolean`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`isTrackingReputation`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#istrackingreputation)

***

### serialize()

```
serialize(): Serialized<StarknetSwapData> & object;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:221](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L221)

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

#### Returns

`Serialized`<`StarknetSwapData`> & `object`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`serialize`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#serialize)

***

### setClaimer()

```
setClaimer(newClaimer): void;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:211](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L211)

Sets the claimer which receives funds from the escrow

#### Parameters

| Parameter    | Type     | Description |
| ------------ | -------- | ----------- |
| `newClaimer` | `string` |             |

#### Returns

`void`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`setClaimer`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#setclaimer)

***

### setExtraData()

```
setExtraData(extraData): void;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:394](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L394)

Sets the extra data with hints for this escrow

#### Parameters

| Parameter   | Type     | Description |
| ----------- | -------- | ----------- |
| `extraData` | `string` |             |

#### Returns

`void`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`setExtraData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#setextradata)

***

### setOfferer()

```
setOfferer(newOfferer): void;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:196](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L196)

Sets the offerer to fund the escrow

#### Parameters

| Parameter    | Type     | Description |
| ------------ | -------- | ----------- |
| `newOfferer` | `string` |             |

#### Returns

`void`

#### Overrides

[`SwapData`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md).[`setOfferer`](https://docs.atomiq.exchange/sdk-reference/api/atomiq-sdk/src/classes/SwapData.md#setofferer)

***

### toEscrowStruct()

```
toEscrowStruct(): StringToPrimitiveType;
```

Defined in: [atomiq-chain-starknet/src/starknet/swaps/StarknetSwapData.ts:494](https://github.com/atomiqlabs/atomiq-chain-starknet/blob/697277c430597a8514a43540ef8b9a10e2b6a595/src/starknet/swaps/StarknetSwapData.ts#L494)

Serializes the swap data into starknet.js struct representation

#### Returns

`StringToPrimitiveType`