## Types
### Signature
```typescript
export type Signature = {
data: object
signature: { v: number; r: string; s: string; deadline: number }
}
/* data object
interface SignAuction {
loan: SignLoanConfig;
assets: string[];
assetPrice: BigInt;
assetLtv: BigInt;
endTime: BigInt;
nonce: BigInt;
deadline: BigInt;
}
interface SignLoanConfig {
loanId: string;
aggLoanPrice: BigInt;
aggLtv: BigInt;
aggLiquidationThreshold: BigInt;
totalAssets: BigInt;
nonce: BigInt;
deadline: BigInt;
}
*/
```
### ClientOptions
```typescript
export type ClientOptions = {
network?: Chain
}
export type Chain = 'mainnet' | 'sepolia' | 'localhost'
```
## Functions
### Placing a Bid
To place a bid in an auction, use the `bid` function from the `auction` module:
```typescript
export const bid = async (
amountToPay: BigInt,
amountOfDebt: BigInt,
signature: Signature,
options?: ClientOptions
)
```
```typescript
const result = await bid(amountToPay, amountOfDebt, signature, options?);
```
### Redeeming an Auction
To redeem an auction, use the `redeem` function from the `auction` module:
```typescript
export const redeem = async (
signature: Signature,
options?: ClientOptions
)
```
```typescript
const result = await redeem(signature, options?);
```
### Finalizing an Auction
To finalize an auction, use the `finalize` function from the `auction` module:
```typescript
export const finalize = async (
claimOnUWallet: boolean,
orderId: string,
signature: Signature,
options?: ClientOptions
)
```
```typescript
const result = await finalize(claimOnUWallet, orderId, signature, options?);
```
***
Refer to the Auction Module documentation for more details on the `bid`, `redeem` and`finalize`functions.
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://sdk.unlockd.finance/getting-started/sdk-modules/auction-module.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.