@actioncodes/protocol 2.0.22 → 2.0.23

package/docs/errors/enumerations/ProtocolErrorCode.md

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../../README.md)
+[**@actioncodes/protocol**](../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../modules.md) / [errors](../README.md) / ProtocolErrorCode
+[@actioncodes/protocol](../../modules.md) / [errors](../README.md) / ProtocolErrorCode
 
 # Enumeration: ProtocolErrorCode
 
@@ -14,7 +14,7 @@ Defined in: src/errors.ts:1
 
 > **CRYPTO\_ERROR**: `"CRYPTO_ERROR"`
 
-Defined in: src/errors.ts:23
+Defined in: src/errors.ts:25
 
 ***
 
@@ -26,11 +26,27 @@ Defined in: src/errors.ts:3
 
 ***
 
+### INVALID\_ADAPTER
+
+> **INVALID\_ADAPTER**: `"INVALID_ADAPTER"`
+
+Defined in: src/errors.ts:29
+
+***
+
+### INVALID\_CODE
+
+> **INVALID\_CODE**: `"INVALID_CODE"`
+
+Defined in: src/errors.ts:4
+
+***
+
 ### INVALID\_CODE\_FORMAT
 
 > **INVALID\_CODE\_FORMAT**: `"INVALID_CODE_FORMAT"`
 
-Defined in: src/errors.ts:4
+Defined in: src/errors.ts:5
 
 ***
 
@@ -38,7 +54,7 @@ Defined in: src/errors.ts:4
 
 > **INVALID\_DIGEST**: `"INVALID_DIGEST"`
 
-Defined in: src/errors.ts:24
+Defined in: src/errors.ts:26
 
 ***
 
@@ -46,7 +62,7 @@ Defined in: src/errors.ts:24
 
 > **INVALID\_INPUT**: `"INVALID_INPUT"`
 
-Defined in: src/errors.ts:19
+Defined in: src/errors.ts:21
 
 ***
 
@@ -54,7 +70,7 @@ Defined in: src/errors.ts:19
 
 > **INVALID\_META\_FORMAT**: `"INVALID_META_FORMAT"`
 
-Defined in: src/errors.ts:9
+Defined in: src/errors.ts:10
 
 ***
 
@@ -62,7 +78,7 @@ Defined in: src/errors.ts:9
 
 > **INVALID\_PUBKEY\_FORMAT**: `"INVALID_PUBKEY_FORMAT"`
 
-Defined in: src/errors.ts:16
+Defined in: src/errors.ts:18
 
 ***
 
@@ -70,7 +86,7 @@ Defined in: src/errors.ts:16
 
 > **INVALID\_SIGNATURE**: `"INVALID_SIGNATURE"`
 
-Defined in: src/errors.ts:5
+Defined in: src/errors.ts:6
 
 ***
 
@@ -78,7 +94,7 @@ Defined in: src/errors.ts:5
 
 > **INVALID\_TRANSACTION\_FORMAT**: `"INVALID_TRANSACTION_FORMAT"`
 
-Defined in: src/errors.ts:15
+Defined in: src/errors.ts:17
 
 ***
 
@@ -86,7 +102,7 @@ Defined in: src/errors.ts:15
 
 > **META\_MISMATCH**: `"META_MISMATCH"`
 
-Defined in: src/errors.ts:10
+Defined in: src/errors.ts:11
 
 ***
 
@@ -94,7 +110,7 @@ Defined in: src/errors.ts:10
 
 > **META\_TOO\_LARGE**: `"META_TOO_LARGE"`
 
-Defined in: src/errors.ts:11
+Defined in: src/errors.ts:12
 
 ***
 
@@ -102,7 +118,7 @@ Defined in: src/errors.ts:11
 
 > **MISSING\_META**: `"MISSING_META"`
 
-Defined in: src/errors.ts:8
+Defined in: src/errors.ts:9
 
 ***
 
@@ -110,7 +126,7 @@ Defined in: src/errors.ts:8
 
 > **MISSING\_REQUIRED\_FIELD**: `"MISSING_REQUIRED_FIELD"`
 
-Defined in: src/errors.ts:20
+Defined in: src/errors.ts:22
 
 ***
 
@@ -118,4 +134,12 @@ Defined in: src/errors.ts:20
 
 > **TRANSACTION\_NOT\_SIGNED\_BY\_INTENDED\_OWNER**: `"TRANSACTION_NOT_SIGNED_BY_INTENDED_OWNER"`
 
-Defined in: src/errors.ts:14
+Defined in: src/errors.ts:15
+
+***
+
+### TRANSACTION\_NOT\_SIGNED\_BY\_ISSUER
+
+> **TRANSACTION\_NOT\_SIGNED\_BY\_ISSUER**: `"TRANSACTION_NOT_SIGNED_BY_ISSUER"`
+
+Defined in: src/errors.ts:16

package/docs/index/README.md

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../README.md)
+[**@actioncodes/protocol**](../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../modules.md) / index
+[@actioncodes/protocol](../modules.md) / index
 
 # index
 
@@ -14,12 +14,24 @@ Re-exports [ActionCode](../types/interfaces/ActionCode.md)
 
 ***
 
+### ActionCodeRevoke
+
+Re-exports [ActionCodeRevoke](../types/interfaces/ActionCodeRevoke.md)
+
+***
+
 ### ActionCodesProtocol
 
 Re-exports [ActionCodesProtocol](../ActionCodesProtocol/classes/ActionCodesProtocol.md)
 
 ***
 
+### ADAPTER\_CHAIN\_NAME
+
+Re-exports [ADAPTER_CHAIN_NAME](../adapters/SolanaAdapter/variables/ADAPTER_CHAIN_NAME.md)
+
+***
+
 ### base32EncodeCrockford
 
 Re-exports [base32EncodeCrockford](../utils/crypto/functions/base32EncodeCrockford.md)
@@ -32,6 +44,12 @@ Re-exports [BaseChainAdapter](../adapters/BaseChainAdapter/classes/BaseChainAdap
 
 ***
 
+### buildProtocolMeta
+
+Re-exports [buildProtocolMeta](../utils/protocolMeta/functions/buildProtocolMeta.md)
+
+***
+
 ### CANONICAL\_MESSAGE\_PREFIX
 
 Re-exports [CANONICAL_MESSAGE_PREFIX](../utils/canonical/variables/CANONICAL_MESSAGE_PREFIX.md)
@@ -44,15 +62,33 @@ Re-exports [CANONICAL_MESSAGE_VERSION](../utils/canonical/variables/CANONICAL_ME
 
 ***
 
+### CANONICAL\_REVOKE\_MESSAGE\_PREFIX
+
+Re-exports [CANONICAL_REVOKE_MESSAGE_PREFIX](../utils/canonical/variables/CANONICAL_REVOKE_MESSAGE_PREFIX.md)
+
+***
+
 ### CanonicalMessageParts
 
 Re-exports [CanonicalMessageParts](../types/interfaces/CanonicalMessageParts.md)
 
 ***
 
-### ChainContext
+### CanonicalRevokeMessageParts
+
+Re-exports [CanonicalRevokeMessageParts](../types/interfaces/CanonicalRevokeMessageParts.md)
+
+***
+
+### Chain
+
+Re-exports [Chain](../types/type-aliases/Chain.md)
+
+***
+
+### ChainAdapter
 
-Re-exports [ChainContext](../adapters/BaseChainAdapter/type-aliases/ChainContext.md)
+Re-exports [ChainAdapter](../adapters/BaseChainAdapter/interfaces/ChainAdapter.md)
 
 ***
 
@@ -86,15 +122,33 @@ Re-exports [CodeGenerationConfig](../types/interfaces/CodeGenerationConfig.md)
 
 ***
 
-### CodeGenerationResult
+### codeHash
 
-Re-exports [CodeGenerationResult](../types/interfaces/CodeGenerationResult.md)
+Re-exports [codeHash](../utils/crypto/functions/codeHash.md)
 
 ***
 
-### codeHash
+### DelegatedActionCode
 
-Re-exports [codeHash](../utils/crypto/functions/codeHash.md)
+Re-exports [DelegatedActionCode](../types/interfaces/DelegatedActionCode.md)
+
+***
+
+### DelegatedActionCodeRevoke
+
+Re-exports [DelegatedActionCodeRevoke](../types/interfaces/DelegatedActionCodeRevoke.md)
+
+***
+
+### DelegationProof
+
+Re-exports [DelegationProof](../types/interfaces/DelegationProof.md)
+
+***
+
+### DelegationStrategy
+
+Re-exports [DelegationStrategy](../strategy/DelegationStrategy/classes/DelegationStrategy.md)
 
 ***
 
@@ -104,9 +158,15 @@ Re-exports [digestToDigits](../utils/crypto/functions/digestToDigits.md)
 
 ***
 
-### generateRandomSecret
+### ExpiredCodeError
+
+Re-exports [ExpiredCodeError](../errors/classes/ExpiredCodeError.md)
+
+***
+
+### getCanonicalMessageParts
 
-Re-exports [generateRandomSecret](../utils/crypto/functions/generateRandomSecret.md)
+Re-exports [getCanonicalMessageParts](../utils/canonical/functions/getCanonicalMessageParts.md)
 
 ***
 
@@ -122,6 +182,48 @@ Re-exports [hmacSha256](../utils/crypto/functions/hmacSha256.md)
 
 ***
 
+### InvalidAdapterError
+
+Re-exports [InvalidAdapterError](../errors/classes/InvalidAdapterError.md)
+
+***
+
+### InvalidCodeFormatError
+
+Re-exports [InvalidCodeFormatError](../errors/classes/InvalidCodeFormatError.md)
+
+***
+
+### InvalidPubkeyFormatError
+
+Re-exports [InvalidPubkeyFormatError](../errors/classes/InvalidPubkeyFormatError.md)
+
+***
+
+### InvalidSignatureError
+
+Re-exports [InvalidSignatureError](../errors/classes/InvalidSignatureError.md)
+
+***
+
+### MetaMismatchError
+
+Re-exports [MetaMismatchError](../errors/classes/MetaMismatchError.md)
+
+***
+
+### MissingMetaError
+
+Re-exports [MissingMetaError](../errors/classes/MissingMetaError.md)
+
+***
+
+### parseProtocolMeta
+
+Re-exports [parseProtocolMeta](../utils/protocolMeta/functions/parseProtocolMeta.md)
+
+***
+
 ### PROTOCOL\_META\_MAX\_BYTES
 
 Re-exports [PROTOCOL_META_MAX_BYTES](../constants/variables/PROTOCOL_META_MAX_BYTES.md)
@@ -134,27 +236,63 @@ Re-exports [PROTOCOL_NORMALIZATION](../constants/variables/PROTOCOL_NORMALIZATIO
 
 ***
 
+### ProtocolError
+
+Re-exports [ProtocolError](../errors/classes/ProtocolError.md)
+
+***
+
+### ProtocolErrorCode
+
+Re-exports [ProtocolErrorCode](../errors/enumerations/ProtocolErrorCode.md)
+
+***
+
+### ProtocolMetaFields
+
+Re-exports [ProtocolMetaFields](../utils/protocolMeta/interfaces/ProtocolMetaFields.md)
+
+***
+
+### SCHEME
+
+Re-exports [SCHEME](../utils/protocolMeta/variables/SCHEME.md)
+
+***
+
 ### serializeCanonical
 
 Re-exports [serializeCanonical](../utils/canonical/functions/serializeCanonical.md)
 
 ***
 
+### serializeCanonicalRevoke
+
+Re-exports [serializeCanonicalRevoke](../utils/canonical/functions/serializeCanonicalRevoke.md)
+
+***
+
+### serializeDelegationProof
+
+Re-exports [serializeDelegationProof](../utils/canonical/functions/serializeDelegationProof.md)
+
+***
+
 ### sha256
 
 Re-exports [sha256](../utils/crypto/functions/sha256.md)
 
 ***
 
-### SolanaAdapter
+### SignFn
 
-Re-exports [SolanaAdapter](../adapters/SolanaAdapter/classes/SolanaAdapter.md)
+Re-exports [SignFn](../adapters/BaseChainAdapter/type-aliases/SignFn.md)
 
 ***
 
-### SolanaContext
+### SolanaAdapter
 
-Re-exports [SolanaContext](../adapters/SolanaAdapter/type-aliases/SolanaContext.md)
+Re-exports [SolanaAdapter](../adapters/SolanaAdapter/classes/SolanaAdapter.md)
 
 ***
 
@@ -170,12 +308,30 @@ Re-exports [SUPPORTED_CHAINS](../constants/variables/SUPPORTED_CHAINS.md)
 
 ***
 
+### TransactionNotSignedByIntendedOwnerError
+
+Re-exports [TransactionNotSignedByIntendedOwnerError](../errors/classes/TransactionNotSignedByIntendedOwnerError.md)
+
+***
+
+### TransactionNotSignedByIssuerError
+
+Re-exports [TransactionNotSignedByIssuerError](../errors/classes/TransactionNotSignedByIssuerError.md)
+
+***
+
 ### truncateBits
 
 Re-exports [truncateBits](../utils/crypto/functions/truncateBits.md)
 
 ***
 
+### validateProtocolMetaFormat
+
+Re-exports [validateProtocolMetaFormat](../utils/protocolMeta/functions/validateProtocolMetaFormat.md)
+
+***
+
 ### WalletStrategy
 
 Re-exports [WalletStrategy](../strategy/WalletStrategy/classes/WalletStrategy.md)

package/docs/modules.md

@@ -1,18 +1,18 @@
-[**@actioncodes/protocol-v2**](README.md)
+[**@actioncodes/protocol**](README.md)
 
 ***
 
-# @actioncodes/protocol-v2
+# @actioncodes/protocol
 
 ## Modules
 
 - [ActionCodesProtocol](ActionCodesProtocol/README.md)
 - [adapters/BaseChainAdapter](adapters/BaseChainAdapter/README.md)
-- [adapters/NodeCryptoAdapter](adapters/NodeCryptoAdapter/README.md)
 - [adapters/SolanaAdapter](adapters/SolanaAdapter/README.md)
 - [constants](constants/README.md)
 - [errors](errors/README.md)
 - [index](index/README.md)
+- [strategy/DelegationStrategy](strategy/DelegationStrategy/README.md)
 - [strategy/WalletStrategy](strategy/WalletStrategy/README.md)
 - [types](types/README.md)
 - [utils/canonical](utils/canonical/README.md)

package/docs/strategy/DelegationStrategy/README.md

@@ -0,0 +1,11 @@
+[**@actioncodes/protocol**](../../README.md)
+
+***
+
+[@actioncodes/protocol](../../modules.md) / strategy/DelegationStrategy
+
+# strategy/DelegationStrategy
+
+## Classes
+
+- [DelegationStrategy](classes/DelegationStrategy.md)

package/docs/strategy/DelegationStrategy/classes/DelegationStrategy.md

@@ -0,0 +1,79 @@
+[**@actioncodes/protocol**](../../../README.md)
+
+***
+
+[@actioncodes/protocol](../../../modules.md) / [strategy/DelegationStrategy](../README.md) / DelegationStrategy
+
+# Class: DelegationStrategy
+
+Defined in: src/strategy/DelegationStrategy.ts:15
+
+## Constructors
+
+### Constructor
+
+> **new DelegationStrategy**(`config`): `DelegationStrategy`
+
+Defined in: src/strategy/DelegationStrategy.ts:19
+
+#### Parameters
+
+##### config
+
+[`CodeGenerationConfig`](../../../types/interfaces/CodeGenerationConfig.md)
+
+#### Returns
+
+`DelegationStrategy`
+
+## Methods
+
+### generateDelegatedCode()
+
+> **generateDelegatedCode**(`delegationProof`, `canonicalMessage`, `chain`, `signature`): [`DelegatedActionCode`](../../../types/interfaces/DelegatedActionCode.md)
+
+Defined in: src/strategy/DelegationStrategy.ts:27
+
+Generate a delegated action code using a delegation proof and signature over message to generate code via delegated keypair
+
+#### Parameters
+
+##### delegationProof
+
+[`DelegationProof`](../../../types/interfaces/DelegationProof.md)
+
+##### canonicalMessage
+
+`Uint8Array`
+
+##### chain
+
+`"solana"`
+
+##### signature
+
+`string`
+
+#### Returns
+
+[`DelegatedActionCode`](../../../types/interfaces/DelegatedActionCode.md)
+
+***
+
+### validateDelegatedCode()
+
+> **validateDelegatedCode**(`actionCode`): `void`
+
+Defined in: src/strategy/DelegationStrategy.ts:56
+
+Validate a delegated action code
+
+#### Parameters
+
+##### actionCode
+
+[`DelegatedActionCode`](../../../types/interfaces/DelegatedActionCode.md)
+
+#### Returns
+
+`void`

package/docs/strategy/WalletStrategy/README.md

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

package/docs/strategy/WalletStrategy/classes/WalletStrategy.md

@@ -1,18 +1,26 @@
-[**@actioncodes/protocol-v2**](../../../README.md)
+[**@actioncodes/protocol**](../../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../../modules.md) / [strategy/WalletStrategy](../README.md) / WalletStrategy
+[@actioncodes/protocol](../../../modules.md) / [strategy/WalletStrategy](../README.md) / WalletStrategy
 
 # Class: WalletStrategy
 
-Defined in: src/strategy/WalletStrategy.ts:11
+Defined in: src/strategy/WalletStrategy.ts:8
 
 ## Constructors
 
 ### Constructor
 
-> **new WalletStrategy**(): `WalletStrategy`
+> **new WalletStrategy**(`config`): `WalletStrategy`
+
+Defined in: src/strategy/WalletStrategy.ts:9
+
+#### Parameters
+
+##### config
+
+[`CodeGenerationConfig`](../../../types/interfaces/CodeGenerationConfig.md)
 
 #### Returns
 
@@ -22,35 +30,35 @@ Defined in: src/strategy/WalletStrategy.ts:11
 
 ### generateCode()
 
-> `static` **generateCode**(`pubkey`, `config`, `providedSecret?`): [`CodeGenerationResult`](../../../types/interfaces/CodeGenerationResult.md)
+> **generateCode**(`canonicalMessage`, `chain`, `signature`): [`ActionCode`](../../../types/interfaces/ActionCode.md)
 
-Defined in: src/strategy/WalletStrategy.ts:12
+Defined in: src/strategy/WalletStrategy.ts:11
 
 #### Parameters
 
-##### pubkey
+##### canonicalMessage
 
-`string`
+`Uint8Array`
 
-##### config
+##### chain
 
-[`CodeGenerationConfig`](../../../types/interfaces/CodeGenerationConfig.md)
+`"solana"`
 
-##### providedSecret?
+##### signature
 
 `string`
 
 #### Returns
 
-[`CodeGenerationResult`](../../../types/interfaces/CodeGenerationResult.md)
+[`ActionCode`](../../../types/interfaces/ActionCode.md)
 
 ***
 
 ### validateCode()
 
-> `static` **validateCode**(`actionCode`, `config`): `void`
+> **validateCode**(`actionCode`): `void`
 
-Defined in: src/strategy/WalletStrategy.ts:48
+Defined in: src/strategy/WalletStrategy.ts:53
 
 #### Parameters
 
@@ -58,10 +66,6 @@ Defined in: src/strategy/WalletStrategy.ts:48
 
 [`ActionCode`](../../../types/interfaces/ActionCode.md)
 
-##### config
-
-[`CodeGenerationConfig`](../../../types/interfaces/CodeGenerationConfig.md)
-
 #### Returns
 
 `void`

package/docs/types/README.md

@@ -1,14 +1,22 @@
-[**@actioncodes/protocol-v2**](../README.md)
+[**@actioncodes/protocol**](../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../modules.md) / types
+[@actioncodes/protocol](../modules.md) / types
 
 # types
 
 ## Interfaces
 
 - [ActionCode](interfaces/ActionCode.md)
+- [ActionCodeRevoke](interfaces/ActionCodeRevoke.md)
 - [CanonicalMessageParts](interfaces/CanonicalMessageParts.md)
+- [CanonicalRevokeMessageParts](interfaces/CanonicalRevokeMessageParts.md)
 - [CodeGenerationConfig](interfaces/CodeGenerationConfig.md)
-- [CodeGenerationResult](interfaces/CodeGenerationResult.md)
+- [DelegatedActionCode](interfaces/DelegatedActionCode.md)
+- [DelegatedActionCodeRevoke](interfaces/DelegatedActionCodeRevoke.md)
+- [DelegationProof](interfaces/DelegationProof.md)
+
+## Type Aliases
+
+- [Chain](type-aliases/Chain.md)