@actioncodes/protocol 1.2.2 → 2.0.0

package/docs/adapters/SolanaAdapter/classes/SolanaAdapter.md

@@ -0,0 +1,190 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [adapters/SolanaAdapter](../README.md) / SolanaAdapter
+
+# Class: SolanaAdapter
+
+Defined in: src/adapters/SolanaAdapter.ts:30
+
+## Extends
+
+- [`BaseChainAdapter`](../../BaseChainAdapter/classes/BaseChainAdapter.md)\<[`SolanaContext`](../type-aliases/SolanaContext.md)\>
+
+## Constructors
+
+### Constructor
+
+> **new SolanaAdapter**(): `SolanaAdapter`
+
+#### Returns
+
+`SolanaAdapter`
+
+#### Inherited from
+
+[`BaseChainAdapter`](../../BaseChainAdapter/classes/BaseChainAdapter.md).[`constructor`](../../BaseChainAdapter/classes/BaseChainAdapter.md#constructor)
+
+## Methods
+
+### getProtocolMeta()
+
+> **getProtocolMeta**(`tx`): `null` \| `string`
+
+Defined in: src/adapters/SolanaAdapter.ts:81
+
+Extract protocol metadata string (memo) from a transaction, or null
+
+#### Parameters
+
+##### tx
+
+[`SolanaTransaction`](../type-aliases/SolanaTransaction.md)
+
+#### Returns
+
+`null` \| `string`
+
+***
+
+### parseMeta()
+
+> **parseMeta**(`tx`): `null` \| [`ProtocolMetaFields`](../../../utils/protocolMeta/interfaces/ProtocolMetaFields.md)
+
+Defined in: src/adapters/SolanaAdapter.ts:97
+
+Get parsed ProtocolMeta object, or null if none or invalid
+
+#### Parameters
+
+##### tx
+
+[`SolanaTransaction`](../type-aliases/SolanaTransaction.md)
+
+#### Returns
+
+`null` \| [`ProtocolMetaFields`](../../../utils/protocolMeta/interfaces/ProtocolMetaFields.md)
+
+***
+
+### verify()
+
+> **verify**(`context`): `boolean`
+
+Defined in: src/adapters/SolanaAdapter.ts:40
+
+Verify the signature over canonical message (protocol-level)
+
+#### Parameters
+
+##### context
+
+[`ChainContext`](../../BaseChainAdapter/type-aliases/ChainContext.md)\<[`SolanaContext`](../type-aliases/SolanaContext.md)\>
+
+#### Returns
+
+`boolean`
+
+#### Overrides
+
+[`BaseChainAdapter`](../../BaseChainAdapter/classes/BaseChainAdapter.md).[`verify`](../../BaseChainAdapter/classes/BaseChainAdapter.md#verify)
+
+***
+
+### verifyTransactionMatchesCode()
+
+> **verifyTransactionMatchesCode**(`actionCode`, `tx`): `void`
+
+Defined in: src/adapters/SolanaAdapter.ts:143
+
+Validate that a transaction's memo meta aligns with the bound `actionCode`.
+Throws ProtocolError if validation fails.
+
+#### Parameters
+
+##### actionCode
+
+[`ActionCode`](../../../types/interfaces/ActionCode.md)
+
+##### tx
+
+[`SolanaTransaction`](../type-aliases/SolanaTransaction.md)
+
+#### Returns
+
+`void`
+
+***
+
+### verifyTransactionSignedByIntentOwner()
+
+> **verifyTransactionSignedByIntentOwner**(`tx`): `void`
+
+Defined in: src/adapters/SolanaAdapter.ts:184
+
+Verify that the transaction is signed by the "intendedFor" pubkey
+as declared in the protocol meta of the transaction.
+Throws ProtocolError if validation fails.
+
+#### Parameters
+
+##### tx
+
+[`SolanaTransaction`](../type-aliases/SolanaTransaction.md)
+
+#### Returns
+
+`void`
+
+***
+
+### attachProtocolMeta()
+
+> `static` **attachProtocolMeta**\<`T`\>(`tx`, `meta`): `T`
+
+Defined in: src/adapters/SolanaAdapter.ts:257
+
+Attach protocol meta into a legacy or versioned transaction.
+
+⚠️ Note: this mutates the given transaction.
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* [`SolanaTransaction`](../type-aliases/SolanaTransaction.md)
+
+#### Parameters
+
+##### tx
+
+`T`
+
+##### meta
+
+[`ProtocolMetaFields`](../../../utils/protocolMeta/interfaces/ProtocolMetaFields.md)
+
+#### Returns
+
+`T`
+
+***
+
+### createProtocolMetaIx()
+
+> `static` **createProtocolMetaIx**(`meta`): `TransactionInstruction`
+
+Defined in: src/adapters/SolanaAdapter.ts:73
+
+Create a Solana memo instruction carrying protocol meta (for SDK/clients)
+
+#### Parameters
+
+##### meta
+
+[`ProtocolMetaFields`](../../../utils/protocolMeta/interfaces/ProtocolMetaFields.md)
+
+#### Returns
+
+`TransactionInstruction`

package/docs/adapters/SolanaAdapter/type-aliases/SolanaContext.md

@@ -0,0 +1,27 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [adapters/SolanaAdapter](../README.md) / SolanaContext
+
+# Type Alias: SolanaContext
+
+> **SolanaContext** = `object`
+
+Defined in: src/adapters/SolanaAdapter.ts:22
+
+## Properties
+
+### pubkey
+
+> **pubkey**: `string` \| `PublicKey`
+
+Defined in: src/adapters/SolanaAdapter.ts:23
+
+***
+
+### signature
+
+> **signature**: `string`
+
+Defined in: src/adapters/SolanaAdapter.ts:24

package/docs/adapters/SolanaAdapter/type-aliases/SolanaTransaction.md

@@ -0,0 +1,13 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [adapters/SolanaAdapter](../README.md) / SolanaTransaction
+
+# Type Alias: SolanaTransaction
+
+> **SolanaTransaction** = `Transaction` \| `VersionedTransaction`
+
+Defined in: src/adapters/SolanaAdapter.ts:28
+
+Union of supported Solana txn types

package/docs/constants/README.md

@@ -1,22 +1,17 @@
-[**@actioncodes/protocol**](../README.md)
+[**@actioncodes/protocol-v2**](../README.md)
 
 ***
 
-[@actioncodes/protocol](../modules.md) / constants
+[@actioncodes/protocol-v2](../modules.md) / constants
 
 # constants
 
-## Type Aliases
-
-- [SupportedChain](type-aliases/SupportedChain.md)
-
 ## Variables
 
-- [CODE\_LENGTH](variables/CODE_LENGTH.md)
-- [CODE\_TTL](variables/CODE_TTL.md)
-- [MAX\_PREFIX\_LENGTH](variables/MAX_PREFIX_LENGTH.md)
-- [MIN\_PREFIX\_LENGTH](variables/MIN_PREFIX_LENGTH.md)
-- [PROTOCOL\_CODE\_PREFIX](variables/PROTOCOL_CODE_PREFIX.md)
-- [PROTOCOL\_PREFIX](variables/PROTOCOL_PREFIX.md)
-- [PROTOCOL\_VERSION](variables/PROTOCOL_VERSION.md)
+- [CODE\_CHARSET\_DIGITS](variables/CODE_CHARSET_DIGITS.md)
+- [CODE\_DEFAULT\_LENGTH](variables/CODE_DEFAULT_LENGTH.md)
+- [CODE\_MAX\_LENGTH](variables/CODE_MAX_LENGTH.md)
+- [CODE\_MIN\_LENGTH](variables/CODE_MIN_LENGTH.md)
+- [PROTOCOL\_META\_MAX\_BYTES](variables/PROTOCOL_META_MAX_BYTES.md)
+- [PROTOCOL\_NORMALIZATION](variables/PROTOCOL_NORMALIZATION.md)
 - [SUPPORTED\_CHAINS](variables/SUPPORTED_CHAINS.md)

package/docs/constants/variables/CODE_CHARSET_DIGITS.md

@@ -0,0 +1,11 @@
+[**@actioncodes/protocol-v2**](../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../modules.md) / [constants](../README.md) / CODE\_CHARSET\_DIGITS
+
+# Variable: CODE\_CHARSET\_DIGITS
+
+> `const` **CODE\_CHARSET\_DIGITS**: `"0123456789"` = `"0123456789"`
+
+Defined in: src/constants.ts:11

package/docs/constants/variables/CODE_DEFAULT_LENGTH.md

@@ -0,0 +1,11 @@
+[**@actioncodes/protocol-v2**](../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../modules.md) / [constants](../README.md) / CODE\_DEFAULT\_LENGTH
+
+# Variable: CODE\_DEFAULT\_LENGTH
+
+> `const` **CODE\_DEFAULT\_LENGTH**: `8` = `8`
+
+Defined in: src/constants.ts:8

package/docs/constants/variables/CODE_MAX_LENGTH.md

@@ -0,0 +1,11 @@
+[**@actioncodes/protocol-v2**](../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../modules.md) / [constants](../README.md) / CODE\_MAX\_LENGTH
+
+# Variable: CODE\_MAX\_LENGTH
+
+> `const` **CODE\_MAX\_LENGTH**: `24` = `24`
+
+Defined in: src/constants.ts:7

package/docs/constants/variables/CODE_MIN_LENGTH.md

@@ -0,0 +1,11 @@
+[**@actioncodes/protocol-v2**](../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../modules.md) / [constants](../README.md) / CODE\_MIN\_LENGTH
+
+# Variable: CODE\_MIN\_LENGTH
+
+> `const` **CODE\_MIN\_LENGTH**: `6` = `6`
+
+Defined in: src/constants.ts:6

package/docs/constants/variables/PROTOCOL_META_MAX_BYTES.md

@@ -0,0 +1,11 @@
+[**@actioncodes/protocol-v2**](../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../modules.md) / [constants](../README.md) / PROTOCOL\_META\_MAX\_BYTES
+
+# Variable: PROTOCOL\_META\_MAX\_BYTES
+
+> `const` **PROTOCOL\_META\_MAX\_BYTES**: `256` = `256`
+
+Defined in: src/constants.ts:4

package/docs/constants/variables/PROTOCOL_NORMALIZATION.md

@@ -0,0 +1,11 @@
+[**@actioncodes/protocol-v2**](../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../modules.md) / [constants](../README.md) / PROTOCOL\_NORMALIZATION
+
+# Variable: PROTOCOL\_NORMALIZATION
+
+> `const` **PROTOCOL\_NORMALIZATION**: `"NFC"` = `"NFC"`
+
+Defined in: src/constants.ts:3

package/docs/constants/variables/SUPPORTED_CHAINS.md

@@ -1,11 +1,11 @@
-[**@actioncodes/protocol**](../../README.md)
+[**@actioncodes/protocol-v2**](../../README.md)
 
 ***
 
-[@actioncodes/protocol](../../modules.md) / [constants](../README.md) / SUPPORTED\_CHAINS
+[@actioncodes/protocol-v2](../../modules.md) / [constants](../README.md) / SUPPORTED\_CHAINS
 
 # Variable: SUPPORTED\_CHAINS
 
 > `const` **SUPPORTED\_CHAINS**: readonly \[`"solana"`\]
 
-Defined in: [constants.ts:8](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/constants.ts#L8)
+Defined in: src/constants.ts:13

package/docs/errors/README.md

@@ -0,0 +1,22 @@
+[**@actioncodes/protocol-v2**](../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../modules.md) / errors
+
+# errors
+
+## Enumerations
+
+- [ProtocolErrorCode](enumerations/ProtocolErrorCode.md)
+
+## Classes
+
+- [ExpiredCodeError](classes/ExpiredCodeError.md)
+- [InvalidCodeFormatError](classes/InvalidCodeFormatError.md)
+- [InvalidPubkeyFormatError](classes/InvalidPubkeyFormatError.md)
+- [InvalidSignatureError](classes/InvalidSignatureError.md)
+- [MetaMismatchError](classes/MetaMismatchError.md)
+- [MissingMetaError](classes/MissingMetaError.md)
+- [ProtocolError](classes/ProtocolError.md)
+- [TransactionNotSignedByIntendedOwnerError](classes/TransactionNotSignedByIntendedOwnerError.md)