@actioncodes/protocol 1.2.2 → 2.0.0

package/docs/errors/enumerations/ProtocolErrorCode.md

@@ -0,0 +1,121 @@
+[**@actioncodes/protocol-v2**](../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../modules.md) / [errors](../README.md) / ProtocolErrorCode
+
+# Enumeration: ProtocolErrorCode
+
+Defined in: src/errors.ts:1
+
+## Enumeration Members
+
+### CRYPTO\_ERROR
+
+> **CRYPTO\_ERROR**: `"CRYPTO_ERROR"`
+
+Defined in: src/errors.ts:23
+
+***
+
+### EXPIRED\_CODE
+
+> **EXPIRED\_CODE**: `"EXPIRED_CODE"`
+
+Defined in: src/errors.ts:3
+
+***
+
+### INVALID\_CODE\_FORMAT
+
+> **INVALID\_CODE\_FORMAT**: `"INVALID_CODE_FORMAT"`
+
+Defined in: src/errors.ts:4
+
+***
+
+### INVALID\_DIGEST
+
+> **INVALID\_DIGEST**: `"INVALID_DIGEST"`
+
+Defined in: src/errors.ts:24
+
+***
+
+### INVALID\_INPUT
+
+> **INVALID\_INPUT**: `"INVALID_INPUT"`
+
+Defined in: src/errors.ts:19
+
+***
+
+### INVALID\_META\_FORMAT
+
+> **INVALID\_META\_FORMAT**: `"INVALID_META_FORMAT"`
+
+Defined in: src/errors.ts:9
+
+***
+
+### INVALID\_PUBKEY\_FORMAT
+
+> **INVALID\_PUBKEY\_FORMAT**: `"INVALID_PUBKEY_FORMAT"`
+
+Defined in: src/errors.ts:16
+
+***
+
+### INVALID\_SIGNATURE
+
+> **INVALID\_SIGNATURE**: `"INVALID_SIGNATURE"`
+
+Defined in: src/errors.ts:5
+
+***
+
+### INVALID\_TRANSACTION\_FORMAT
+
+> **INVALID\_TRANSACTION\_FORMAT**: `"INVALID_TRANSACTION_FORMAT"`
+
+Defined in: src/errors.ts:15
+
+***
+
+### META\_MISMATCH
+
+> **META\_MISMATCH**: `"META_MISMATCH"`
+
+Defined in: src/errors.ts:10
+
+***
+
+### META\_TOO\_LARGE
+
+> **META\_TOO\_LARGE**: `"META_TOO_LARGE"`
+
+Defined in: src/errors.ts:11
+
+***
+
+### MISSING\_META
+
+> **MISSING\_META**: `"MISSING_META"`
+
+Defined in: src/errors.ts:8
+
+***
+
+### MISSING\_REQUIRED\_FIELD
+
+> **MISSING\_REQUIRED\_FIELD**: `"MISSING_REQUIRED_FIELD"`
+
+Defined in: src/errors.ts:20
+
+***
+
+### TRANSACTION\_NOT\_SIGNED\_BY\_INTENDED\_OWNER
+
+> **TRANSACTION\_NOT\_SIGNED\_BY\_INTENDED\_OWNER**: `"TRANSACTION_NOT_SIGNED_BY_INTENDED_OWNER"`
+
+Defined in: src/errors.ts:14

package/docs/index/README.md

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol**](../README.md)
+[**@actioncodes/protocol-v2**](../README.md)
 
 ***
 
-[@actioncodes/protocol](../modules.md) / index
+[@actioncodes/protocol-v2](../modules.md) / index
 
 # index
 
@@ -10,121 +10,157 @@
 
 ### ActionCode
 
-Re-exports [ActionCode](../actioncode/classes/ActionCode.md)
+Re-exports [ActionCode](../types/interfaces/ActionCode.md)
 
 ***
 
-### ActionCodeFields
+### ActionCodesProtocol
 
-Re-exports [ActionCodeFields](../actioncode/interfaces/ActionCodeFields.md)
+Re-exports [ActionCodesProtocol](../ActionCodesProtocol/classes/ActionCodesProtocol.md)
 
 ***
 
-### ActionCodeMetadata
+### base32EncodeCrockford
 
-Re-exports [ActionCodeMetadata](../actioncode/interfaces/ActionCodeMetadata.md)
+Re-exports [base32EncodeCrockford](../utils/crypto/functions/base32EncodeCrockford.md)
 
 ***
 
-### ActionCodesProtocol
+### BaseChainAdapter
 
-Re-exports [ActionCodesProtocol](../protocol/classes/ActionCodesProtocol.md)
+Re-exports [BaseChainAdapter](../adapters/BaseChainAdapter/classes/BaseChainAdapter.md)
 
 ***
 
-### ActionCodeStatus
+### CANONICAL\_MESSAGE\_PREFIX
 
-Re-exports [ActionCodeStatus](../actioncode/type-aliases/ActionCodeStatus.md)
+Re-exports [CANONICAL_MESSAGE_PREFIX](../utils/canonical/variables/CANONICAL_MESSAGE_PREFIX.md)
 
 ***
 
-### ActionCodeTransaction
+### CANONICAL\_MESSAGE\_VERSION
 
-Re-exports [ActionCodeTransaction](../actioncode/interfaces/ActionCodeTransaction.md)
+Re-exports [CANONICAL_MESSAGE_VERSION](../utils/canonical/variables/CANONICAL_MESSAGE_VERSION.md)
 
 ***
 
-### BaseChainAdapter
+### CanonicalMessageParts
+
+Re-exports [CanonicalMessageParts](../types/interfaces/CanonicalMessageParts.md)
+
+***
+
+### ChainContext
+
+Re-exports [ChainContext](../adapters/BaseChainAdapter/type-aliases/ChainContext.md)
+
+***
+
+### CODE\_CHARSET\_DIGITS
+
+Re-exports [CODE_CHARSET_DIGITS](../constants/variables/CODE_CHARSET_DIGITS.md)
+
+***
+
+### CODE\_DEFAULT\_LENGTH
 
-Re-exports [BaseChainAdapter](../adapters/base/classes/BaseChainAdapter.md)
+Re-exports [CODE_DEFAULT_LENGTH](../constants/variables/CODE_DEFAULT_LENGTH.md)
 
 ***
 
-### CODE\_LENGTH
+### CODE\_MAX\_LENGTH
 
-Re-exports [CODE_LENGTH](../constants/variables/CODE_LENGTH.md)
+Re-exports [CODE_MAX_LENGTH](../constants/variables/CODE_MAX_LENGTH.md)
 
 ***
 
-### CODE\_TTL
+### CODE\_MIN\_LENGTH
 
-Re-exports [CODE_TTL](../constants/variables/CODE_TTL.md)
+Re-exports [CODE_MIN_LENGTH](../constants/variables/CODE_MIN_LENGTH.md)
 
 ***
 
-### CodeGenerator
+### CodeGenerationConfig
 
-Re-exports [CodeGenerator](../codegen/classes/CodeGenerator.md)
+Re-exports [CodeGenerationConfig](../types/interfaces/CodeGenerationConfig.md)
 
 ***
 
-### MAX\_PREFIX\_LENGTH
+### CodeGenerationResult
 
-Re-exports [MAX_PREFIX_LENGTH](../constants/variables/MAX_PREFIX_LENGTH.md)
+Re-exports [CodeGenerationResult](../types/interfaces/CodeGenerationResult.md)
 
 ***
 
-### MIN\_PREFIX\_LENGTH
+### codeHash
 
-Re-exports [MIN_PREFIX_LENGTH](../constants/variables/MIN_PREFIX_LENGTH.md)
+Re-exports [codeHash](../utils/crypto/functions/codeHash.md)
 
 ***
 
-### PROTOCOL\_CODE\_PREFIX
+### digestToDigits
 
-Re-exports [PROTOCOL_CODE_PREFIX](../constants/variables/PROTOCOL_CODE_PREFIX.md)
+Re-exports [digestToDigits](../utils/crypto/functions/digestToDigits.md)
 
 ***
 
-### PROTOCOL\_PREFIX
+### generateRandomSecret
 
-Re-exports [PROTOCOL_PREFIX](../constants/variables/PROTOCOL_PREFIX.md)
+Re-exports [generateRandomSecret](../utils/crypto/functions/generateRandomSecret.md)
 
 ***
 
-### PROTOCOL\_VERSION
+### hkdfSha256
 
-Re-exports [PROTOCOL_VERSION](../constants/variables/PROTOCOL_VERSION.md)
+Re-exports [hkdfSha256](../utils/crypto/functions/hkdfSha256.md)
 
 ***
 
-### ProtocolConfig
+### hmacSha256
 
-Re-exports [ProtocolConfig](../protocol/interfaces/ProtocolConfig.md)
+Re-exports [hmacSha256](../utils/crypto/functions/hmacSha256.md)
 
 ***
 
-### ProtocolMetaParser
+### PROTOCOL\_META\_MAX\_BYTES
 
-Re-exports [ProtocolMetaParser](../meta/classes/ProtocolMetaParser.md)
+Re-exports [PROTOCOL_META_MAX_BYTES](../constants/variables/PROTOCOL_META_MAX_BYTES.md)
 
 ***
 
-### ProtocolMetaV1
+### PROTOCOL\_NORMALIZATION
 
-Re-exports [ProtocolMetaV1](../meta/interfaces/ProtocolMetaV1.md)
+Re-exports [PROTOCOL_NORMALIZATION](../constants/variables/PROTOCOL_NORMALIZATION.md)
+
+***
+
+### serializeCanonical
+
+Re-exports [serializeCanonical](../utils/canonical/functions/serializeCanonical.md)
+
+***
+
+### sha256
+
+Re-exports [sha256](../utils/crypto/functions/sha256.md)
 
 ***
 
 ### SolanaAdapter
 
-Re-exports [SolanaAdapter](../adapters/solana/solana/classes/SolanaAdapter.md)
+Re-exports [SolanaAdapter](../adapters/SolanaAdapter/classes/SolanaAdapter.md)
+
+***
+
+### SolanaContext
+
+Re-exports [SolanaContext](../adapters/SolanaAdapter/type-aliases/SolanaContext.md)
 
 ***
 
 ### SolanaTransaction
 
-Re-exports [SolanaTransaction](../adapters/solana/solana/type-aliases/SolanaTransaction.md)
+Re-exports [SolanaTransaction](../adapters/SolanaAdapter/type-aliases/SolanaTransaction.md)
 
 ***
 
@@ -134,6 +170,12 @@ Re-exports [SUPPORTED_CHAINS](../constants/variables/SUPPORTED_CHAINS.md)
 
 ***
 
-### SupportedChain
+### truncateBits
+
+Re-exports [truncateBits](../utils/crypto/functions/truncateBits.md)
+
+***
+
+### WalletStrategy
 
-Re-exports [SupportedChain](../constants/type-aliases/SupportedChain.md)
+Re-exports [WalletStrategy](../strategy/WalletStrategy/classes/WalletStrategy.md)

package/docs/modules.md

@@ -1,17 +1,20 @@
-[**@actioncodes/protocol**](README.md)
+[**@actioncodes/protocol-v2**](README.md)
 
 ***
 
-# @actioncodes/protocol
+# @actioncodes/protocol-v2
 
 ## Modules
 
-- [actioncode](actioncode/README.md)
-- [adapters/base](adapters/base/README.md)
-- [adapters/solana](adapters/solana/README.md)
-- [adapters/solana/solana](adapters/solana/solana/README.md)
-- [codegen](codegen/README.md)
+- [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)
-- [meta](meta/README.md)
-- [protocol](protocol/README.md)
+- [strategy/WalletStrategy](strategy/WalletStrategy/README.md)
+- [types](types/README.md)
+- [utils/canonical](utils/canonical/README.md)
+- [utils/crypto](utils/crypto/README.md)
+- [utils/protocolMeta](utils/protocolMeta/README.md)

package/docs/strategy/WalletStrategy/README.md

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

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

@@ -0,0 +1,67 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [strategy/WalletStrategy](../README.md) / WalletStrategy
+
+# Class: WalletStrategy
+
+Defined in: src/strategy/WalletStrategy.ts:11
+
+## Constructors
+
+### Constructor
+
+> **new WalletStrategy**(): `WalletStrategy`
+
+#### Returns
+
+`WalletStrategy`
+
+## Methods
+
+### generateCode()
+
+> `static` **generateCode**(`pubkey`, `config`, `providedSecret?`): [`CodeGenerationResult`](../../../types/interfaces/CodeGenerationResult.md)
+
+Defined in: src/strategy/WalletStrategy.ts:12
+
+#### Parameters
+
+##### pubkey
+
+`string`
+
+##### config
+
+[`CodeGenerationConfig`](../../../types/interfaces/CodeGenerationConfig.md)
+
+##### providedSecret?
+
+`string`
+
+#### Returns
+
+[`CodeGenerationResult`](../../../types/interfaces/CodeGenerationResult.md)
+
+***
+
+### validateCode()
+
+> `static` **validateCode**(`actionCode`, `config`): `void`
+
+Defined in: src/strategy/WalletStrategy.ts:48
+
+#### Parameters
+
+##### actionCode
+
+[`ActionCode`](../../../types/interfaces/ActionCode.md)
+
+##### config
+
+[`CodeGenerationConfig`](../../../types/interfaces/CodeGenerationConfig.md)
+
+#### Returns
+
+`void`

package/docs/types/README.md

@@ -0,0 +1,14 @@
+[**@actioncodes/protocol-v2**](../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../modules.md) / types
+
+# types
+
+## Interfaces
+
+- [ActionCode](interfaces/ActionCode.md)
+- [CanonicalMessageParts](interfaces/CanonicalMessageParts.md)
+- [CodeGenerationConfig](interfaces/CodeGenerationConfig.md)
+- [CodeGenerationResult](interfaces/CodeGenerationResult.md)

package/docs/types/interfaces/ActionCode.md

@@ -0,0 +1,65 @@
+[**@actioncodes/protocol-v2**](../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../modules.md) / [types](../README.md) / ActionCode
+
+# Interface: ActionCode
+
+Defined in: src/types.ts:1
+
+## Properties
+
+### code
+
+> **code**: `string`
+
+Defined in: src/types.ts:2
+
+***
+
+### expiresAt
+
+> **expiresAt**: `number`
+
+Defined in: src/types.ts:5
+
+***
+
+### pubkey
+
+> **pubkey**: `string`
+
+Defined in: src/types.ts:3
+
+***
+
+### secret?
+
+> `optional` **secret**: `string`
+
+Defined in: src/types.ts:9
+
+***
+
+### secretHint?
+
+> `optional` **secretHint**: `string`
+
+Defined in: src/types.ts:7
+
+***
+
+### signature?
+
+> `optional` **signature**: `string`
+
+Defined in: src/types.ts:6
+
+***
+
+### timestamp
+
+> **timestamp**: `number`
+
+Defined in: src/types.ts:4

package/docs/types/interfaces/CanonicalMessageParts.md

@@ -0,0 +1,33 @@
+[**@actioncodes/protocol-v2**](../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../modules.md) / [types](../README.md) / CanonicalMessageParts
+
+# Interface: CanonicalMessageParts
+
+Defined in: src/types.ts:12
+
+## Properties
+
+### pubkey
+
+> **pubkey**: `string`
+
+Defined in: src/types.ts:13
+
+***
+
+### secret?
+
+> `optional` **secret**: `string`
+
+Defined in: src/types.ts:16
+
+***
+
+### windowStart
+
+> **windowStart**: `number`
+
+Defined in: src/types.ts:14

package/docs/types/interfaces/CodeGenerationConfig.md

@@ -0,0 +1,33 @@
+[**@actioncodes/protocol-v2**](../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../modules.md) / [types](../README.md) / CodeGenerationConfig
+
+# Interface: CodeGenerationConfig
+
+Defined in: src/types.ts:19
+
+## Properties
+
+### clockSkewMs?
+
+> `optional` **clockSkewMs**: `number`
+
+Defined in: src/types.ts:22
+
+***
+
+### codeLength
+
+> **codeLength**: `number`
+
+Defined in: src/types.ts:20
+
+***
+
+### ttlMs
+
+> **ttlMs**: `number`
+
+Defined in: src/types.ts:21

package/docs/types/interfaces/CodeGenerationResult.md

@@ -0,0 +1,25 @@
+[**@actioncodes/protocol-v2**](../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../modules.md) / [types](../README.md) / CodeGenerationResult
+
+# Interface: CodeGenerationResult
+
+Defined in: src/types.ts:25
+
+## Properties
+
+### actionCode
+
+> **actionCode**: [`ActionCode`](ActionCode.md)
+
+Defined in: src/types.ts:26
+
+***
+
+### canonicalMessage
+
+> **canonicalMessage**: `Uint8Array`
+
+Defined in: src/types.ts:27

package/docs/utils/canonical/README.md

@@ -0,0 +1,16 @@
+[**@actioncodes/protocol-v2**](../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../modules.md) / utils/canonical
+
+# utils/canonical
+
+## Variables
+
+- [CANONICAL\_MESSAGE\_PREFIX](variables/CANONICAL_MESSAGE_PREFIX.md)
+- [CANONICAL\_MESSAGE\_VERSION](variables/CANONICAL_MESSAGE_VERSION.md)
+
+## Functions
+
+- [serializeCanonical](functions/serializeCanonical.md)

package/docs/utils/canonical/functions/serializeCanonical.md

@@ -0,0 +1,21 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [utils/canonical](../README.md) / serializeCanonical
+
+# Function: serializeCanonical()
+
+> **serializeCanonical**(`parts`): `Uint8Array`
+
+Defined in: src/utils/canonical.ts:6
+
+## Parameters
+
+### parts
+
+[`CanonicalMessageParts`](../../../types/interfaces/CanonicalMessageParts.md)
+
+## Returns
+
+`Uint8Array`

package/docs/utils/canonical/variables/CANONICAL_MESSAGE_PREFIX.md

@@ -0,0 +1,11 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [utils/canonical](../README.md) / CANONICAL\_MESSAGE\_PREFIX
+
+# Variable: CANONICAL\_MESSAGE\_PREFIX
+
+> `const` **CANONICAL\_MESSAGE\_PREFIX**: `"actioncodes"` = `"actioncodes"`
+
+Defined in: src/utils/canonical.ts:4

package/docs/utils/canonical/variables/CANONICAL_MESSAGE_VERSION.md

@@ -0,0 +1,11 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [utils/canonical](../README.md) / CANONICAL\_MESSAGE\_VERSION
+
+# Variable: CANONICAL\_MESSAGE\_VERSION
+
+> `const` **CANONICAL\_MESSAGE\_VERSION**: `1` = `1`
+
+Defined in: src/utils/canonical.ts:3