@actioncodes/protocol 1.2.1 → 2.0.0

package/docs/codegen/classes/CodeGenerator.md

@@ -1,341 +0,0 @@
-[**@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/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/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/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/codegen.ts#L6)
-
-***
-
-### MAX\_PREFIX\_LENGTH
-
-> `static` **MAX\_PREFIX\_LENGTH**: `number`
-
-Defined in: [codegen.ts:8](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/codegen.ts#L8)
-
-***
-
-### MIN\_PREFIX\_LENGTH
-
-> `static` **MIN\_PREFIX\_LENGTH**: `number`
-
-Defined in: [codegen.ts:7](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/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/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/codegen.ts#L5)
-
-## Methods
-
-### deriveCodeHash()
-
-> `static` **deriveCodeHash**(`pubkey`, `prefix`, `timestamp?`): `string`
-
-Defined in: [codegen.ts:167](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/codegen.ts#L167)
-
-Derive the full SHA-256 hash for storage or encryption key generation
-
-#### Parameters
-
-##### pubkey
-
-`string`
-
-Solana wallet public key (base58)
-
-##### prefix
-
-`string` = `PROTOCOL_CODE_PREFIX`
-
-Optional namespace prefix (default: PROTOCOL_CODE_PREFIX)
-
-##### timestamp?
-
-`number`
-
-UNIX timestamp in milliseconds (defaults to now)
-
-#### Returns
-
-`string`
-
-Full SHA-256 hash string
-
-***
-
-### generateCode()
-
-> `static` **generateCode**(`pubkey`, `prefix`, `timestamp`): `object`
-
-Defined in: [codegen.ts:123](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/codegen.ts#L123)
-
-Generate a deterministic 8-digit code based on public key, prefix, and timestamp
-
-#### Parameters
-
-##### pubkey
-
-`string`
-
-Solana wallet public key (base58)
-
-##### prefix
-
-`string` = `PROTOCOL_CODE_PREFIX`
-
-Optional namespace prefix (default: PROTOCOL_CODE_PREFIX)
-
-##### 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`
-
-#### Throws
-
-Error if generated code is invalid
-
-***
-
-### getExpectedCode()
-
-> `static` **getExpectedCode**(`pubkey`, `timestamp`, `prefix`): `string`
-
-Defined in: [codegen.ts:186](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/codegen.ts#L186)
-
-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
-
-##### prefix
-
-`string` = `PROTOCOL_CODE_PREFIX`
-
-Optional namespace prefix (default: PROTOCOL_CODE_PREFIX)
-
-#### Returns
-
-`string`
-
-Full code string with prefix + 8 digits
-
-***
-
-### isValidTimestamp()
-
-> `static` **isValidTimestamp**(`timestamp`): `boolean`
-
-Defined in: [codegen.ts:228](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/codegen.ts#L228)
-
-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:107](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/codegen.ts#L107)
-
-Normalize prefix - convert PROTOCOL_CODE_PREFIX 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`, `prefix`): `boolean`
-
-Defined in: [codegen.ts:202](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/codegen.ts#L202)
-
-Validate if a code matches the expected code for a given public key and timestamp
-
-#### Parameters
-
-##### code
-
-`string`
-
-The code to validate (can include prefix)
-
-##### pubkey
-
-`string`
-
-Solana wallet public key (base58)
-
-##### timestamp
-
-`number`
-
-UNIX timestamp in milliseconds
-
-##### prefix
-
-`string` = `PROTOCOL_CODE_PREFIX`
-
-Optional namespace prefix (default: PROTOCOL_CODE_PREFIX)
-
-#### Returns
-
-`boolean`
-
-True if code matches expected code and timestamp is valid
-
-***
-
-### validateCodeDigits()
-
-> `static` **validateCodeDigits**(`code`): `boolean`
-
-Defined in: [codegen.ts:67](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/codegen.ts#L67)
-
-Validate that the numeric part of a code is exactly 8 digits
-
-#### Parameters
-
-##### code
-
-`string`
-
-The code to validate (can include prefix)
-
-#### Returns
-
-`boolean`
-
-True if numeric part is valid, false otherwise
-
-***
-
-### validateCodeFormat()
-
-> `static` **validateCodeFormat**(`code`): `boolean`
-
-Defined in: [codegen.ts:26](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/codegen.ts#L26)
-
-Validate generated code format (prefix + exactly 8 digits)
-
-#### Parameters
-
-##### code
-
-`string`
-
-The code to validate
-
-#### Returns
-
-`boolean`
-
-True if code is valid, false otherwise
-
-***
-
-### validatePrefix()
-
-> `static` **validatePrefix**(`prefix`): `boolean`
-
-Defined in: [codegen.ts:15](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/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/type-aliases/SupportedChain.md

@@ -1,11 +0,0 @@
-[**@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/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/constants.ts#L9)

package/docs/constants/variables/CODE_LENGTH.md

@@ -1,11 +0,0 @@
-[**@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/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/constants.ts#L3)

package/docs/constants/variables/CODE_TTL.md

@@ -1,11 +0,0 @@
-[**@actioncodes/protocol**](../../README.md)
-
-***
-
-[@actioncodes/protocol](../../modules.md) / [constants](../README.md) / CODE\_TTL
-
-# Variable: CODE\_TTL
-
-> `const` **CODE\_TTL**: `number`
-
-Defined in: [constants.ts:4](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/constants.ts#L4)

package/docs/constants/variables/MAX_PREFIX_LENGTH.md

@@ -1,11 +0,0 @@
-[**@actioncodes/protocol**](../../README.md)
-
-***
-
-[@actioncodes/protocol](../../modules.md) / [constants](../README.md) / MAX\_PREFIX\_LENGTH
-
-# Variable: MAX\_PREFIX\_LENGTH
-
-> `const` **MAX\_PREFIX\_LENGTH**: `12` = `12`
-
-Defined in: [constants.ts:7](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/constants.ts#L7)

package/docs/constants/variables/MIN_PREFIX_LENGTH.md

@@ -1,11 +0,0 @@
-[**@actioncodes/protocol**](../../README.md)
-
-***
-
-[@actioncodes/protocol](../../modules.md) / [constants](../README.md) / MIN\_PREFIX\_LENGTH
-
-# Variable: MIN\_PREFIX\_LENGTH
-
-> `const` **MIN\_PREFIX\_LENGTH**: `3` = `3`
-
-Defined in: [constants.ts:6](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/constants.ts#L6)

package/docs/constants/variables/PROTOCOL_CODE_PREFIX.md

@@ -1,11 +0,0 @@
-[**@actioncodes/protocol**](../../README.md)
-
-***
-
-[@actioncodes/protocol](../../modules.md) / [constants](../README.md) / PROTOCOL\_CODE\_PREFIX
-
-# Variable: PROTOCOL\_CODE\_PREFIX
-
-> `const` **PROTOCOL\_CODE\_PREFIX**: `"DEFAULT"` = `"DEFAULT"`
-
-Defined in: [constants.ts:5](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/constants.ts#L5)

package/docs/constants/variables/PROTOCOL_PREFIX.md

@@ -1,11 +0,0 @@
-[**@actioncodes/protocol**](../../README.md)
-
-***
-
-[@actioncodes/protocol](../../modules.md) / [constants](../README.md) / PROTOCOL\_PREFIX
-
-# Variable: PROTOCOL\_PREFIX
-
-> `const` **PROTOCOL\_PREFIX**: `"actioncodes"` = `"actioncodes"`
-
-Defined in: [constants.ts:2](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/constants.ts#L2)

package/docs/constants/variables/PROTOCOL_VERSION.md

@@ -1,11 +0,0 @@
-[**@actioncodes/protocol**](../../README.md)
-
-***
-
-[@actioncodes/protocol](../../modules.md) / [constants](../README.md) / PROTOCOL\_VERSION
-
-# Variable: PROTOCOL\_VERSION
-
-> `const` **PROTOCOL\_VERSION**: `"1"` = `"1"`
-
-Defined in: [constants.ts:1](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/constants.ts#L1)

package/docs/meta/README.md

@@ -1,15 +0,0 @@
-[**@actioncodes/protocol**](../README.md)
-
-***
-
-[@actioncodes/protocol](../modules.md) / meta
-
-# meta
-
-## Classes
-
-- [ProtocolMetaParser](classes/ProtocolMetaParser.md)
-
-## Interfaces
-
-- [ProtocolMetaV1](interfaces/ProtocolMetaV1.md)

package/docs/meta/classes/ProtocolMetaParser.md

@@ -1,177 +0,0 @@
-[**@actioncodes/protocol**](../../README.md)
-
-***
-
-[@actioncodes/protocol](../../modules.md) / [meta](../README.md) / ProtocolMetaParser
-
-# Class: ProtocolMetaParser
-
-Defined in: [meta.ts:19](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/meta.ts#L19)
-
-Protocol meta parser for structured memo/message parsing
-
-## Constructors
-
-### Constructor
-
-> **new ProtocolMetaParser**(): `ProtocolMetaParser`
-
-#### Returns
-
-`ProtocolMetaParser`
-
-## Methods
-
-### fromInitiator()
-
-> `static` **fromInitiator**(`initiator`, `iss`, `prefix`, `params?`, `timestamp?`): [`ProtocolMetaV1`](../interfaces/ProtocolMetaV1.md)
-
-Defined in: [meta.ts:74](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/meta.ts#L74)
-
-Create protocol meta from code and parameters
-
-#### Parameters
-
-##### initiator
-
-`string`
-
-The initiator public key
-
-##### iss
-
-`string`
-
-The issuer (protocol authority)
-
-##### prefix
-
-`string` = `"DEFAULT"`
-
-The prefix (default: "DEFAULT")
-
-##### params?
-
-`string`
-
-Optional parameters
-
-##### timestamp?
-
-`number`
-
-Optional timestamp
-
-#### Returns
-
-[`ProtocolMetaV1`](../interfaces/ProtocolMetaV1.md)
-
-ProtocolMeta object
-
-***
-
-### parse()
-
-> `static` **parse**(`metaString`): `null` \| [`ProtocolMetaV1`](../interfaces/ProtocolMetaV1.md)
-
-Defined in: [meta.ts:27](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/meta.ts#L27)
-
-Parse protocol meta from string
-
-#### Parameters
-
-##### metaString
-
-`string`
-
-The protocol meta string to parse
-
-#### Returns
-
-`null` \| [`ProtocolMetaV1`](../interfaces/ProtocolMetaV1.md)
-
-Parsed ProtocolMeta object or null if invalid
-
-***
-
-### serialize()
-
-> `static` **serialize**(`meta`): `string`
-
-Defined in: [meta.ts:55](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/meta.ts#L55)
-
-Serialize ProtocolMeta to string
-
-#### Parameters
-
-##### meta
-
-[`ProtocolMetaV1`](../interfaces/ProtocolMetaV1.md)
-
-The protocol meta to serialize
-
-#### Returns
-
-`string`
-
-Serialized protocol meta string
-
-***
-
-### validateCode()
-
-> `static` **validateCode**(`meta`, `timestamp?`): `boolean`
-
-Defined in: [meta.ts:99](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/meta.ts#L99)
-
-Validate if a code matches the protocol meta
-
-#### Parameters
-
-##### meta
-
-[`ProtocolMetaV1`](../interfaces/ProtocolMetaV1.md)
-
-The protocol meta to validate against
-
-##### timestamp?
-
-`number`
-
-Optional timestamp for validation (if not provided, uses current time)
-
-#### Returns
-
-`boolean`
-
-True if the meta is valid
-
-***
-
-### validateMetaFromString()
-
-> `static` **validateMetaFromString**(`metaString`, `timestamp?`): `boolean`
-
-Defined in: [meta.ts:110](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/meta.ts#L110)
-
-Validate if a code matches the protocol meta by parsing from string
-
-#### Parameters
-
-##### metaString
-
-`string`
-
-The protocol meta string to validate against
-
-##### timestamp?
-
-`number`
-
-Optional timestamp for validation (if not provided, uses current time)
-
-#### Returns
-
-`boolean`
-
-True if the code matches the meta

package/docs/meta/interfaces/ProtocolMetaV1.md

@@ -1,59 +0,0 @@
-[**@actioncodes/protocol**](../../README.md)
-
-***
-
-[@actioncodes/protocol](../../modules.md) / [meta](../README.md) / ProtocolMetaV1
-
-# Interface: ProtocolMetaV1
-
-Defined in: [meta.ts:7](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/meta.ts#L7)
-
-Protocol meta structure for code verification
-
-## Properties
-
-### id
-
-> **id**: `string`
-
-Defined in: [meta.ts:11](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/meta.ts#L11)
-
-***
-
-### initiator
-
-> **initiator**: `string`
-
-Defined in: [meta.ts:10](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/meta.ts#L10)
-
-***
-
-### iss?
-
-> `optional` **iss**: `string`
-
-Defined in: [meta.ts:12](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/meta.ts#L12)
-
-***
-
-### params?
-
-> `optional` **params**: `string`
-
-Defined in: [meta.ts:13](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/meta.ts#L13)
-
-***
-
-### prefix
-
-> **prefix**: `string`
-
-Defined in: [meta.ts:9](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/meta.ts#L9)
-
-***
-
-### version
-
-> **version**: `string`
-
-Defined in: [meta.ts:8](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/meta.ts#L8)