Unit

https://docs.hyperunit.xyz
Admin
Unit is an asset tokenization layer on Hyperliquid that enables seamless deposits and withdrawals of...
Tokens:19,229
Snippets:122
Trust Score:7.5
Update:9 months ago
Show doc for...
Tokens:
Raw
### GET /v2/estimate-fees

Source: https://docs.hyperunit.xyz/developers/api/estimate-fees

Fetches the current fee rates and estimated processing times for various cryptocurrency networks, supporting both deposits and withdrawals.

```APIDOC
## GET /v2/estimate-fees

### Description
This endpoint retrieves the current fee rates and expected processing times for network transactions across different cryptocurrencies. It provides details for both deposit and withdrawal operations.

### Method
GET

### Endpoint
/v2/estimate-fees

### Parameters

#### Query Parameters
(None specified)

#### Request Body
(None specified)

### Request Example
(Not applicable for GET request without parameters)

### Response
#### Success Response (200)
- **bitcoin** (object) - Fee and eta details for Bitcoin transactions.
  - **bitcoin-deposit-fee-rate-sats-per-vb** (number) - Fee rate for Bitcoin deposits in satoshis per virtual byte.
  - **bitcoin-deposit-size-v-bytes** (number) - Estimated size of a Bitcoin deposit transaction in virtual bytes.
  - **bitcoin-depositEta** (string) - Estimated time for Bitcoin deposit confirmation.
  - **bitcoin-depositFee** (number) - Total estimated fee for a Bitcoin deposit.
  - **bitcoin-withdrawal-fee-rate-sats-per-vb** (number) - Fee rate for Bitcoin withdrawals in satoshis per virtual byte.
  - **bitcoin-withdrawal-size-v-bytes** (number) - Estimated size of a Bitcoin withdrawal transaction in virtual bytes.
  - **bitcoin-withdrawalEta** (string) - Estimated time for Bitcoin withdrawal confirmation.
  - **bitcoin-withdrawalFee** (number) - Total estimated fee for a Bitcoin withdrawal.
- **ethereum** (object) - Fee and eta details for Ethereum transactions.
  - **ethereum-base-fee** (number) - Base fee for Ethereum transactions.
  - **ethereum-depositEta** (string) - Estimated time for Ethereum deposit confirmation.
  - **ethereum-depositFee** (number) - Total estimated fee for an Ethereum deposit.
  - **ethereum-erc20-deposit-fee** (number) - Estimated fee for ERC-20 token deposits on Ethereum.
  - **ethereum-erc20-deposit-gas** (number) - Estimated gas limit for ERC-20 token deposits.
  - **ethereum-erc20-withdrawal-fee** (number) - Estimated fee for ERC-20 token withdrawals on Ethereum.
  - **ethereum-erc20-withdrawal-gas** (number) - Estimated gas limit for ERC-20 token withdrawals.
  - **ethereum-eth-deposit-gas** (number) - Estimated gas limit for ETH deposits.
  - **ethereum-eth-withdrawal-gas** (number) - Estimated gas limit for ETH withdrawals.
  - **ethereum-priority-fee** (number) - Priority fee for Ethereum transactions.
  - **ethereum-withdrawalEta** (string) - Estimated time for Ethereum withdrawal confirmation.
  - **ethereum-withdrawalFee** (number) - Total estimated fee for an Ethereum withdrawal.
- **monad** (object) - Fee and eta details for Monad network transactions.
  - **monad-base-fee** (number) - Base fee for Monad network transactions.
  - **monad-depositEta** (string) - Estimated time for Monad deposit confirmation.
  - **monad-depositFee** (number) - Total estimated fee for a Monad deposit.
  - **monad-eth-deposit-gas** (number) - Estimated gas limit for ETH deposits on Monad.
  - **monad-eth-withdrawal-gas** (number) - Estimated gas limit for ETH withdrawals on Monad.
  - **monad-priority-fee** (number) - Priority fee for Monad network transactions.
  - **monad-withdrawalEta** (string) - Estimated time for Monad withdrawal confirmation.
  - **monad-withdrawalFee** (number) - Total estimated fee for a Monad withdrawal.
- **plasma** (object) - Fee and eta details for Plasma network transactions.
  - **plasma-base-fee** (number) - Base fee for Plasma network transactions.
  - **plasma-depositEta** (string) - Estimated time for Plasma deposit confirmation.
  - **plasma-depositFee** (number) - Total estimated fee for a Plasma deposit.
  - **plasma-eth-deposit-gas** (number) - Estimated gas limit for ETH deposits on Plasma.
  - **plasma-eth-withdrawal-gas** (number) - Estimated gas limit for ETH withdrawals on Plasma.
  - **plasma-priority-fee** (number) - Priority fee for Plasma network transactions.
  - **plasma-withdrawalEta** (string) - Estimated time for Plasma withdrawal confirmation.
  - **plasma-withdrawalFee** (number) - Total estimated fee for a Plasma withdrawal.
- **solana** (object) - Fee and eta details for Solana transactions.
  - **solana-depositEta** (string) - Estimated time for Solana deposit confirmation.
  - **solana-depositFee** (number) - Total estimated fee for a Solana deposit.
  - **solana-withdrawalEta** (string) - Estimated time for Solana withdrawal confirmation.
  - **solana-withdrawalFee** (number) - Total estimated fee for a Solana withdrawal.
- **spl** (object) - Fee and eta details for SPL token transactions on Solana.
  - **spl-depositEta** (string) - Estimated time for SPL token deposit confirmation.
  - **spl-depositFee** (number) - Total estimated fee for an SPL token deposit.
  - **spl-withdrawalEta** (string) - Estimated time for SPL token withdrawal confirmation.
  - **spl-withdrawalFee** (number) - Total estimated fee for an SPL token withdrawal.

#### Response Example
```json
{
  "bitcoin": {
    "bitcoin-deposit-fee-rate-sats-per-vb": 8,
    "bitcoin-deposit-size-v-bytes": 113,
    "bitcoin-depositEta": "21m",
    "bitcoin-depositFee": 2065,
    "bitcoin-withdrawal-fee-rate-sats-per-vb": 5,
    "bitcoin-withdrawal-size-v-bytes": 143,
    "bitcoin-withdrawalEta": "14m",
    "bitcoin-withdrawalFee": 715
  },
  "ethereum": {
    "ethereum-base-fee": 13,
    "ethereum-depositEta": "3m",
    "ethereum-depositFee": 348377194481578,
    "ethereum-erc20-deposit-fee": 444005772000,
    "ethereum-erc20-deposit-gas": 370000,
    "ethereum-erc20-withdrawal-fee": 403205416651,
    "ethereum-erc20-withdrawal-gas": 235000,
    "ethereum-eth-deposit-gas": 21000,
    "ethereum-eth-withdrawal-gas": 50000,
    "ethereum-priority-fee": 1000000,
    "ethereum-withdrawalEta": "7m",
    "ethereum-withdrawalFee": 50000650000
  },
  "monad": {
    "monad-base-fee": 126562500000,
    "monad-depositEta": "1m",
    "monad-depositFee": 3.3741375569722665e+18,
    "monad-eth-deposit-gas": 21000,
    "monad-eth-withdrawal-gas": 50000,
    "monad-priority-fee": 2000000000,
    "monad-withdrawalEta": "4m",
    "monad-withdrawalFee": 6428125000000000
  },
  "plasma": {
    "plasma-base-fee": 8,
    "plasma-depositEta": "1m",
    "plasma-depositFee": 4.624188358606018e+18,
    "plasma-eth-deposit-gas": 21000,
    "plasma-eth-withdrawal-gas": 50000,
    "plasma-priority-fee": 2,
    "plasma-withdrawalEta": "4m",
    "plasma-withdrawalFee": 500000
  },
  "solana": {
    "solana-depositEta": "1m",
    "solana-depositFee": 8622130,
    "solana-withdrawalEta": "4m",
    "solana-withdrawalFee": 8000
  },
  "spl": {
    "spl-depositEta": "1m",
    "spl-depositFee": 7768250,
    "spl-withdrawalEta": "4m",
    "spl-withdrawalFee": 2815836
  }
}
```
```

--------------------------------

### GET /operations/:address

Source: https://docs.hyperunit.xyz/developers/api/operations

Retrieves all operations for a specified user address. The address parameter is required to identify the user.

```APIDOC
## GET /operations/:address

### Description
Use this endpoint to retrieve all operations associated with a specific user address. This is useful for tracking transaction history and status for a Hyperliquid user.

### Method
GET

### Endpoint
/operations/:address

### Parameters
#### Path Parameters
- **address** (String) - Required - The address associated with the operations to retrieve.

### Request Example
```bash
curl -X GET https://api.hyperunit-testnet.xyz/operations/0xa6f1Ef42D335Ec7CbfC39f57269c851568300132
```

### Response
#### Success Response (200)
- **addresses** (Array) - A list of addresses related to the operations, including source coin type, destination chain, address, and signatures.
- **operations** (Array) - A list of operation objects, each containing details such as creation timestamp, operation ID, protocol address, source and destination addresses, chain information, amounts, fees, state details, transaction hashes, and asset type.

#### Response Example
```json
{
  "addresses": [
    {
      "sourceCoinType": "bitcoin",
      "destinationChain": "hyperliquid",
      "address": "tb1pncsdk2979x2nksu5mvf9uu6z0v0a7632ss5vuw3fu4wv8805d09sjd7m3e",
      "signatures": {
        "field-node": "KU9w0QF1/lJECrkPSz8ssUmcWpD6ZshftuONYSO/ockUgeovGgmAPKbBBBLt4A0X0WsqaTaFYwEQcRyTGp7xWQ==",
        "hl-node-testnet": "/lElUTMr/4q7QBV6fur2b4LqV7c9DCMDHnMZiC73XO5WOfy46Q+t+2ZmbiPCaW7THLW9r13otiVCjeb/zAfAKA==",
        "node-1": "PXtxH2B/KtCaceEeAD9/pZ37c+Ryv4FmdC7QeN1AB+D1HzjhDtJs75P4Xi3YQB4pP46ycyZkhXnz65AJvFahuA=="
      }
    }
  ],
  "operations": [
    {
      "opCreatedAt": "2025-03-12T23:42:27Z",
      "operationId": "",
      "protocolAddress": "tb1pncsdk2979x2nksu5mvf9uu6z0v0a7632ss5vuw3fu4wv8805d09sjd7m3e",
      "sourceAddress": "tb1qkwl2vjeplzj76qz544qzenl26w0fscsfmxlews",
      "destinationAddress": "",
      "sourceChain": "bitcoin",
      "destinationChain": "hyperliquid",
      "sourceAmount": "10000000",
      "destinationFeeAmount": "0",
      "sweepFeeAmount": "0",
      "stateStartedAt": "0001-01-01T00:00:00Z",
      "stateUpdatedAt": "0001-01-01T00:00:00Z",
      "stateNextAttemptAt": "0001-01-01T00:00:00Z",
      "sourceTxHash": "1c6f6abc977ec3ba381ad99f3903a258eaae366adf7c7a7627ef159357cd67a6",
      "sourceTxConfirmations": 0,
      "destinationTxHash": "",
      "asset": "btc",
      "state": "sourceTxDiscovered"
    }
  ]
}
```

#### 400: Error Response
- **error** (String) - Description of the error, e.g., "Invalid input address".

#### Error Response Example
```json
{
  "error": "Invalid input address"
}
```
```

--------------------------------

### GET /withdrawal-queue Error Response (JSON)

Source: https://docs.hyperunit.xyz/developers/api/withdraw-queue

This snippet illustrates an error response from the GET /withdrawal-queue endpoint. It indicates an 'invalid request' and is useful for debugging and understanding potential issues with client-side request formatting. The response format is standard JSON.

```json
{"error":"invalid request"}
```

--------------------------------

### Retrieve User Operations (GET /operations/:address)

Source: https://docs.hyperunit.xyz/developers/api/operations

This endpoint retrieves all operations associated with a given user address. The request requires an 'address' parameter. Successful responses return a JSON object containing addresses and operation details. Error responses indicate invalid input.

```bash
curl -X GET https://api.hyperunit-testnet.xyz/operations/0xa6f1Ef42D335Ec7CbfC39f57269c851568300132
```

--------------------------------

### GET /withdrawal-queue

Source: https://docs.hyperunit.xyz/developers/api/withdraw-queue

Retrieves the current status of the withdrawal queue for Bitcoin and Ethereum. This includes the last transaction ID processed and the current length of the queue.

```APIDOC
## GET /withdrawal-queue

### Description
Retrieves the current status of the withdrawal queue for Bitcoin and Ethereum. This includes the last transaction ID processed and the current length of the queue.

### Method
GET

### Endpoint
/withdrawal-queue

### Parameters

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **bitcoin** (object) - Bitcoin withdrawal queue status.
  - **lastWithdrawQueueOperationTxID** (string) - The transaction ID of the last Bitcoin withdrawal operation.
  - **withdrawalQueueLength** (integer) - The current number of pending Bitcoin withdrawals in the queue.
- **ethereum** (object) - Ethereum withdrawal queue status.
  - **lastWithdrawQueueOperationTxID** (string) - The transaction ID of the last Ethereum withdrawal operation.
  - **withdrawalQueueLength** (integer) - The current number of pending Ethereum withdrawals in the queue.

#### Response Example
```json
{
  "bitcoin": {
    "lastWithdrawQueueOperationTxID": "f15cf8bb590cd7d50dc9d892c9d4d5ba370887f462cd5ac5e61ad2696b19e6cd",
    "withdrawalQueueLength": 2
  },
  "ethereum": {
    "lastWithdrawQueueOperationTxID": "0x95f792c9ba7d31d33b6d631824756e74cd85e6c1cb5d677b4614c324f57c6aa7",
    "withdrawalQueueLength": 0
  }
}
```

#### Error Response (400)
- **error** (string) - Description of the error, e.g., "invalid request".

#### Response Example
```json
{
  "error": "invalid request"
}
```
```

--------------------------------

### GET /gen/:src_chain/:dst_chain/:asset/:dst_addr

Source: https://docs.hyperunit.xyz/developers/api/generate-address

Generates a protocol address for a specified source chain, destination chain, asset, and destination address. This address is used for receiving deposits or sending withdrawals on the Unit platform.

```APIDOC
## GET /gen/:src_chain/:dst_chain/:asset/:dst_addr

### Description
This endpoint generates a protocol address on the Unit platform. This address is crucial for facilitating cryptocurrency deposits and withdrawals between different blockchain networks. For deposits, it represents a Unit-derived address on the source chain that a user's Hyperliquid address will receive funds into. For withdrawals, it's a Unit-derived Hyperliquid address that will send funds to a user's address on the destination chain.

### Method
GET

### Endpoint
`/gen/:src_chain/:dst_chain/:asset/:dst_addr`

### Parameters
#### Path Parameters
- **src_chain** (String) - Required - The source chain of the transaction (e.g., "hyperliquid", "bitcoin", "solana", "ethereum", "plasma").
- **dst_chain** (String) - Required - The destination chain of the transaction (e.g., "hyperliquid", "bitcoin", "solana", "ethereum", "plasma").
- **asset** (String) - Required - The symbol of the asset being transferred (e.g., "btc", "eth", "sol", "xpl").
- **dst_addr** (String) - Required - The destination address on the destination chain.

### Request Example
```bash
curl -X GET https://api.hyperunit-testnet.xyz/gen/bitcoin/hyperliquid/btc/0x99a5F7202c4983a6f0Ca9d8F0526Fcd9d2be9e1D
```

### Response
#### Success Response (200)
- **address** (String) - The generated protocol address.
- **signatures** (Object) - Signature details from different nodes.
  - **field-node** (String) - Signature from the field node.
  - **hl-node** (String) - Signature from the Hyperliquid node.
  - **node-1** (String) - Signature from node 1.
- **status** (String) - The status of the response, expected to be "OK".

#### Response Example
```json
{
  "address": "tb1pwv4p3sgpy8g323mxsa5z4dnm0qnzlqcxk70gwdqvrmaf92psselsxcwf75",
  "signatures": {
    "field-node": "6FdyoeFFKkzT1fylI5xmMNSLMPC3aNICBL0Nj6KokYYpA9dqEpjdLoKBw4uGPDIdZEARc1QagKIirNzqoW5cNw==",
    "hl-node": "gkMJhxswzNqqMBx03wJy5zzHIcXyTrzfgb077F2CC4kDSyXqMPKE/HQOvaLpgMC21v3Fb/G8ujAuXafBIz2tVg==",
    "node-1": "6AbTFibJ7BQEXGFXRP5lROQ6w2aqVMDyy1xMLJL0mnyB1MeIPFIEPKbHKtAbsAdB37NhxSeL9iMKUkM5XnUnFg=="
  },
  "status": "OK"
}
```

#### Error Response (400)
- **error** (String) - Description of the error, e.g., "invalid request".

#### Error Response Example
```json
{"error":"invalid request"}
```
```

--------------------------------

### GET /withdrawal-queue Successful Response (JSON)

Source: https://docs.hyperunit.xyz/developers/api/withdraw-queue

This snippet shows a successful response from the GET /withdrawal-queue endpoint. It includes the last transaction ID and the current length of the withdrawal queue for both Bitcoin and Ethereum. This information is crucial for monitoring withdrawal progress and understanding network batching.

```json
{
  "bitcoin": {
    "lastWithdrawQueueOperationTxID": "f15cf8bb590cd7d50dc9d892c9d4d5ba370887f462cd5ac5e61ad2696b19e6cd",
    "withdrawalQueueLength": 2
  },
  "ethereum": {
    "lastWithdrawQueueOperationTxID": "0x95f792c9ba7d31d33b6d631824756e74cd85e6c1cb5d677b4614c324f57c6aa7",
    "withdrawalQueueLength": 0
  }
}
```

--------------------------------

### Error API Response for Address Generation

Source: https://docs.hyperunit.xyz/developers/api/generate-address

This is an example of an error response from the Hyperunit API when a request to generate an address is invalid. It returns a JSON object with an 'error' field.

```json
{
  "error": "invalid request"
}
```

--------------------------------

### Successful Operations Response (JSON)

Source: https://docs.hyperunit.xyz/developers/api/operations

A successful response to the GET /operations/:address endpoint returns a JSON object containing two main arrays: 'addresses' and 'operations'. The 'addresses' array details source and destination information, while 'operations' provides specifics about each transaction.

```json
{
  "addresses": [
    {
      "sourceCoinType": "bitcoin",
      "destinationChain": "hyperliquid",
      "address": "tb1pncsdk2979x2nksu5mvf9uu6z0v0a7632ss5vuw3fu4wv8805d09sjd7m3e",
      "signatures": {
        "field-node": "KU9w0QF1/lJECrkPSz8ssUmcWpD6ZshftuONYSO/ockUgeovGgmAPKbBBBLt4A0X0WsqaTaFYwEQcRyTGp7xWQ==",
        "hl-node-testnet": "/lElUTMr/4q7QBV6fur2b4LqV7c9DCMDHnMZiC73XO5WOfy46Q+t+2ZmbiPCaW7THLW9r13otiVCjeb/zAfAKA==",
        "node-1": "PXtxH2B/KtCaceEeAD9/pZ37c+Ryv4FmdC7QeN1AB+D1HzjhDtJs75P4Xi3YQB4pP46ycyZkhXnz65AJvFahuA=="
      }
    },
    {
      "sourceCoinType": "ethereum",
      "destinationChain": "hyperliquid",
      "address": "0xf040d1E1e7BCDc9947E5F7871c7F205786CcC494",
      "signatures": {
        "field-node": "6DTX4nLPd8+hYb2aJNowdu3R3J6nsXmGnhOYnaKIiSC7h6w3evgUzWI6rKG3CmjrjA5s3+X2cqNmlSfGMo+z2w==",
        "hl-node-testnet": "bc4Z8k3y+FHsiB2Fzus/wqBRAbtrgvlrgVVWJ4dT7DMVoGF4c+Jd69Rk7uJMelLf31xjJdtxmtdCHwDVT5ryjw==",
        "node-1": "BoEW/3Za0+j+wi1NlbXYrRsgywJhLyDrawToSCQkpYwnwB9GVFnxBoEb4a57HhpX8LnJfrPxN51eS0PHZS73Zw=="
      }
    }
  ],
  "operations": [
    {
      "opCreatedAt": "2025-03-12T23:42:27Z",
      "operationId": "",
      "protocolAddress": "tb1pncsdk2979x2nksu5mvf9uu6z0v0a7632ss5vuw3fu4wv8805d09sjd7m3e",
      "sourceAddress": "tb1qkwl2vjeplzj76qz544qzenl26w0fscsfmxlews",
      "destinationAddress": "",
      "sourceChain": "bitcoin",
      "destinationChain": "hyperliquid",
      "sourceAmount": "10000000",
      "destinationFeeAmount": "0",
      "sweepFeeAmount": "0",
      "stateStartedAt": "0001-01-01T00:00:00Z",
      "stateUpdatedAt": "0001-01-01T00:00:00Z",
      "stateNextAttemptAt": "0001-01-01T00:00:00Z",
      "sourceTxHash": "1c6f6abc977ec3ba381ad99f3903a258eaae366adf7c7a7627ef159357cd67a6",
      "sourceTxConfirmations": 0,
      "destinationTxHash": "",
      "asset": "btc",
      "state": "sourceTxDiscovered"
    },
    {
      "opCreatedAt": "2025-03-12T23:40:49.279929Z",
      "operationId": "914ea76e4329845f9c1e03c87b66bc339dd9a8789ce9be7a46170d68e70dd791:0",
      "protocolAddress": "tb1pncsdk2979x2nksu5mvf9uu6z0v0a7632ss5vuw3fu4wv8805d09sjd7m3e",
      "sourceAddress": "tb1qkwl2vjeplzj76qz544qzenl26w0fscsfmxlews",
      "destinationAddress": "0xa6f1Ef42D335Ec7CbfC39f57269c851568300132",
      "sourceChain": "bitcoin",
      "destinationChain": "hyperliquid",
      "sourceAmount": "10000000",
      "destinationFeeAmount": "0",
      "sweepFeeAmount": "0",
      "stateStartedAt": "2025-03-12T23:40:49.465291Z",
      "stateUpdatedAt": "2025-03-12T23:40:49.465291Z",
      "stateNextAttemptAt": "2025-03-12T23:42:50.804735Z",
      "sourceTxHash": "914ea76e4329845f9c1e03c87b66bc339dd9a8789ce9be7a46170d68e70dd791:0",
      "sourceTxConfirmations": 1,
      "asset": "btc",
      "state": "waitForSrcTxFinalization"
    },
    {
      "opCreatedAt": "2025-03-12T23:38:02.019431Z",
      "operationId": "0x2ebf75c61e1c78f89b8e04f1af6912ca46c936293920fb320f8e8ca3eda360f3:0",
      "protocolAddress": "0xf040d1E1e7BCDc9947E5F7871c7F205786CcC494",
      "sourceAddress": "0xa6f1Ef42D335Ec7CbfC39f57269c851568300132",
      "destinationAddress": "0xa6f1Ef42D335Ec7CbfC39f57269c851568300132",
      "sourceChain": "ethereum",
      "destinationChain": "hyperliquid",
      "sourceAmount": "100000000000000000",
      "destinationFeeAmount": "454545454545454",
      "sweepFeeAmount": "140761861078.125",
      "stateStartedAt": "2025-03-12T23:40:40.798707Z",
      "stateUpdatedAt": "2025-03-12T23:40:40.798707Z",
      "stateNextAttemptAt": "2025-03-12T23:40:40.798698Z",
      "sourceTxHash": "0x2ebf75c61e1c78f89b8e04f1af6912ca46c936293920fb320f8e8ca3eda360f3:0",
      "destinationTxHash": "0xdC78799911e46bacA335e6c5BA50dA89e9885520:1741822714587",
      "broadcastAt": "2025-03-12T23:38:46.170519Z",
      "asset": "eth",
      "state": "done"
    }
  ]
}
```

--------------------------------

### Operation Structure and Fields

Source: https://docs.hyperunit.xyz/developers/api/operations

Details the structure of Unit Operations, including fields like operationId, timestamps, addresses, amounts, state, and transaction hashes. It also explains response fields such as opCreatedAt, sourceTxConfirmations, destinationTxConfirmations, broadcastAt, and addresses.

```APIDOC
## Unit Operations API

### Description
This API provides details about Unit Operations, which encompass both deposits and withdrawals. The structure defines the data returned for each operation, including identifiers, timestamps, addresses, chain information, amounts, status, and transaction hashes.

### Endpoint
`/operations`

### Response
#### Success Response (200)
- **operationId** (string) - Unique identifier, equivalent to sourceTxHash.
- **opCreatedAt** (string) - ISO 8601 timestamp indicating when the Unit protocol created a deposit/withdrawal operation. Sorted in descending order.
- **protocolAddress** (string) - The Unit-generated protocol address.
- **sourceAddress** (string) - The originating address of the transaction.
- **destinationAddress** (string) - The destination address for the operation.
- **sourceChain** (string) - The source blockchain network (e.g., 'bitcoin', 'hyperliquid', 'ethereum').
- **destinationChain** (string) - The destination blockchain network (e.g., 'bitcoin', 'hyperliquid', 'ethereum').
- **sourceAmount** (string) - The amount transferred in the smallest native units of the source currency (e.g., satoshis, wei).
- **destinationFeeAmount** (string) - The fee paid for the destination transaction on the destination chain.
- **sweepFeeAmount** (string) - The estimated fee paid to sweep funds on the source chain.
- **state** (string) - The current status of the operation (e.g., 'wait_for_sweep', 'QueuedForWithdraw', 'BroadcastTx').
- **sourceTxHash** (string) - The transaction hash on the source chain.
- **destinationTxHash** (string) - The transaction hash on the destination chain (empty until created).
- **positionInWithdrawQueue** (number) - The position of the operation in the withdrawal queue (0 if not applicable).
- **asset** (string) - The asset being transferred (e.g., 'btc', 'eth', 'sol', 'fart').
- **sourceTxConfirmations** (number) - The number of block confirmations for the source transaction. Omitted if finalized.
- **destinationTxConfirmations** (number) - The number of block confirmations for the destination transaction. Applicable to specific states.
- **broadcastAt** (string) - The server-side timestamp when the destination transaction was broadcasted. Applicable to specific states.
- **addresses** (object) - Unit-generated `protocolAddresses` associated with the destination address.
  - **sourceCoinType** (string) - SLIP-44 coin-type of the source chain for the `protocolAddress`.
  - **destinationChain** (string) - The destination chain of the `protocolAddress`.
  - **address** (string) - The `protocolAddress` on the source chain.
  - **[key: string]** (string) - Guardian signatures over the protocol address.

### Additional Notes
- Unit does not collect revenue; fees are for network processing.
- Transaction hash formats vary by chain: Bitcoin (`<txid>:<vout>`), Ethereum (`<tx-hash>:<trace-id>`), Hyperliquid (`<sender_address>:<nonce>`), Solana (`<signature>:<destination-address>`).
- Operations with fewer than 2 Bitcoin confirmations have the state `srcTxDiscovered`.
```

--------------------------------

### Generate Bitcoin Deposit Address using cURL

Source: https://docs.hyperunit.xyz/developers/api/generate-address

This snippet demonstrates how to use cURL to call the Hyperunit API and generate a Bitcoin deposit address for a Hyperliquid user. It specifies the source chain (bitcoin), destination chain (hyperliquid), asset (btc), and the destination Hyperliquid address.

```bash
curl -X GET https://api.hyperunit-testnet.xyz/gen/bitcoin/hyperliquid/btc/0x99a5F7202c4983a6f0Ca9d8F0526Fcd9d2be9e1D
```

--------------------------------

### Successful API Response for Address Generation

Source: https://docs.hyperunit.xyz/developers/api/generate-address

This is a successful JSON response from the Hyperunit API after generating a protocol address. It includes the generated address, signature data from different nodes, and a status indicating success.

```json
{
  "address": "tb1pwv4p3sgpy8g323mxsa5z4dnm0qnzlqcxk70gwdqvrmaf92psselsxcwf75",
  "signatures": {
    "field-node": "6FdyoeFFKkzT1fylI5xmMNSLMPC3aNICBL0Nj6KokYYpA9dqEpjdLoKBw4uGPDIdZEARc1QagKIirNzqoW5cNw==",
    "hl-node": "gkMJhxswzNqqMBx03wJy5zzHIcXyTrzfgb077F2CC4kDSyXqMPKE/HQOvaLpgMC21v3Fb/G8ujAuXafBIz2tVg==",
    "node-1": "6AbTFibJ7BQEXGFXRP5lROQ6w2aqVMDyy1xMLJL0mnyB1MeIPFIEPKbHKtAbsAdB37NhxSeL9iMKUkM5XnUnFg=="
  },
  "status": "OK"
}
```

--------------------------------

### Error Operations Response (JSON)

Source: https://docs.hyperunit.xyz/developers/api/operations

An error response for the GET /operations/:address endpoint is returned when invalid input, such as an incorrect address format, is provided. The response typically includes a JSON object with an 'error' key detailing the issue.

```json
{
  "error":"Invalid input address"
}
```

--------------------------------

### Define Operation and Address Types in TypeScript

Source: https://docs.hyperunit.xyz/developers/api/operations

Defines the TypeScript types for 'Operation' and 'Address', which represent deposit/withdrawal operations and associated addresses within the Unit protocol. The 'Operation' type includes details like IDs, timestamps, addresses, chain identifiers, amounts, status, and transaction hashes. The 'Address' type specifies coin types, destination chains, and protocol addresses.

```typescript
export type Operation = {
  /** Unique identifier, equivalent to sourceTxHash */
  operationId: string;
  /** ISO 8601 timestamp */
  opCreatedAt: string;

  /** Addresses */
  protocolAddress: string;
  sourceAddress: string;
  destinationAddress: string;

  /** Chain identifiers */
  sourceChain: 'bitcoin' | 'hyperliquid' | 'ethereum';
  destinationChain: 'bitcoin' | 'hyperliquid' | 'ethereum';

  /** Amounts, in smallest native units of source currency (satoshis/wei) */
  // e.g. ethereum - 18 decimals, solana - 9 decimals, bitcoin - 8 decimals, pump - 6 decimals
  sourceAmount: string;
  destinationFeeAmount: string;
  sweepFeeAmount: string;

  /** Current operation status */
  state: OperationState;

  /** Source chain transaction hash */
  sourceTxHash: string;

  /** Destination chain transaction hash (empty until created) */
  destinationTxHash: string;

  /** Position in withdraw queue (0 if state != "wait_for_sweep") */
  positionInWithdrawQueue: number;

  /** asset being transferred (btc, eth, sol, fart). It's 
  possible that there are multiple assets per chain (i.e solana) */
  asset: string;
};

export type Address = {
  /** coin-type of the protocolAddress's source chain according to
   SLIP-44 (BITCOIN, ETHEREUM) **/
  sourceCoinType: string;
  
  /** destination chain of the protocol address **/
  destinationChain: string;
  
  /** the protocol address **/
  address: string;
  
  /** guardian signatures over the protocol address **/
  [key: string]: string;
};

```
Tokens:
Raw