@actioncodes/protocol 1.0.0

package/docs/protocol/classes/ActionCodesProtocol.md

@@ -0,0 +1,616 @@
+[**@actioncodes/protocol**](../../README.md)
+
+***
+
+[@actioncodes/protocol](../../modules.md) / [protocol](../README.md) / ActionCodesProtocol
+
+# Class: ActionCodesProtocol
+
+Defined in: [protocol.ts:31](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L31)
+
+OTA Protocol - Main entry point for the One-Time Action Code Protocol
+
+Provides a unified interface for generating, validating, and managing
+action codes across multiple blockchain networks.
+
+## Constructors
+
+### Constructor
+
+> **new ActionCodesProtocol**(`config?`): `ActionCodesProtocol`
+
+Defined in: [protocol.ts:35](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L35)
+
+#### Parameters
+
+##### config?
+
+`Partial`\<[`ProtocolConfig`](../interfaces/ProtocolConfig.md)\>
+
+#### Returns
+
+`ActionCodesProtocol`
+
+## Methods
+
+### attachTransaction()
+
+> **attachTransaction**(`actionCode`, `transaction`, `txType?`): [`ActionCode`](../../actioncode/classes/ActionCode.md)\<`string`\>
+
+Defined in: [protocol.ts:155](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L155)
+
+Attach a transaction to an action code
+
+#### Parameters
+
+##### actionCode
+
+[`ActionCode`](../../actioncode/classes/ActionCode.md)\<`string`\>
+
+ActionCode to attach transaction to
+
+##### transaction
+
+`string`
+
+Chain-specific transaction data
+
+##### txType?
+
+`string`
+
+Optional transaction type
+
+#### Returns
+
+[`ActionCode`](../../actioncode/classes/ActionCode.md)\<`string`\>
+
+Updated ActionCode
+
+***
+
+### createProtocolMeta()
+
+> **createProtocolMeta**(`actionCode`, `issuer?`, `params?`): [`ProtocolMetaV1`](../../meta/interfaces/ProtocolMetaV1.md)
+
+Defined in: [protocol.ts:220](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L220)
+
+Create protocol meta for a transaction
+
+#### Parameters
+
+##### actionCode
+
+[`ActionCode`](../../actioncode/classes/ActionCode.md)\<`string`\>
+
+ActionCode to create meta for
+
+##### issuer?
+
+`string`
+
+Optional issuer public key
+
+##### params?
+
+`string`
+
+Optional parameters
+
+#### Returns
+
+[`ProtocolMetaV1`](../../meta/interfaces/ProtocolMetaV1.md)
+
+ProtocolMetaV1 object
+
+***
+
+### decodeProtocolMeta()
+
+> **decodeProtocolMeta**(`transaction`, `chain`): `null` \| [`ProtocolMetaV1`](../../meta/interfaces/ProtocolMetaV1.md)
+
+Defined in: [protocol.ts:254](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L254)
+
+Decode protocol meta from a transaction
+
+#### Parameters
+
+##### transaction
+
+`any`
+
+Chain-specific transaction
+
+##### chain
+
+`string`
+
+Source chain
+
+#### Returns
+
+`null` \| [`ProtocolMetaV1`](../../meta/interfaces/ProtocolMetaV1.md)
+
+Decoded ProtocolMetaV1 or null
+
+***
+
+### decodeProtocolMetaTyped()
+
+> **decodeProtocolMetaTyped**\<`T`\>(`transaction`, `chain`): `null` \| [`ProtocolMetaV1`](../../meta/interfaces/ProtocolMetaV1.md)
+
+Defined in: [protocol.ts:335](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L335)
+
+Decode protocol meta with type safety
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### transaction
+
+`T`
+
+Chain-specific transaction
+
+##### chain
+
+`string`
+
+Source chain
+
+#### Returns
+
+`null` \| [`ProtocolMetaV1`](../../meta/interfaces/ProtocolMetaV1.md)
+
+Decoded ProtocolMetaV1 or null
+
+***
+
+### detectTampering()
+
+> **detectTampering**\<`T`\>(`transaction`, `chain`, `authorities`, `expectedPrefix?`): `boolean`
+
+Defined in: [protocol.ts:315](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L315)
+
+Detect tampered transactions with type safety
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### transaction
+
+`T`
+
+Chain-specific transaction
+
+##### chain
+
+`string`
+
+Source chain
+
+##### authorities
+
+`string`[]
+
+Array of valid protocol authority identifiers
+
+##### expectedPrefix?
+
+`string`
+
+Expected protocol prefix
+
+#### Returns
+
+`boolean`
+
+True if transaction is valid and not tampered
+
+***
+
+### encodeProtocolMeta()
+
+> **encodeProtocolMeta**(`meta`, `chain`): `any`
+
+Defined in: [protocol.ts:239](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L239)
+
+Encode protocol meta for a specific chain
+
+#### Parameters
+
+##### meta
+
+[`ProtocolMetaV1`](../../meta/interfaces/ProtocolMetaV1.md)
+
+ProtocolMetaV1 object
+
+##### chain
+
+`string`
+
+Target chain
+
+#### Returns
+
+`any`
+
+Chain-specific encoded meta
+
+***
+
+### finalizeActionCode()
+
+> **finalizeActionCode**(`actionCode`, `txSignature`): [`ActionCode`](../../actioncode/classes/ActionCode.md)\<`string`\>
+
+Defined in: [protocol.ts:188](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L188)
+
+Finalize an action code with transaction signature
+
+#### Parameters
+
+##### actionCode
+
+[`ActionCode`](../../actioncode/classes/ActionCode.md)\<`string`\>
+
+ActionCode to finalize
+
+##### txSignature
+
+`string`
+
+Transaction signature
+
+#### Returns
+
+[`ActionCode`](../../actioncode/classes/ActionCode.md)\<`string`\>
+
+Updated ActionCode
+
+***
+
+### generateActionCode()
+
+> **generateActionCode**(`pubkey`, `signature`, `chain`, `prefix?`, `timestamp?`): [`ActionCode`](../../actioncode/classes/ActionCode.md)\<`string`\>
+
+Defined in: [protocol.ts:90](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L90)
+
+Generate an action code for a specific chain
+
+#### Parameters
+
+##### pubkey
+
+`string`
+
+User's public key
+
+##### signature
+
+`string`
+
+User's signature
+
+##### chain
+
+`"solana"`
+
+Target chain
+
+##### prefix?
+
+`string`
+
+Optional prefix (defaults to config defaultPrefix)
+
+##### timestamp?
+
+`number`
+
+Optional timestamp (defaults to now)
+
+#### Returns
+
+[`ActionCode`](../../actioncode/classes/ActionCode.md)\<`string`\>
+
+ActionCode object
+
+***
+
+### getChainAdapter()
+
+> **getChainAdapter**\<`T`\>(`chain`): `undefined` \| [`BaseChainAdapter`](../../adapters/base/classes/BaseChainAdapter.md)\<`T`\>
+
+Defined in: [protocol.ts:77](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L77)
+
+Get chain adapter with proper typing
+
+#### Type Parameters
+
+##### T
+
+`T` = `any`
+
+#### Parameters
+
+##### chain
+
+`string`
+
+Chain identifier
+
+#### Returns
+
+`undefined` \| [`BaseChainAdapter`](../../adapters/base/classes/BaseChainAdapter.md)\<`T`\>
+
+Chain adapter or undefined
+
+***
+
+### getConfig()
+
+> **getConfig**(): [`ProtocolConfig`](../interfaces/ProtocolConfig.md)
+
+Defined in: [protocol.ts:348](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L348)
+
+Get protocol configuration
+
+#### Returns
+
+[`ProtocolConfig`](../interfaces/ProtocolConfig.md)
+
+Current protocol configuration
+
+***
+
+### getRegisteredChains()
+
+> **getRegisteredChains**(): `string`[]
+
+Defined in: [protocol.ts:59](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L59)
+
+Get registered chain adapters
+
+#### Returns
+
+`string`[]
+
+Array of registered chain identifiers
+
+***
+
+### isChainSupported()
+
+> **isChainSupported**(`chain`): `boolean`
+
+Defined in: [protocol.ts:68](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L68)
+
+Check if a chain is supported
+
+#### Parameters
+
+##### chain
+
+`string`
+
+Chain identifier
+
+#### Returns
+
+`boolean`
+
+True if chain is supported
+
+***
+
+### registerAdapter()
+
+> **registerAdapter**\<`T`\>(`adapter`): `void`
+
+Defined in: [protocol.ts:51](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L51)
+
+Register a chain adapter
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### adapter
+
+[`BaseChainAdapter`](../../adapters/base/classes/BaseChainAdapter.md)\<`T`\>
+
+Chain adapter implementation
+
+#### Returns
+
+`void`
+
+***
+
+### updateConfig()
+
+> **updateConfig**(`updates`): `void`
+
+Defined in: [protocol.ts:356](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L356)
+
+Update protocol configuration
+
+#### Parameters
+
+##### updates
+
+`Partial`\<[`ProtocolConfig`](../interfaces/ProtocolConfig.md)\>
+
+Configuration updates
+
+#### Returns
+
+`void`
+
+***
+
+### validateActionCode()
+
+> **validateActionCode**(`actionCode`): `boolean`
+
+Defined in: [protocol.ts:132](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L132)
+
+Validate an action code
+
+#### Parameters
+
+##### actionCode
+
+[`ActionCode`](../../actioncode/classes/ActionCode.md)\<`string`\>
+
+ActionCode to validate
+
+#### Returns
+
+`boolean`
+
+True if valid
+
+***
+
+### validateTransaction()
+
+> **validateTransaction**(`transaction`, `chain`, `authorities`, `expectedPrefix?`): `boolean`
+
+Defined in: [protocol.ts:271](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L271)
+
+Validate a transaction with protocol meta
+
+#### Parameters
+
+##### transaction
+
+`any`
+
+Chain-specific transaction
+
+##### chain
+
+`string`
+
+Source chain
+
+##### authorities
+
+`string`[]
+
+Array of valid protocol authority identifiers
+
+##### expectedPrefix?
+
+`string`
+
+Expected protocol prefix
+
+#### Returns
+
+`boolean`
+
+True if transaction is valid
+
+***
+
+### validateTransactionTyped()
+
+> **validateTransactionTyped**\<`T`\>(`transaction`, `chain`, `authorities`, `expectedPrefix?`): `boolean`
+
+Defined in: [protocol.ts:293](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L293)
+
+Type-safe transaction validation for specific chains
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### transaction
+
+`T`
+
+Chain-specific transaction
+
+##### chain
+
+`string`
+
+Source chain
+
+##### authorities
+
+`string`[]
+
+Array of valid protocol authority identifiers
+
+##### expectedPrefix?
+
+`string`
+
+Expected protocol prefix
+
+#### Returns
+
+`boolean`
+
+True if transaction is valid
+
+***
+
+### create()
+
+> `static` **create**(): `ActionCodesProtocol`
+
+Defined in: [protocol.ts:364](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L364)
+
+Create a new protocol instance with default configuration
+
+#### Returns
+
+`ActionCodesProtocol`
+
+New protocol instance
+
+***
+
+### createWithConfig()
+
+> `static` **createWithConfig**(`config`): `ActionCodesProtocol`
+
+Defined in: [protocol.ts:373](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L373)
+
+Create a new protocol instance with custom configuration
+
+#### Parameters
+
+##### config
+
+`Partial`\<[`ProtocolConfig`](../interfaces/ProtocolConfig.md)\>
+
+Custom configuration
+
+#### Returns
+
+`ActionCodesProtocol`
+
+New protocol instance

package/docs/protocol/interfaces/ProtocolConfig.md

@@ -0,0 +1,71 @@
+[**@actioncodes/protocol**](../../README.md)
+
+***
+
+[@actioncodes/protocol](../../modules.md) / [protocol](../README.md) / ProtocolConfig
+
+# Interface: ProtocolConfig
+
+Defined in: [protocol.ts:10](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L10)
+
+OTA Protocol Configuration
+
+## Properties
+
+### codeLength
+
+> **codeLength**: `number`
+
+Defined in: [protocol.ts:18](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L18)
+
+Code length in digits
+
+***
+
+### codeTTL
+
+> **codeTTL**: `number`
+
+Defined in: [protocol.ts:16](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L16)
+
+Code TTL in milliseconds
+
+***
+
+### defaultPrefix
+
+> **defaultPrefix**: `string`
+
+Defined in: [protocol.ts:14](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L14)
+
+Default prefix for action codes
+
+***
+
+### maxPrefixLength
+
+> **maxPrefixLength**: `number`
+
+Defined in: [protocol.ts:20](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L20)
+
+Maximum prefix length
+
+***
+
+### minPrefixLength
+
+> **minPrefixLength**: `number`
+
+Defined in: [protocol.ts:22](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L22)
+
+Minimum prefix length
+
+***
+
+### version
+
+> **version**: `string`
+
+Defined in: [protocol.ts:12](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/protocol.ts#L12)
+
+Protocol version