@actioncodes/protocol 1.0.0

package/docs/constants/variables/CODE_TTL.md

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

package/docs/constants/variables/MAX_PREFIX_LENGTH.md

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

package/docs/constants/variables/MIN_PREFIX_LENGTH.md

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

package/docs/constants/variables/PROTOCOL_CODE_PREFIX.md

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

package/docs/constants/variables/PROTOCOL_PREFIX.md

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

package/docs/constants/variables/PROTOCOL_VERSION.md

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

package/docs/constants/variables/SUPPORTED_CHAINS.md

@@ -0,0 +1,11 @@
+[**@actioncodes/protocol**](../../README.md)
+
+***
+
+[@actioncodes/protocol](../../modules.md) / [constants](../README.md) / SUPPORTED\_CHAINS
+
+# Variable: SUPPORTED\_CHAINS
+
+> `const` **SUPPORTED\_CHAINS**: readonly \[`"solana"`\]
+
+Defined in: [constants.ts:8](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/constants.ts#L8)

package/docs/index/README.md

@@ -0,0 +1,139 @@
+[**@actioncodes/protocol**](../README.md)
+
+***
+
+[@actioncodes/protocol](../modules.md) / index
+
+# index
+
+## References
+
+### ActionCode
+
+Re-exports [ActionCode](../actioncode/classes/ActionCode.md)
+
+***
+
+### ActionCodeFields
+
+Re-exports [ActionCodeFields](../actioncode/interfaces/ActionCodeFields.md)
+
+***
+
+### ActionCodeMetadata
+
+Re-exports [ActionCodeMetadata](../actioncode/interfaces/ActionCodeMetadata.md)
+
+***
+
+### ActionCodesProtocol
+
+Re-exports [ActionCodesProtocol](../protocol/classes/ActionCodesProtocol.md)
+
+***
+
+### ActionCodeStatus
+
+Re-exports [ActionCodeStatus](../actioncode/type-aliases/ActionCodeStatus.md)
+
+***
+
+### ActionCodeTransaction
+
+Re-exports [ActionCodeTransaction](../actioncode/interfaces/ActionCodeTransaction.md)
+
+***
+
+### BaseChainAdapter
+
+Re-exports [BaseChainAdapter](../adapters/base/classes/BaseChainAdapter.md)
+
+***
+
+### CODE\_LENGTH
+
+Re-exports [CODE_LENGTH](../constants/variables/CODE_LENGTH.md)
+
+***
+
+### CODE\_TTL
+
+Re-exports [CODE_TTL](../constants/variables/CODE_TTL.md)
+
+***
+
+### CodeGenerator
+
+Re-exports [CodeGenerator](../codegen/classes/CodeGenerator.md)
+
+***
+
+### MAX\_PREFIX\_LENGTH
+
+Re-exports [MAX_PREFIX_LENGTH](../constants/variables/MAX_PREFIX_LENGTH.md)
+
+***
+
+### MIN\_PREFIX\_LENGTH
+
+Re-exports [MIN_PREFIX_LENGTH](../constants/variables/MIN_PREFIX_LENGTH.md)
+
+***
+
+### PROTOCOL\_CODE\_PREFIX
+
+Re-exports [PROTOCOL_CODE_PREFIX](../constants/variables/PROTOCOL_CODE_PREFIX.md)
+
+***
+
+### PROTOCOL\_PREFIX
+
+Re-exports [PROTOCOL_PREFIX](../constants/variables/PROTOCOL_PREFIX.md)
+
+***
+
+### PROTOCOL\_VERSION
+
+Re-exports [PROTOCOL_VERSION](../constants/variables/PROTOCOL_VERSION.md)
+
+***
+
+### ProtocolConfig
+
+Re-exports [ProtocolConfig](../protocol/interfaces/ProtocolConfig.md)
+
+***
+
+### ProtocolMetaParser
+
+Re-exports [ProtocolMetaParser](../meta/classes/ProtocolMetaParser.md)
+
+***
+
+### ProtocolMetaV1
+
+Re-exports [ProtocolMetaV1](../meta/interfaces/ProtocolMetaV1.md)
+
+***
+
+### SolanaAdapter
+
+Re-exports [SolanaAdapter](../adapters/solana/solana/classes/SolanaAdapter.md)
+
+***
+
+### SolanaTransaction
+
+Re-exports [SolanaTransaction](../adapters/solana/solana/type-aliases/SolanaTransaction.md)
+
+***
+
+### SUPPORTED\_CHAINS
+
+Re-exports [SUPPORTED_CHAINS](../constants/variables/SUPPORTED_CHAINS.md)
+
+***
+
+### SupportedChain
+
+Re-exports [SupportedChain](../constants/type-aliases/SupportedChain.md)

package/docs/meta/README.md

@@ -0,0 +1,15 @@
+[**@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

@@ -0,0 +1,177 @@
+[**@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/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/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/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/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/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/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/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/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/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/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/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/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

@@ -0,0 +1,59 @@
+[**@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/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/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/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/meta.ts#L11)
+
+***
+
+### initiator
+
+> **initiator**: `string`
+
+Defined in: [meta.ts:10](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/meta.ts#L10)
+
+***
+
+### iss?
+
+> `optional` **iss**: `string`
+
+Defined in: [meta.ts:12](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/meta.ts#L12)
+
+***
+
+### params?
+
+> `optional` **params**: `string`
+
+Defined in: [meta.ts:13](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/meta.ts#L13)
+
+***
+
+### prefix
+
+> **prefix**: `string`
+
+Defined in: [meta.ts:9](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/meta.ts#L9)
+
+***
+
+### version
+
+> **version**: `string`
+
+Defined in: [meta.ts:8](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/meta.ts#L8)

package/docs/modules.md

@@ -0,0 +1,17 @@
+[**@actioncodes/protocol**](README.md)
+
+***
+
+# @actioncodes/protocol
+
+## 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)
+- [constants](constants/README.md)
+- [index](index/README.md)
+- [meta](meta/README.md)
+- [protocol](protocol/README.md)

package/docs/protocol/README.md

@@ -0,0 +1,51 @@
+[**@actioncodes/protocol**](../README.md)
+
+***
+
+[@actioncodes/protocol](../modules.md) / protocol
+
+# protocol
+
+## Classes
+
+- [ActionCodesProtocol](classes/ActionCodesProtocol.md)
+
+## Interfaces
+
+- [ProtocolConfig](interfaces/ProtocolConfig.md)
+
+## References
+
+### ActionCode
+
+Re-exports [ActionCode](../actioncode/classes/ActionCode.md)
+
+***
+
+### ActionCodeStatus
+
+Re-exports [ActionCodeStatus](../actioncode/type-aliases/ActionCodeStatus.md)
+
+***
+
+### ActionCodeTransaction
+
+Re-exports [ActionCodeTransaction](../actioncode/interfaces/ActionCodeTransaction.md)
+
+***
+
+### ProtocolMetaV1
+
+Re-exports [ProtocolMetaV1](../meta/interfaces/ProtocolMetaV1.md)
+
+***
+
+### SUPPORTED\_CHAINS
+
+Re-exports [SUPPORTED_CHAINS](../constants/variables/SUPPORTED_CHAINS.md)
+
+***
+
+### SupportedChain
+
+Re-exports [SupportedChain](../constants/type-aliases/SupportedChain.md)