@actioncodes/protocol 1.0.0

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

@@ -0,0 +1,306 @@
+[**@actioncodes/protocol**](../../../../README.md)
+
+***
+
+[@actioncodes/protocol](../../../../modules.md) / [adapters/solana/solana](../README.md) / SolanaAdapter
+
+# Class: SolanaAdapter
+
+Defined in: [adapters/solana/solana.ts:20](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/adapters/solana/solana.ts#L20)
+
+Simple Solana adapter for protocol meta operations
+Supports both legacy and versioned transactions
+
+## Extends
+
+- [`BaseChainAdapter`](../../../base/classes/BaseChainAdapter.md)\<[`SolanaTransaction`](../type-aliases/SolanaTransaction.md)\>
+
+## Constructors
+
+### Constructor
+
+> **new SolanaAdapter**(): `SolanaAdapter`
+
+#### Returns
+
+`SolanaAdapter`
+
+#### Inherited from
+
+[`BaseChainAdapter`](../../../base/classes/BaseChainAdapter.md).[`constructor`](../../../base/classes/BaseChainAdapter.md#constructor)
+
+## Properties
+
+### chain
+
+> `readonly` **chain**: `"solana"` = `'solana'`
+
+Defined in: [adapters/solana/solana.ts:23](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/adapters/solana/solana.ts#L23)
+
+#### Overrides
+
+[`BaseChainAdapter`](../../../base/classes/BaseChainAdapter.md).[`chain`](../../../base/classes/BaseChainAdapter.md#chain)
+
+## Methods
+
+### decode()
+
+> **decode**(`tx`): `null` \| [`ProtocolMetaV1`](../../../../meta/interfaces/ProtocolMetaV1.md)
+
+Defined in: [adapters/solana/solana.ts:40](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/adapters/solana/solana.ts#L40)
+
+Decode protocol meta from Solana transaction (legacy or versioned)
+
+#### Parameters
+
+##### tx
+
+[`SolanaTransaction`](../type-aliases/SolanaTransaction.md)
+
+The Solana transaction
+
+#### Returns
+
+`null` \| [`ProtocolMetaV1`](../../../../meta/interfaces/ProtocolMetaV1.md)
+
+Decoded ProtocolMetaV1 or null if not found
+
+#### Overrides
+
+[`BaseChainAdapter`](../../../base/classes/BaseChainAdapter.md).[`decode`](../../../base/classes/BaseChainAdapter.md#decode)
+
+***
+
+### decodeFromBase64()
+
+> **decodeFromBase64**(`base64String`): `null` \| [`ProtocolMetaV1`](../../../../meta/interfaces/ProtocolMetaV1.md)
+
+Defined in: [adapters/solana/solana.ts:201](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/adapters/solana/solana.ts#L201)
+
+Decode protocol meta from base64 string (for backward compatibility)
+
+#### Parameters
+
+##### base64String
+
+`string`
+
+Base64 encoded transaction
+
+#### Returns
+
+`null` \| [`ProtocolMetaV1`](../../../../meta/interfaces/ProtocolMetaV1.md)
+
+Decoded ProtocolMetaV1 or null
+
+***
+
+### detectTampering()
+
+> **detectTampering**(`tx`, `authorities`, `expectedPrefix`): `boolean`
+
+Defined in: [adapters/base.ts:48](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/adapters/base.ts#L48)
+
+Detect tampered transactions by cross-checking metadata
+
+#### Parameters
+
+##### tx
+
+[`SolanaTransaction`](../type-aliases/SolanaTransaction.md)
+
+Chain-specific transaction
+
+##### authorities
+
+`string`[]
+
+Array of valid protocol authority identifiers
+
+##### expectedPrefix
+
+`string` = `'DEFAULT'`
+
+Expected protocol prefix
+
+#### Returns
+
+`boolean`
+
+True if transaction is valid and not tampered
+
+#### Inherited from
+
+[`BaseChainAdapter`](../../../base/classes/BaseChainAdapter.md).[`detectTampering`](../../../base/classes/BaseChainAdapter.md#detecttampering)
+
+***
+
+### encode()
+
+> **encode**(`meta`): `TransactionInstruction`
+
+Defined in: [adapters/solana/solana.ts:30](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/adapters/solana/solana.ts#L30)
+
+Encode protocol meta as a Solana memo instruction
+
+#### Parameters
+
+##### meta
+
+[`ProtocolMetaV1`](../../../../meta/interfaces/ProtocolMetaV1.md)
+
+The protocol meta to encode
+
+#### Returns
+
+`TransactionInstruction`
+
+TransactionInstruction for the memo
+
+#### Overrides
+
+[`BaseChainAdapter`](../../../base/classes/BaseChainAdapter.md).[`encode`](../../../base/classes/BaseChainAdapter.md#encode)
+
+***
+
+### hasIssuerSignature()
+
+> **hasIssuerSignature**(`tx`, `issuer`): `boolean`
+
+Defined in: [adapters/solana/solana.ts:68](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/adapters/solana/solana.ts#L68)
+
+Check if the issuer has signed the transaction
+
+#### Parameters
+
+##### tx
+
+[`SolanaTransaction`](../type-aliases/SolanaTransaction.md)
+
+The Solana transaction
+
+##### issuer
+
+`string`
+
+Issuer public key to check
+
+#### Returns
+
+`boolean`
+
+True if issuer has signed
+
+#### Overrides
+
+[`BaseChainAdapter`](../../../base/classes/BaseChainAdapter.md).[`hasIssuerSignature`](../../../base/classes/BaseChainAdapter.md#hasissuersignature)
+
+***
+
+### validate()
+
+> **validate**(`tx`, `authorities`, `expectedPrefix`): `boolean`
+
+Defined in: [adapters/solana/solana.ts:58](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/adapters/solana/solana.ts#L58)
+
+Validate transaction with protocol meta and authority list
+
+#### Parameters
+
+##### tx
+
+[`SolanaTransaction`](../type-aliases/SolanaTransaction.md)
+
+The Solana transaction
+
+##### authorities
+
+`string`[]
+
+Array of valid protocol authority public keys (base58)
+
+##### expectedPrefix
+
+`string` = `'DEFAULT'`
+
+Expected protocol prefix (default: 'DEFAULT')
+
+#### Returns
+
+`boolean`
+
+True if transaction is valid
+
+#### Overrides
+
+[`BaseChainAdapter`](../../../base/classes/BaseChainAdapter.md).[`validate`](../../../base/classes/BaseChainAdapter.md#validate)
+
+***
+
+### validateFromBase64()
+
+> **validateFromBase64**(`base64String`, `authorities`, `expectedPrefix`): `boolean`
+
+Defined in: [adapters/solana/solana.ts:224](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/adapters/solana/solana.ts#L224)
+
+Validate base64 transaction (for backward compatibility)
+
+#### Parameters
+
+##### base64String
+
+`string`
+
+Base64 encoded transaction
+
+##### authorities
+
+`string`[]
+
+Array of valid protocol authority public keys (base58)
+
+##### expectedPrefix
+
+`string` = `'DEFAULT'`
+
+Expected protocol prefix (default: 'DEFAULT')
+
+#### Returns
+
+`boolean`
+
+True if transaction is valid
+
+***
+
+### validateTransactionIntegrity()
+
+> `protected` **validateTransactionIntegrity**(`tx`, `meta`): `boolean`
+
+Defined in: [adapters/solana/solana.ts:175](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/adapters/solana/solana.ts#L175)
+
+Validate Solana transaction integrity with additional checks
+
+#### Parameters
+
+##### tx
+
+[`SolanaTransaction`](../type-aliases/SolanaTransaction.md)
+
+The Solana transaction
+
+##### meta
+
+[`ProtocolMetaV1`](../../../../meta/interfaces/ProtocolMetaV1.md)
+
+Decoded protocol meta
+
+#### Returns
+
+`boolean`
+
+True if transaction integrity is valid
+
+#### Overrides
+
+[`BaseChainAdapter`](../../../base/classes/BaseChainAdapter.md).[`validateTransactionIntegrity`](../../../base/classes/BaseChainAdapter.md#validatetransactionintegrity)

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

@@ -0,0 +1,13 @@
+[**@actioncodes/protocol**](../../../../README.md)
+
+***
+
+[@actioncodes/protocol](../../../../modules.md) / [adapters/solana/solana](../README.md) / SolanaTransaction
+
+# Type Alias: SolanaTransaction
+
+> **SolanaTransaction** = `Transaction` \| `VersionedTransaction`
+
+Defined in: [adapters/solana/solana.ts:14](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/adapters/solana/solana.ts#L14)
+
+Solana transaction type union

package/docs/codegen/README.md

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

package/docs/codegen/classes/CodeGenerator.md

@@ -0,0 +1,337 @@
+[**@actioncodes/protocol**](../../README.md)
+
+***
+
+[@actioncodes/protocol](../../modules.md) / [codegen](../README.md) / CodeGenerator
+
+# Class: CodeGenerator
+
+Defined in: [codegen.ts:4](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/codegen.ts#L4)
+
+## Constructors
+
+### Constructor
+
+> **new CodeGenerator**(): `CodeGenerator`
+
+#### Returns
+
+`CodeGenerator`
+
+## Properties
+
+### CODE\_DIGITS
+
+> `static` **CODE\_DIGITS**: `number` = `CODE_LENGTH`
+
+Defined in: [codegen.ts:6](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/codegen.ts#L6)
+
+***
+
+### MAX\_PREFIX\_LENGTH
+
+> `static` **MAX\_PREFIX\_LENGTH**: `number`
+
+Defined in: [codegen.ts:8](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/codegen.ts#L8)
+
+***
+
+### MIN\_PREFIX\_LENGTH
+
+> `static` **MIN\_PREFIX\_LENGTH**: `number`
+
+Defined in: [codegen.ts:7](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/codegen.ts#L7)
+
+***
+
+### TIME\_WINDOW\_MS
+
+> `static` **TIME\_WINDOW\_MS**: `number` = `CODE_TTL`
+
+Defined in: [codegen.ts:5](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/codegen.ts#L5)
+
+## Methods
+
+### deriveCodeHash()
+
+> `static` **deriveCodeHash**(`pubkey`, `prefix`, `timestamp?`): `string`
+
+Defined in: [codegen.ts:74](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/codegen.ts#L74)
+
+Derive the full SHA-256 hash for storage or encryption key generation
+
+#### Parameters
+
+##### pubkey
+
+`string`
+
+Solana wallet public key (base58)
+
+##### prefix
+
+`string` = `"DEFAULT"`
+
+Optional namespace prefix (default: "DEFAULT")
+
+##### timestamp?
+
+`number`
+
+UNIX timestamp in milliseconds (defaults to now)
+
+#### Returns
+
+`string`
+
+Full SHA-256 hash string
+
+***
+
+### generateCode()
+
+> `static` **generateCode**(`pubkey`, `signature`, `prefix`, `timestamp`): `object`
+
+Defined in: [codegen.ts:43](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/codegen.ts#L43)
+
+Generate a deterministic 8-digit code based on public key, prefix, and timestamp
+
+#### Parameters
+
+##### pubkey
+
+`string`
+
+Solana wallet public key (base58)
+
+##### signature
+
+`string`
+
+User's signature string
+
+##### prefix
+
+`string` = `"DEFAULT"`
+
+Optional namespace prefix (default: "DEFAULT")
+
+##### timestamp
+
+`number` = `...`
+
+UNIX timestamp in milliseconds (defaults to now)
+
+#### Returns
+
+`object`
+
+Object containing code, issuedAt, and expiresAt timestamps
+
+##### code
+
+> **code**: `string`
+
+##### expiresAt
+
+> **expiresAt**: `number`
+
+##### issuedAt
+
+> **issuedAt**: `number`
+
+***
+
+### generateCodeSignatureMessage()
+
+> `static` **generateCodeSignatureMessage**(`code`, `timestamp`): `string`
+
+Defined in: [codegen.ts:92](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/codegen.ts#L92)
+
+Generate the message that should be signed for code verification
+
+#### Parameters
+
+##### code
+
+`string`
+
+The generated 8-digit code
+
+##### timestamp
+
+`number`
+
+UNIX timestamp in milliseconds
+
+#### Returns
+
+`string`
+
+Message string in format "actioncodes:<code>:<timestamp>"
+
+***
+
+### getExpectedCode()
+
+> `static` **getExpectedCode**(`pubkey`, `timestamp`, `signature`, `prefix`): `string`
+
+Defined in: [codegen.ts:104](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/codegen.ts#L104)
+
+Get the expected code for a given public key and timestamp
+
+#### Parameters
+
+##### pubkey
+
+`string`
+
+Solana wallet public key (base58)
+
+##### timestamp
+
+`number`
+
+UNIX timestamp in milliseconds
+
+##### signature
+
+`string`
+
+User's signature string
+
+##### prefix
+
+`string` = `"DEFAULT"`
+
+Optional namespace prefix (default: "DEFAULT")
+
+#### Returns
+
+`string`
+
+8-digit numeric string
+
+***
+
+### isValidTimestamp()
+
+> `static` **isValidTimestamp**(`timestamp`): `boolean`
+
+Defined in: [codegen.ts:140](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/codegen.ts#L140)
+
+Check if a timestamp falls within a valid time window
+
+#### Parameters
+
+##### timestamp
+
+`number`
+
+UNIX timestamp in milliseconds
+
+#### Returns
+
+`boolean`
+
+True if timestamp is valid
+
+***
+
+### normalizePrefix()
+
+> `static` **normalizePrefix**(`prefix`): `string`
+
+Defined in: [codegen.ts:27](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/codegen.ts#L27)
+
+Normalize prefix - convert "DEFAULT" to empty string, validate others
+
+#### Parameters
+
+##### prefix
+
+`string`
+
+The prefix to normalize
+
+#### Returns
+
+`string`
+
+Normalized prefix
+
+#### Throws
+
+Error if prefix is invalid
+
+***
+
+### validateCode()
+
+> `static` **validateCode**(`code`, `pubkey`, `timestamp`, `signature`, `prefix`): `boolean`
+
+Defined in: [codegen.ts:122](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/codegen.ts#L122)
+
+Validate if a code matches the expected code for a given public key and timestamp
+
+#### Parameters
+
+##### code
+
+`string`
+
+The code to validate
+
+##### pubkey
+
+`string`
+
+Solana wallet public key (base58)
+
+##### timestamp
+
+`number`
+
+UNIX timestamp in milliseconds
+
+##### signature
+
+`string`
+
+User's signature string
+
+##### prefix
+
+`string` = `"DEFAULT"`
+
+Optional namespace prefix (default: "DEFAULT")
+
+#### Returns
+
+`boolean`
+
+True if code matches expected code and timestamp is valid
+
+***
+
+### validatePrefix()
+
+> `static` **validatePrefix**(`prefix`): `boolean`
+
+Defined in: [codegen.ts:15](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/codegen.ts#L15)
+
+Validate prefix format
+
+#### Parameters
+
+##### prefix
+
+`string`
+
+The prefix to validate
+
+#### Returns
+
+`boolean`
+
+True if prefix is valid, false otherwise

package/docs/constants/README.md

@@ -0,0 +1,22 @@
+[**@actioncodes/protocol**](../README.md)
+
+***
+
+[@actioncodes/protocol](../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)
+- [SUPPORTED\_CHAINS](variables/SUPPORTED_CHAINS.md)

package/docs/constants/type-aliases/SupportedChain.md

@@ -0,0 +1,11 @@
+[**@actioncodes/protocol**](../../README.md)
+
+***
+
+[@actioncodes/protocol](../../modules.md) / [constants](../README.md) / SupportedChain
+
+# Type Alias: SupportedChain
+
+> **SupportedChain** = *typeof* [`SUPPORTED_CHAINS`](../variables/SUPPORTED_CHAINS.md)\[`number`\]
+
+Defined in: [constants.ts:9](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/constants.ts#L9)

package/docs/constants/variables/CODE_LENGTH.md

@@ -0,0 +1,11 @@
+[**@actioncodes/protocol**](../../README.md)
+
+***
+
+[@actioncodes/protocol](../../modules.md) / [constants](../README.md) / CODE\_LENGTH
+
+# Variable: CODE\_LENGTH
+
+> `const` **CODE\_LENGTH**: `8` = `8`
+
+Defined in: [constants.ts:3](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/constants.ts#L3)