# MalformedEnvelopeError

Defined in: [packages/filecoin-encryption-envelope/src/errors.ts:50](https://github.com/FilOzone/synapse-sdk/blob/9ad84d812e1dd635b76420a7d9388555a04f31b6/packages/filecoin-encryption-envelope/src/errors.ts#L50)

The envelope, or a value destined for one, does not match this package's
wire profile. Raised on both paths: by encode when a caller's input would
produce bytes this package could not read back, and by decode on anything
the profile forbids.

Always thrown before any AEAD tag is checked, so it says nothing about
authenticity.

## Extends

- [`EnvelopeError`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/)

## Constructors

### Constructor

> **new MalformedEnvelopeError**(`message?`): `MalformedEnvelopeError`

Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1080

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `message?` | `string` |

#### Returns

`MalformedEnvelopeError`

#### Inherited from

[`EnvelopeError`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/).[`constructor`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/#constructor)

### Constructor

> **new MalformedEnvelopeError**(`message?`, `options?`): `MalformedEnvelopeError`

Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1080

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `message?` | `string` |
| `options?` | `ErrorOptions` |

#### Returns

`MalformedEnvelopeError`

#### Inherited from

[`EnvelopeError`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/).[`constructor`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/#constructor)

## Properties

### cause?

> `optional` **cause?**: `unknown`

Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:24

#### Inherited from

[`EnvelopeError`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/).[`cause`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/#cause)

***

### message

> **message**: `string`

Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1075

#### Inherited from

[`EnvelopeError`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/).[`message`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/#message)

***

### name

> **name**: `string` = `'MalformedEnvelopeError'`

Defined in: [packages/filecoin-encryption-envelope/src/errors.ts:51](https://github.com/FilOzone/synapse-sdk/blob/9ad84d812e1dd635b76420a7d9388555a04f31b6/packages/filecoin-encryption-envelope/src/errors.ts#L51)

#### Overrides

[`EnvelopeError`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/).[`name`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/#name)

***

### stack?

> `optional` **stack?**: `string`

Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.es5.d.ts:1076

#### Inherited from

[`EnvelopeError`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/).[`stack`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/#stack)

***

### stackTraceLimit

> `static` **stackTraceLimit**: `number`

Defined in: node\_modules/.pnpm/@types+node@26.2.0/node\_modules/@types/node/globals.d.ts:67

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
`Error.captureStackTrace(obj)`).

The default value is `10` but may be set to any valid JavaScript number. Changes
will affect any stack trace captured _after_ the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.

#### Inherited from

[`EnvelopeError`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/).[`stackTraceLimit`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/#stacktracelimit)

## Methods

### captureStackTrace()

> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`

Defined in: node\_modules/.pnpm/@types+node@26.2.0/node\_modules/@types/node/globals.d.ts:51

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
`Error.captureStackTrace()` was called.

```js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`
```

The first line of the trace will be prefixed with
`${myObject.name}: ${myObject.message}`.

The optional `constructorOpt` argument accepts a function. If given, all frames
above `constructorOpt`, including `constructorOpt`, will be omitted from the
generated stack trace.

The `constructorOpt` argument is useful for hiding implementation
details of error generation from the user. For instance:

```js
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
```

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `targetObject` | `object` |
| `constructorOpt?` | [`Function`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function) |

#### Returns

`void`

#### Inherited from

[`EnvelopeError`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/).[`captureStackTrace`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/#capturestacktrace)

***

### isError()

> `static` **isError**(`error`): `error is Error`

Defined in: node\_modules/.pnpm/typescript@6.0.3/node\_modules/typescript/lib/lib.esnext.error.d.ts:21

Indicates whether the argument provided is a built-in Error instance or not.

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `error` | `unknown` |

#### Returns

`error is Error`

#### Inherited from

[`EnvelopeError`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/).[`isError`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/#iserror)

***

### prepareStackTrace()

> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`

Defined in: node\_modules/.pnpm/@types+node@26.2.0/node\_modules/@types/node/globals.d.ts:55

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `err` | [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error) |
| `stackTraces` | `CallSite`[] |

#### Returns

`any`

#### See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

#### Inherited from

[`EnvelopeError`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/).[`prepareStackTrace`](/reference/filoz/filecoin-encryption-envelope/namespaces/errors/classes/envelopeerror/#preparestacktrace)