DepositOptions

Defined in: packages/synapse-sdk/src/payments/service.ts:24

Options for deposit operation

Properties

amount

amount: bigint

Defined in: packages/synapse-sdk/src/payments/service.ts:28

The amount to deposit

---

onAllowanceCheck()?

optional onAllowanceCheck: (current, required) => void

Defined in: packages/synapse-sdk/src/payments/service.ts:33

Called when checking current allowance

Parameters

Parameter	Type
current	bigint
required	bigint

Returns

void

---

onApprovalConfirmed()?

optional onApprovalConfirmed: (receipt) => void

Defined in: packages/synapse-sdk/src/payments/service.ts:37

Called when approval is confirmed

Parameters

Parameter	Type
receipt	TransactionReceipt

Returns

void

---

onApprovalTransaction()?

optional onApprovalTransaction: (tx) => void

Defined in: packages/synapse-sdk/src/payments/service.ts:35

Called when approval transaction is sent

Parameters

Parameter	Type
tx	`0x${string}`

Returns

void

---

onDepositStarting()?

optional onDepositStarting: () => void

Defined in: packages/synapse-sdk/src/payments/service.ts:39

Called before deposit transaction is sent

Returns

void

---

to?

optional to: `0x${string}`

Defined in: packages/synapse-sdk/src/payments/service.ts:26

Optional recipient address (defaults to wallet address if not provided)

---

token?

optional token: string

Defined in: packages/synapse-sdk/src/payments/service.ts:31

The token to deposit (defaults to USDFC)