@actioncodes/protocol 1.0.0

package/docs/actioncode/interfaces/ActionCodeFields.md

@@ -0,0 +1,95 @@
+[**@actioncodes/protocol**](../../README.md)
+
+***
+
+[@actioncodes/protocol](../../modules.md) / [actioncode](../README.md) / ActionCodeFields
+
+# Interface: ActionCodeFields\<T\>
+
+Defined in: [actioncode.ts:17](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L17)
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Properties
+
+### chain
+
+> **chain**: `"solana"`
+
+Defined in: [actioncode.ts:23](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L23)
+
+***
+
+### code
+
+> **code**: `string`
+
+Defined in: [actioncode.ts:18](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L18)
+
+***
+
+### expiresAt
+
+> **expiresAt**: `number`
+
+Defined in: [actioncode.ts:26](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L26)
+
+***
+
+### metadata?
+
+> `optional` **metadata**: [`ActionCodeMetadata`](ActionCodeMetadata.md)
+
+Defined in: [actioncode.ts:25](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L25)
+
+***
+
+### prefix
+
+> **prefix**: `string`
+
+Defined in: [actioncode.ts:19](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L19)
+
+***
+
+### pubkey
+
+> **pubkey**: `string`
+
+Defined in: [actioncode.ts:20](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L20)
+
+***
+
+### signature
+
+> **signature**: `string`
+
+Defined in: [actioncode.ts:22](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L22)
+
+***
+
+### status
+
+> **status**: [`ActionCodeStatus`](../type-aliases/ActionCodeStatus.md)
+
+Defined in: [actioncode.ts:27](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L27)
+
+***
+
+### timestamp
+
+> **timestamp**: `number`
+
+Defined in: [actioncode.ts:21](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L21)
+
+***
+
+### transaction?
+
+> `optional` **transaction**: [`ActionCodeTransaction`](ActionCodeTransaction.md)\<`T`\>
+
+Defined in: [actioncode.ts:24](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L24)

package/docs/actioncode/interfaces/ActionCodeMetadata.md

@@ -0,0 +1,25 @@
+[**@actioncodes/protocol**](../../README.md)
+
+***
+
+[@actioncodes/protocol](../../modules.md) / [actioncode](../README.md) / ActionCodeMetadata
+
+# Interface: ActionCodeMetadata
+
+Defined in: [actioncode.ts:6](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L6)
+
+## Properties
+
+### description?
+
+> `optional` **description**: `string`
+
+Defined in: [actioncode.ts:7](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L7)
+
+***
+
+### params?
+
+> `optional` **params**: `Record`\<`string`, `any`\>
+
+Defined in: [actioncode.ts:8](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L8)

package/docs/actioncode/interfaces/ActionCodeTransaction.md

@@ -0,0 +1,39 @@
+[**@actioncodes/protocol**](../../README.md)
+
+***
+
+[@actioncodes/protocol](../../modules.md) / [actioncode](../README.md) / ActionCodeTransaction
+
+# Interface: ActionCodeTransaction\<T\>
+
+Defined in: [actioncode.ts:11](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L11)
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Properties
+
+### transaction?
+
+> `optional` **transaction**: `T`
+
+Defined in: [actioncode.ts:12](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L12)
+
+***
+
+### txSignature?
+
+> `optional` **txSignature**: `string`
+
+Defined in: [actioncode.ts:13](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L13)
+
+***
+
+### txType?
+
+> `optional` **txType**: `string`
+
+Defined in: [actioncode.ts:14](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L14)

package/docs/actioncode/type-aliases/ActionCodeStatus.md

@@ -0,0 +1,11 @@
+[**@actioncodes/protocol**](../../README.md)
+
+***
+
+[@actioncodes/protocol](../../modules.md) / [actioncode](../README.md) / ActionCodeStatus
+
+# Type Alias: ActionCodeStatus
+
+> **ActionCodeStatus** = `"pending"` \| `"resolved"` \| `"finalized"` \| `"expired"` \| `"error"`
+
+Defined in: [actioncode.ts:4](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L4)

package/docs/adapters/base/README.md

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

package/docs/adapters/base/classes/BaseChainAdapter.md

@@ -0,0 +1,222 @@
+[**@actioncodes/protocol**](../../../README.md)
+
+***
+
+[@actioncodes/protocol](../../../modules.md) / [adapters/base](../README.md) / BaseChainAdapter
+
+# Class: `abstract` BaseChainAdapter\<T\>
+
+Defined in: [adapters/base.ts:7](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/adapters/base.ts#L7)
+
+Base adapter class for chain-specific protocol meta operations
+
+## Extended by
+
+- [`SolanaAdapter`](../../solana/solana/classes/SolanaAdapter.md)
+
+## Type Parameters
+
+### T
+
+`T` = `any`
+
+Chain-specific transaction type
+
+## Constructors
+
+### Constructor
+
+> **new BaseChainAdapter**\<`T`\>(): `BaseChainAdapter`\<`T`\>
+
+#### Returns
+
+`BaseChainAdapter`\<`T`\>
+
+## Properties
+
+### chain
+
+> `abstract` `readonly` **chain**: `string`
+
+Defined in: [adapters/base.ts:8](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/adapters/base.ts#L8)
+
+## Methods
+
+### decode()
+
+> `abstract` **decode**(`tx`): `null` \| [`ProtocolMetaV1`](../../../meta/interfaces/ProtocolMetaV1.md)
+
+Defined in: [adapters/base.ts:22](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/adapters/base.ts#L22)
+
+Decode protocol meta from chain-specific transaction
+
+#### Parameters
+
+##### tx
+
+`T`
+
+Chain-specific 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
+
+`T`
+
+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
+
+***
+
+### encode()
+
+> `abstract` **encode**(`meta`): `any`
+
+Defined in: [adapters/base.ts:15](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/adapters/base.ts#L15)
+
+Encode protocol meta for this chain
+
+#### Parameters
+
+##### meta
+
+[`ProtocolMetaV1`](../../../meta/interfaces/ProtocolMetaV1.md)
+
+ProtocolMetaV1 object
+
+#### Returns
+
+`any`
+
+Chain-specific encoded data
+
+***
+
+### hasIssuerSignature()
+
+> `abstract` **hasIssuerSignature**(`tx`, `issuer`): `boolean`
+
+Defined in: [adapters/base.ts:39](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/adapters/base.ts#L39)
+
+Check if the issuer has signed the transaction
+
+#### Parameters
+
+##### tx
+
+`T`
+
+Chain-specific transaction
+
+##### issuer
+
+`string`
+
+Issuer public key to check
+
+#### Returns
+
+`boolean`
+
+True if issuer has signed
+
+***
+
+### validate()
+
+> `abstract` **validate**(`tx`, `authorities`, `expectedPrefix?`): `boolean`
+
+Defined in: [adapters/base.ts:31](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/adapters/base.ts#L31)
+
+Validate transaction with protocol meta and authority list
+
+#### Parameters
+
+##### tx
+
+`T`
+
+Chain-specific transaction
+
+##### authorities
+
+`string`[]
+
+Array of valid protocol authority identifiers
+
+##### expectedPrefix?
+
+`string`
+
+Expected protocol prefix (default: 'DEFAULT')
+
+#### Returns
+
+`boolean`
+
+True if transaction is valid
+
+***
+
+### validateTransactionIntegrity()
+
+> `abstract` `protected` **validateTransactionIntegrity**(`tx`, `meta`): `boolean`
+
+Defined in: [adapters/base.ts:85](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/adapters/base.ts#L85)
+
+Chain-specific transaction integrity validation
+Override this method for additional validation logic
+
+#### Parameters
+
+##### tx
+
+`T`
+
+Chain-specific transaction
+
+##### meta
+
+[`ProtocolMetaV1`](../../../meta/interfaces/ProtocolMetaV1.md)
+
+Decoded protocol meta
+
+#### Returns
+
+`boolean`
+
+True if transaction integrity is valid

package/docs/adapters/solana/README.md

@@ -0,0 +1,19 @@
+[**@actioncodes/protocol**](../../README.md)
+
+***
+
+[@actioncodes/protocol](../../modules.md) / adapters/solana
+
+# adapters/solana
+
+## References
+
+### SolanaAdapter
+
+Re-exports [SolanaAdapter](solana/classes/SolanaAdapter.md)
+
+***
+
+### SolanaTransaction
+
+Re-exports [SolanaTransaction](solana/type-aliases/SolanaTransaction.md)

package/docs/adapters/solana/solana/README.md

@@ -0,0 +1,15 @@
+[**@actioncodes/protocol**](../../../README.md)
+
+***
+
+[@actioncodes/protocol](../../../modules.md) / adapters/solana/solana
+
+# adapters/solana/solana
+
+## Classes
+
+- [SolanaAdapter](classes/SolanaAdapter.md)
+
+## Type Aliases
+
+- [SolanaTransaction](type-aliases/SolanaTransaction.md)