@actioncodes/protocol 1.2.1 → 2.0.0

package/docs/errors/classes/ProtocolError.md

@@ -0,0 +1,637 @@
+[**@actioncodes/protocol-v2**](../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../modules.md) / [errors](../README.md) / ProtocolError
+
+# Class: ProtocolError
+
+Defined in: src/errors.ts:27
+
+## Extends
+
+- `Error`
+
+## Extended by
+
+- [`ExpiredCodeError`](ExpiredCodeError.md)
+- [`MissingMetaError`](MissingMetaError.md)
+- [`MetaMismatchError`](MetaMismatchError.md)
+- [`TransactionNotSignedByIntendedOwnerError`](TransactionNotSignedByIntendedOwnerError.md)
+- [`InvalidPubkeyFormatError`](InvalidPubkeyFormatError.md)
+- [`InvalidSignatureError`](InvalidSignatureError.md)
+- [`InvalidCodeFormatError`](InvalidCodeFormatError.md)
+
+## Constructors
+
+### Constructor
+
+> **new ProtocolError**(`code`, `message`, `details?`): `ProtocolError`
+
+Defined in: src/errors.ts:28
+
+#### Parameters
+
+##### code
+
+[`ProtocolErrorCode`](../enumerations/ProtocolErrorCode.md)
+
+##### message
+
+`string`
+
+##### details?
+
+`Record`\<`string`, `unknown`\>
+
+#### Returns
+
+`ProtocolError`
+
+#### Overrides
+
+`Error.constructor`
+
+## Properties
+
+### cause?
+
+> `optional` **cause**: `unknown`
+
+Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26
+
+The cause of the error.
+
+#### Inherited from
+
+`Error.cause`
+
+***
+
+### code
+
+> `readonly` **code**: [`ProtocolErrorCode`](../enumerations/ProtocolErrorCode.md)
+
+Defined in: src/errors.ts:29
+
+***
+
+### details?
+
+> `readonly` `optional` **details**: `Record`\<`string`, `unknown`\>
+
+Defined in: src/errors.ts:31
+
+***
+
+### message
+
+> **message**: `string`
+
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077
+
+#### Inherited from
+
+`Error.message`
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076
+
+#### Inherited from
+
+`Error.name`
+
+***
+
+### stack?
+
+> `optional` **stack**: `string`
+
+Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078
+
+#### Inherited from
+
+`Error.stack`
+
+***
+
+### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+Defined in: node\_modules/@types/node/globals.d.ts:68
+
+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
+
+`Error.stackTraceLimit`
+
+## Methods
+
+### captureStackTrace()
+
+#### Call Signature
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Defined in: node\_modules/@types/node/globals.d.ts:52
+
+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
+
+###### targetObject
+
+`object`
+
+###### constructorOpt?
+
+`Function`
+
+##### Returns
+
+`void`
+
+##### Inherited from
+
+`Error.captureStackTrace`
+
+#### Call Signature
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Defined in: node\_modules/bun-types/globals.d.ts:985
+
+Create .stack property on a target object
+
+##### Parameters
+
+###### targetObject
+
+`object`
+
+###### constructorOpt?
+
+`Function`
+
+##### Returns
+
+`void`
+
+##### Inherited from
+
+`Error.captureStackTrace`
+
+***
+
+### create()
+
+> `static` **create**(`code`, `message`, `details?`): `ProtocolError`
+
+Defined in: src/errors.ts:127
+
+#### Parameters
+
+##### code
+
+[`ProtocolErrorCode`](../enumerations/ProtocolErrorCode.md)
+
+##### message
+
+`string`
+
+##### details?
+
+`Record`\<`string`, `unknown`\>
+
+#### Returns
+
+`ProtocolError`
+
+***
+
+### cryptoError()
+
+> `static` **cryptoError**(`operation`, `reason`): `ProtocolError`
+
+Defined in: src/errors.ts:110
+
+#### Parameters
+
+##### operation
+
+`string`
+
+##### reason
+
+`string`
+
+#### Returns
+
+`ProtocolError`
+
+***
+
+### expiredCode()
+
+> `static` **expiredCode**(`code`, `expiresAt`, `currentTime`): [`ExpiredCodeError`](ExpiredCodeError.md)
+
+Defined in: src/errors.ts:38
+
+#### Parameters
+
+##### code
+
+`string`
+
+##### expiresAt
+
+`number`
+
+##### currentTime
+
+`number`
+
+#### Returns
+
+[`ExpiredCodeError`](ExpiredCodeError.md)
+
+***
+
+### invalidCodeFormat()
+
+> `static` **invalidCodeFormat**(`code`, `reason`): [`InvalidCodeFormatError`](InvalidCodeFormatError.md)
+
+Defined in: src/errors.ts:42
+
+#### Parameters
+
+##### code
+
+`string`
+
+##### reason
+
+`string`
+
+#### Returns
+
+[`InvalidCodeFormatError`](InvalidCodeFormatError.md)
+
+***
+
+### invalidDigest()
+
+> `static` **invalidDigest**(`reason`): `ProtocolError`
+
+Defined in: src/errors.ts:118
+
+#### Parameters
+
+##### reason
+
+`string`
+
+#### Returns
+
+`ProtocolError`
+
+***
+
+### invalidInput()
+
+> `static` **invalidInput**(`field`, `value`, `reason`): `ProtocolError`
+
+Defined in: src/errors.ts:93
+
+#### Parameters
+
+##### field
+
+`string`
+
+##### value
+
+`unknown`
+
+##### reason
+
+`string`
+
+#### Returns
+
+`ProtocolError`
+
+***
+
+### invalidMetaFormat()
+
+> `static` **invalidMetaFormat**(`reason`): `ProtocolError`
+
+Defined in: src/errors.ts:55
+
+#### Parameters
+
+##### reason
+
+`string`
+
+#### Returns
+
+`ProtocolError`
+
+***
+
+### invalidPubkeyFormat()
+
+> `static` **invalidPubkeyFormat**(`pubkey`, `reason`): [`InvalidPubkeyFormatError`](InvalidPubkeyFormatError.md)
+
+Defined in: src/errors.ts:88
+
+#### Parameters
+
+##### pubkey
+
+`string`
+
+##### reason
+
+`string`
+
+#### Returns
+
+[`InvalidPubkeyFormatError`](InvalidPubkeyFormatError.md)
+
+***
+
+### invalidSignature()
+
+> `static` **invalidSignature**(`reason`): [`InvalidSignatureError`](InvalidSignatureError.md)
+
+Defined in: src/errors.ts:46
+
+#### Parameters
+
+##### reason
+
+`string`
+
+#### Returns
+
+[`InvalidSignatureError`](InvalidSignatureError.md)
+
+***
+
+### invalidTransactionFormat()
+
+> `static` **invalidTransactionFormat**(`reason`): `ProtocolError`
+
+Defined in: src/errors.ts:80
+
+#### Parameters
+
+##### reason
+
+`string`
+
+#### Returns
+
+`ProtocolError`
+
+***
+
+### isError()
+
+#### Call Signature
+
+> `static` **isError**(`error`): `error is Error`
+
+Defined in: node\_modules/typescript/lib/lib.esnext.error.d.ts:23
+
+Indicates whether the argument provided is a built-in Error instance or not.
+
+##### Parameters
+
+###### error
+
+`unknown`
+
+##### Returns
+
+`error is Error`
+
+##### Inherited from
+
+`Error.isError`
+
+#### Call Signature
+
+> `static` **isError**(`value`): `value is Error`
+
+Defined in: node\_modules/bun-types/globals.d.ts:980
+
+Check if a value is an instance of Error
+
+##### Parameters
+
+###### value
+
+`unknown`
+
+The value to check
+
+##### Returns
+
+`value is Error`
+
+True if the value is an instance of Error, false otherwise
+
+##### Inherited from
+
+`Error.isError`
+
+***
+
+### metaMismatch()
+
+> `static` **metaMismatch**(`expected`, `actual`, `field`): [`MetaMismatchError`](MetaMismatchError.md)
+
+Defined in: src/errors.ts:63
+
+#### Parameters
+
+##### expected
+
+`string`
+
+##### actual
+
+`string`
+
+##### field
+
+`string`
+
+#### Returns
+
+[`MetaMismatchError`](MetaMismatchError.md)
+
+***
+
+### metaTooLarge()
+
+> `static` **metaTooLarge**(`maxBytes`, `actualBytes`): `ProtocolError`
+
+Defined in: src/errors.ts:67
+
+#### Parameters
+
+##### maxBytes
+
+`number`
+
+##### actualBytes
+
+`number`
+
+#### Returns
+
+`ProtocolError`
+
+***
+
+### missingMeta()
+
+> `static` **missingMeta**(): [`MissingMetaError`](MissingMetaError.md)
+
+Defined in: src/errors.ts:51
+
+#### Returns
+
+[`MissingMetaError`](MissingMetaError.md)
+
+***
+
+### missingRequiredField()
+
+> `static` **missingRequiredField**(`field`): `ProtocolError`
+
+Defined in: src/errors.ts:101
+
+#### Parameters
+
+##### field
+
+`string`
+
+#### Returns
+
+`ProtocolError`
+
+***
+
+### prepareStackTrace()
+
+> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`
+
+Defined in: node\_modules/@types/node/globals.d.ts:56
+
+#### Parameters
+
+##### err
+
+`Error`
+
+##### stackTraces
+
+`CallSite`[]
+
+#### Returns
+
+`any`
+
+#### See
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+#### Inherited from
+
+`Error.prepareStackTrace`
+
+***
+
+### transactionNotSignedByIntendedOwner()
+
+> `static` **transactionNotSignedByIntendedOwner**(`intended`, `actualSigners`): [`TransactionNotSignedByIntendedOwnerError`](TransactionNotSignedByIntendedOwnerError.md)
+
+Defined in: src/errors.ts:76
+
+#### Parameters
+
+##### intended
+
+`string`
+
+##### actualSigners
+
+`string`[]
+
+#### Returns
+
+[`TransactionNotSignedByIntendedOwnerError`](TransactionNotSignedByIntendedOwnerError.md)