> ## Documentation Index
> Fetch the complete documentation index at: https://voltaire.tevm.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# primitives/TransactionStatus

> Auto-generated API documentation

[**@tevm/voltaire**](../index.mdx)

***

[@tevm/voltaire](../index.mdx) / primitives/TransactionStatus

# primitives/TransactionStatus

## Type Aliases

### TransactionStatusType

> **TransactionStatusType** = \{ `type`: `"pending"`; } | \{ `gasUsed`: [`Type`](Uint.mdx#type); `type`: `"success"`; } | \{ `revertReason?`: `string`; `type`: `"failed"`; }

Defined in: [src/primitives/TransactionStatus/TransactionStatusType.ts:6](https://github.com/evmts/voltaire/blob/bd6ec34405c15ad8cd51d11579d495dc53813482/src/primitives/TransactionStatus/TransactionStatusType.ts#L6)

Transaction status in receipt

## Variables

### failed()

> `const` **failed**: (`revertReason?`) => [`TransactionStatusType`](#transactionstatustype) = `_failed`

Defined in: [src/primitives/TransactionStatus/index.ts:12](https://github.com/evmts/voltaire/blob/bd6ec34405c15ad8cd51d11579d495dc53813482/src/primitives/TransactionStatus/index.ts#L12)

Create failed status

#### Parameters

##### revertReason?

`string`

#### Returns

[`TransactionStatusType`](#transactionstatustype)

***

### isFailed()

> `const` **isFailed**: (`status`) => `status is { revertReason?: string; type: "failed" }` = `_isFailed`

Defined in: [src/primitives/TransactionStatus/index.ts:15](https://github.com/evmts/voltaire/blob/bd6ec34405c15ad8cd51d11579d495dc53813482/src/primitives/TransactionStatus/index.ts#L15)

Check if status is failed

#### Parameters

##### status

[`TransactionStatusType`](#transactionstatustype)

#### Returns

`status is { revertReason?: string; type: "failed" }`

***

### isPending()

> `const` **isPending**: (`status`) => `boolean` = `_isPending`

Defined in: [src/primitives/TransactionStatus/index.ts:13](https://github.com/evmts/voltaire/blob/bd6ec34405c15ad8cd51d11579d495dc53813482/src/primitives/TransactionStatus/index.ts#L13)

Check if status is pending

#### Parameters

##### status

[`TransactionStatusType`](#transactionstatustype)

#### Returns

`boolean`

***

### isSuccess()

> `const` **isSuccess**: (`status`) => `status is { gasUsed: Type; type: "success" }` = `_isSuccess`

Defined in: [src/primitives/TransactionStatus/index.ts:14](https://github.com/evmts/voltaire/blob/bd6ec34405c15ad8cd51d11579d495dc53813482/src/primitives/TransactionStatus/index.ts#L14)

Check if status is success

#### Parameters

##### status

[`TransactionStatusType`](#transactionstatustype)

#### Returns

`status is { gasUsed: Type; type: "success" }`

***

### pending()

> `const` **pending**: () => [`TransactionStatusType`](#transactionstatustype) = `_pending`

Defined in: [src/primitives/TransactionStatus/index.ts:10](https://github.com/evmts/voltaire/blob/bd6ec34405c15ad8cd51d11579d495dc53813482/src/primitives/TransactionStatus/index.ts#L10)

Create pending status

#### Returns

[`TransactionStatusType`](#transactionstatustype)

***

### success()

> `const` **success**: (`gasUsed`) => [`TransactionStatusType`](#transactionstatustype) = `_success`

Defined in: [src/primitives/TransactionStatus/index.ts:11](https://github.com/evmts/voltaire/blob/bd6ec34405c15ad8cd51d11579d495dc53813482/src/primitives/TransactionStatus/index.ts#L11)

Create success status

#### Parameters

##### gasUsed

[`Type`](Uint.mdx#type)

#### Returns

[`TransactionStatusType`](#transactionstatustype)
