@actioncodes/protocol 2.0.21 → 2.0.23

package/docs/adapters/BaseChainAdapter/interfaces/ChainAdapter.md

@@ -1,32 +1,88 @@
-[**@actioncodes/protocol-v2**](../../../README.md)
+[**@actioncodes/protocol**](../../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../../modules.md) / [adapters/BaseChainAdapter](../README.md) / ChainAdapter
+[@actioncodes/protocol](../../../modules.md) / [adapters/BaseChainAdapter](../README.md) / ChainAdapter
 
-# Interface: ChainAdapter\<TCtx\>
+# Interface: ChainAdapter
+
+Defined in: src/adapters/BaseChainAdapter.ts:3
+
+## Methods
+
+### verifyRevokeWithDelegation()
+
+> **verifyRevokeWithDelegation**(`actionCode`, `revokeSignature`): `boolean`
 
 Defined in: src/adapters/BaseChainAdapter.ts:10
 
-## Type Parameters
+#### Parameters
 
-### TCtx
+##### actionCode
 
-`TCtx` = `unknown`
+[`DelegatedActionCode`](../../../types/interfaces/DelegatedActionCode.md)
 
-## Methods
+##### revokeSignature
+
+`string`
+
+#### Returns
+
+`boolean`
+
+***
+
+### verifyRevokeWithWallet()
+
+> **verifyRevokeWithWallet**(`actionCode`, `revokeSignature`): `boolean`
+
+Defined in: src/adapters/BaseChainAdapter.ts:6
+
+#### Parameters
+
+##### actionCode
+
+[`ActionCode`](../../../types/interfaces/ActionCode.md)
+
+##### revokeSignature
+
+`string`
+
+#### Returns
+
+`boolean`
+
+***
+
+### verifyWithDelegation()
+
+> **verifyWithDelegation**(`actionCode`): `boolean`
+
+Defined in: src/adapters/BaseChainAdapter.ts:5
+
+#### Parameters
+
+##### actionCode
+
+[`DelegatedActionCode`](../../../types/interfaces/DelegatedActionCode.md)
+
+#### Returns
+
+`boolean`
+
+***
 
-### verify()
+### verifyWithWallet()
 
-> **verify**(`context`): `boolean`
+> **verifyWithWallet**(`actionCode`): `boolean`
 
-Defined in: src/adapters/BaseChainAdapter.ts:11
+Defined in: src/adapters/BaseChainAdapter.ts:4
 
 #### Parameters
 
-##### context
+##### actionCode
 
-[`ChainContext`](../type-aliases/ChainContext.md)\<`TCtx`\>
+[`ActionCode`](../../../types/interfaces/ActionCode.md)
 
 #### Returns
 

package/docs/adapters/BaseChainAdapter/type-aliases/SignFn.md

@@ -0,0 +1,25 @@
+[**@actioncodes/protocol**](../../../README.md)
+
+***
+
+[@actioncodes/protocol](../../../modules.md) / [adapters/BaseChainAdapter](../README.md) / SignFn
+
+# Type Alias: SignFn()
+
+> **SignFn** = (`message`, `chain`) => `Promise`\<`string`\>
+
+Defined in: src/adapters/BaseChainAdapter.ts:16
+
+## Parameters
+
+### message
+
+`Uint8Array`
+
+### chain
+
+[`Chain`](../../../types/type-aliases/Chain.md)
+
+## Returns
+
+`Promise`\<`string`\>

package/docs/adapters/SolanaAdapter/README.md

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../../README.md)
+[**@actioncodes/protocol**](../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../modules.md) / adapters/SolanaAdapter
+[@actioncodes/protocol](../../modules.md) / adapters/SolanaAdapter
 
 # adapters/SolanaAdapter
 
@@ -12,5 +12,8 @@
 
 ## Type Aliases
 
-- [SolanaContext](type-aliases/SolanaContext.md)
 - [SolanaTransaction](type-aliases/SolanaTransaction.md)
+
+## Variables
+
+- [ADAPTER\_CHAIN\_NAME](variables/ADAPTER_CHAIN_NAME.md)

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

@@ -1,16 +1,16 @@
-[**@actioncodes/protocol-v2**](../../../README.md)
+[**@actioncodes/protocol**](../../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../../modules.md) / [adapters/SolanaAdapter](../README.md) / SolanaAdapter
+[@actioncodes/protocol](../../../modules.md) / [adapters/SolanaAdapter](../README.md) / SolanaAdapter
 
 # Class: SolanaAdapter
 
-Defined in: src/adapters/SolanaAdapter.ts:30
+Defined in: src/adapters/SolanaAdapter.ts:31
 
 ## Extends
 
-- [`BaseChainAdapter`](../../BaseChainAdapter/classes/BaseChainAdapter.md)\<[`SolanaContext`](../type-aliases/SolanaContext.md)\>
+- [`BaseChainAdapter`](../../BaseChainAdapter/classes/BaseChainAdapter.md)
 
 ## Constructors
 
@@ -30,17 +30,17 @@ Defined in: src/adapters/SolanaAdapter.ts:30
 
 ### getProtocolMeta()
 
-> **getProtocolMeta**(`tx`): `null` \| `string`
+> **getProtocolMeta**(`txString`): `null` \| `string`
 
-Defined in: src/adapters/SolanaAdapter.ts:81
+Defined in: src/adapters/SolanaAdapter.ts:280
 
-Extract protocol metadata string (memo) from a transaction, or null
+Extract protocol metadata string (memo) from a base64-encoded transaction, or null
 
 #### Parameters
 
-##### tx
+##### txString
 
-[`SolanaTransaction`](../type-aliases/SolanaTransaction.md)
+`string`
 
 #### Returns
 
@@ -50,17 +50,17 @@ Extract protocol metadata string (memo) from a transaction, or null
 
 ### parseMeta()
 
-> **parseMeta**(`tx`): `null` \| [`ProtocolMetaFields`](../../../utils/protocolMeta/interfaces/ProtocolMetaFields.md)
+> **parseMeta**(`txString`): `null` \| [`ProtocolMetaFields`](../../../utils/protocolMeta/interfaces/ProtocolMetaFields.md)
 
-Defined in: src/adapters/SolanaAdapter.ts:97
+Defined in: src/adapters/SolanaAdapter.ts:329
 
-Get parsed ProtocolMeta object, or null if none or invalid
+Get parsed ProtocolMeta object from base64-encoded transaction, or null if none or invalid
 
 #### Parameters
 
-##### tx
+##### txString
 
-[`SolanaTransaction`](../type-aliases/SolanaTransaction.md)
+`string`
 
 #### Returns
 
@@ -68,19 +68,47 @@ Get parsed ProtocolMeta object, or null if none or invalid
 
 ***
 
-### verify()
+### verifyMessageSignedByIntentOwner()
 
-> **verify**(`context`): `boolean`
+> **verifyMessageSignedByIntentOwner**(`message`, `signature`, `pubkey`): `void`
 
-Defined in: src/adapters/SolanaAdapter.ts:40
+Defined in: src/adapters/SolanaAdapter.ts:525
 
-Verify the signature over canonical message (protocol-level)
+#### Parameters
+
+##### message
+
+`string`
+
+##### signature
+
+`string`
+
+##### pubkey
+
+`string`
+
+#### Returns
+
+`void`
+
+***
+
+### verifyRevokeWithDelegation()
+
+> **verifyRevokeWithDelegation**(`delegatedActionCode`, `revokeSignature`): `boolean`
+
+Defined in: src/adapters/SolanaAdapter.ts:187
 
 #### Parameters
 
-##### context
+##### delegatedActionCode
+
+[`DelegatedActionCode`](../../../types/interfaces/DelegatedActionCode.md)
+
+##### revokeSignature
 
-[`ChainContext`](../../BaseChainAdapter/type-aliases/ChainContext.md)\<[`SolanaContext`](../type-aliases/SolanaContext.md)\>
+`string`
 
 #### Returns
 
@@ -88,17 +116,45 @@ Verify the signature over canonical message (protocol-level)
 
 #### Overrides
 
-[`BaseChainAdapter`](../../BaseChainAdapter/classes/BaseChainAdapter.md).[`verify`](../../BaseChainAdapter/classes/BaseChainAdapter.md#verify)
+[`BaseChainAdapter`](../../BaseChainAdapter/classes/BaseChainAdapter.md).[`verifyRevokeWithDelegation`](../../BaseChainAdapter/classes/BaseChainAdapter.md#verifyrevokewithdelegation)
+
+***
+
+### verifyRevokeWithWallet()
+
+> **verifyRevokeWithWallet**(`actionCode`, `revokeSignature`): `boolean`
+
+Defined in: src/adapters/SolanaAdapter.ts:154
+
+Verify the signature over canonical revoke message (protocol-level)
+
+#### Parameters
+
+##### actionCode
+
+[`ActionCode`](../../../types/interfaces/ActionCode.md)
+
+##### revokeSignature
+
+`string`
+
+#### Returns
+
+`boolean`
+
+#### Overrides
+
+[`BaseChainAdapter`](../../BaseChainAdapter/classes/BaseChainAdapter.md).[`verifyRevokeWithWallet`](../../BaseChainAdapter/classes/BaseChainAdapter.md#verifyrevokewithwallet)
 
 ***
 
 ### verifyTransactionMatchesCode()
 
-> **verifyTransactionMatchesCode**(`actionCode`, `tx`): `void`
+> **verifyTransactionMatchesCode**(`actionCode`, `txString`): `void`
 
-Defined in: src/adapters/SolanaAdapter.ts:143
+Defined in: src/adapters/SolanaAdapter.ts:375
 
-Validate that a transaction's memo meta aligns with the bound `actionCode`.
+Validate that a base64-encoded transaction's memo meta aligns with the bound `actionCode`.
 Throws ProtocolError if validation fails.
 
 #### Parameters
@@ -107,9 +163,9 @@ Throws ProtocolError if validation fails.
 
 [`ActionCode`](../../../types/interfaces/ActionCode.md)
 
-##### tx
+##### txString
 
-[`SolanaTransaction`](../type-aliases/SolanaTransaction.md)
+`string`
 
 #### Returns
 
@@ -119,19 +175,19 @@ Throws ProtocolError if validation fails.
 
 ### verifyTransactionSignedByIntentOwner()
 
-> **verifyTransactionSignedByIntentOwner**(`tx`): `void`
+> **verifyTransactionSignedByIntentOwner**(`txString`): `void`
 
-Defined in: src/adapters/SolanaAdapter.ts:184
+Defined in: src/adapters/SolanaAdapter.ts:413
 
-Verify that the transaction is signed by the "intendedFor" pubkey
+Verify that the base64-encoded transaction is signed by the "intendedFor" pubkey
 as declared in the protocol meta of the transaction.
 Throws ProtocolError if validation fails.
 
 #### Parameters
 
-##### tx
+##### txString
 
-[`SolanaTransaction`](../type-aliases/SolanaTransaction.md)
+`string`
 
 #### Returns
 
@@ -139,27 +195,68 @@ Throws ProtocolError if validation fails.
 
 ***
 
-### attachProtocolMeta()
+### verifyWithDelegation()
+
+> **verifyWithDelegation**(`delegatedActionCode`): `boolean`
+
+Defined in: src/adapters/SolanaAdapter.ts:71
+
+Verify delegation proof signature
+
+#### Parameters
+
+##### delegatedActionCode
+
+[`DelegatedActionCode`](../../../types/interfaces/DelegatedActionCode.md)
+
+#### Returns
+
+`boolean`
+
+#### Overrides
+
+[`BaseChainAdapter`](../../BaseChainAdapter/classes/BaseChainAdapter.md).[`verifyWithDelegation`](../../BaseChainAdapter/classes/BaseChainAdapter.md#verifywithdelegation)
+
+***
 
-> `static` **attachProtocolMeta**\<`T`\>(`tx`, `meta`): `T`
+### verifyWithWallet()
 
-Defined in: src/adapters/SolanaAdapter.ts:257
+> **verifyWithWallet**(`actionCode`): `boolean`
 
-Attach protocol meta into a legacy or versioned transaction.
+Defined in: src/adapters/SolanaAdapter.ts:41
 
-⚠️ Note: this mutates the given transaction.
+Verify the signature over canonical message (protocol-level)
+
+#### Parameters
+
+##### actionCode
+
+[`ActionCode`](../../../types/interfaces/ActionCode.md)
+
+#### Returns
+
+`boolean`
+
+#### Overrides
+
+[`BaseChainAdapter`](../../BaseChainAdapter/classes/BaseChainAdapter.md).[`verifyWithWallet`](../../BaseChainAdapter/classes/BaseChainAdapter.md#verifywithwallet)
+
+***
+
+### attachProtocolMeta()
 
-#### Type Parameters
+> `static` **attachProtocolMeta**(`txString`, `meta`): `string`
 
-##### T
+Defined in: src/adapters/SolanaAdapter.ts:560
 
-`T` *extends* [`SolanaTransaction`](../type-aliases/SolanaTransaction.md)
+Attach protocol meta into a base64-encoded transaction and return the modified transaction as base64.
+Throws ProtocolError if the transaction already contains protocol meta.
 
 #### Parameters
 
-##### tx
+##### txString
 
-`T`
+`string`
 
 ##### meta
 
@@ -167,7 +264,7 @@ Attach protocol meta into a legacy or versioned transaction.
 
 #### Returns
 
-`T`
+`string`
 
 ***
 
@@ -175,7 +272,7 @@ Attach protocol meta into a legacy or versioned transaction.
 
 > `static` **createProtocolMetaIx**(`meta`): `TransactionInstruction`
 
-Defined in: src/adapters/SolanaAdapter.ts:73
+Defined in: src/adapters/SolanaAdapter.ts:272
 
 Create a Solana memo instruction carrying protocol meta (for SDK/clients)
 

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

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

package/docs/adapters/SolanaAdapter/variables/ADAPTER_CHAIN_NAME.md

@@ -0,0 +1,11 @@
+[**@actioncodes/protocol**](../../../README.md)
+
+***
+
+[@actioncodes/protocol](../../../modules.md) / [adapters/SolanaAdapter](../README.md) / ADAPTER\_CHAIN\_NAME
+
+# Variable: ADAPTER\_CHAIN\_NAME
+
+> `const` **ADAPTER\_CHAIN\_NAME**: `"solana"`
+
+Defined in: src/adapters/SolanaAdapter.ts:29

package/docs/constants/README.md

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../README.md)
+[**@actioncodes/protocol**](../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../modules.md) / constants
+[@actioncodes/protocol](../modules.md) / constants
 
 # constants
 

package/docs/constants/variables/CODE_CHARSET_DIGITS.md

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../../README.md)
+[**@actioncodes/protocol**](../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../modules.md) / [constants](../README.md) / CODE\_CHARSET\_DIGITS
+[@actioncodes/protocol](../../modules.md) / [constants](../README.md) / CODE\_CHARSET\_DIGITS
 
 # Variable: CODE\_CHARSET\_DIGITS
 

package/docs/constants/variables/CODE_DEFAULT_LENGTH.md

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../../README.md)
+[**@actioncodes/protocol**](../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../modules.md) / [constants](../README.md) / CODE\_DEFAULT\_LENGTH
+[@actioncodes/protocol](../../modules.md) / [constants](../README.md) / CODE\_DEFAULT\_LENGTH
 
 # Variable: CODE\_DEFAULT\_LENGTH
 

package/docs/constants/variables/CODE_MAX_LENGTH.md

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../../README.md)
+[**@actioncodes/protocol**](../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../modules.md) / [constants](../README.md) / CODE\_MAX\_LENGTH
+[@actioncodes/protocol](../../modules.md) / [constants](../README.md) / CODE\_MAX\_LENGTH
 
 # Variable: CODE\_MAX\_LENGTH
 

package/docs/constants/variables/CODE_MIN_LENGTH.md

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../../README.md)
+[**@actioncodes/protocol**](../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../modules.md) / [constants](../README.md) / CODE\_MIN\_LENGTH
+[@actioncodes/protocol](../../modules.md) / [constants](../README.md) / CODE\_MIN\_LENGTH
 
 # Variable: CODE\_MIN\_LENGTH
 

package/docs/constants/variables/PROTOCOL_META_MAX_BYTES.md

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

package/docs/constants/variables/PROTOCOL_NORMALIZATION.md

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../../README.md)
+[**@actioncodes/protocol**](../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../modules.md) / [constants](../README.md) / PROTOCOL\_NORMALIZATION
+[@actioncodes/protocol](../../modules.md) / [constants](../README.md) / PROTOCOL\_NORMALIZATION
 
 # Variable: PROTOCOL\_NORMALIZATION
 

package/docs/constants/variables/SUPPORTED_CHAINS.md

@@ -1,11 +1,17 @@
-[**@actioncodes/protocol-v2**](../../README.md)
+[**@actioncodes/protocol**](../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../modules.md) / [constants](../README.md) / SUPPORTED\_CHAINS
+[@actioncodes/protocol](../../modules.md) / [constants](../README.md) / SUPPORTED\_CHAINS
 
 # Variable: SUPPORTED\_CHAINS
 
-> `const` **SUPPORTED\_CHAINS**: readonly \[`"solana"`\]
+> `const` **SUPPORTED\_CHAINS**: `object`
 
 Defined in: src/constants.ts:13
+
+## Type Declaration
+
+### solana
+
+> `readonly` **solana**: `"solana"` = `"solana"`

package/docs/errors/README.md

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../README.md)
+[**@actioncodes/protocol**](../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../modules.md) / errors
+[@actioncodes/protocol](../modules.md) / errors
 
 # errors
 
@@ -13,6 +13,7 @@
 ## Classes
 
 - [ExpiredCodeError](classes/ExpiredCodeError.md)
+- [InvalidAdapterError](classes/InvalidAdapterError.md)
 - [InvalidCodeFormatError](classes/InvalidCodeFormatError.md)
 - [InvalidPubkeyFormatError](classes/InvalidPubkeyFormatError.md)
 - [InvalidSignatureError](classes/InvalidSignatureError.md)
@@ -20,3 +21,4 @@
 - [MissingMetaError](classes/MissingMetaError.md)
 - [ProtocolError](classes/ProtocolError.md)
 - [TransactionNotSignedByIntendedOwnerError](classes/TransactionNotSignedByIntendedOwnerError.md)
+- [TransactionNotSignedByIssuerError](classes/TransactionNotSignedByIssuerError.md)