# readUpgradeState

<!-- https://uncage.vercel.app/docs/api/agent/functions/readupgradestate/ -->

```ts
function readUpgradeState(home): Promise<UpgradeState | null>;
```

Defined in: agent/src/agent.ts:221

## Parameters

| Parameter | Type |
| ------ | ------ |
| `home` | `string` |

## Returns

`Promise`\<`UpgradeState` \| `null`\>
