@actioncodes/protocol 1.2.2 → 2.0.1

package/docs/README.md

@@ -1,59 +1,19 @@
-**@actioncodes/protocol**
+**@actioncodes/protocol-v2**
 
 ***
 
-# 🛡️ Action Codes Protocol
+# protocol-v2
 
-![Coverage](https://img.shields.io/badge/coverage-98%-brightgreen)
-
-**Action Codes Protocol** enables short-lived, cryptographically verifiable action codes that authorize blockchain transactions and intents without requiring live wallet sessions.
-
-This repository contains the canonical specifications, SDK modules, and chain adapter interfaces that implement the Action Codes Protocol.
-
----
-
-## ✨ Key Features
-
-- 🔐 **Deterministic Code Generation**  
-  Users can generate time-limited codes directly in their wallet or client, without external servers.
-
-- ✅ **Signature-Based Verification**  
-  Codes are signed by the wallet, and transactions must be signed by protocol-authorized relayers.
-
-- 🧩 **Meta-Based Intent Encoding**  
-  Each transaction carries an encoded `meta` string for verifiable context across chains.
-
-- 🧱 **Chain-Agnostic Design**  
-  Works on Solana today; built for future EVM, Cosmos, and more.
-
-- 🌐 **Prefix Namespace System**  
-  Enables ecosystem-wide namespacing (e.g. `JUP`, `ME`) for branded intents and UIs.
-
----
-
-## 📦 Repository Structure
+To install dependencies:
 
+```bash
+bun install
 ```
-/src         - SDK modules (codegen, meta, validator, blockchain adapters)
-/specs       - Formal specifications (AIPs)
-README.md    - You are here
-LICENSE      - Apache 2.0
-```
-
----
 
-## 📄 Specifications
+To run:
 
-[Protocol Specifications](_media/README.md)
-
-- [`AIP-0`](./specs/aip-0.md): Action Codes Protocol Architecture
-- [`AIP-1`](./specs/aip-1.md): Protocol Meta Format
-- [`AIP-2`](./specs/aip-2.md): Authority Signature Validation
-- [`AIP-3`](./specs/aip-3.md): Intent Resolution & Routing
-- [`AIP-4`](./specs/aip-4.md): Prefix System
-
----
-
-## 📜 License
+```bash
+bun run index.ts
+```
 
-This protocol is open source under the [Apache 2.0 License](_media/LICENSE).
+This project was created using `bun init` in bun v1.2.22. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.

package/docs/adapters/BaseChainAdapter/README.md

@@ -0,0 +1,20 @@
+[**@actioncodes/protocol-v2**](../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../modules.md) / adapters/BaseChainAdapter
+
+# adapters/BaseChainAdapter
+
+## Classes
+
+- [BaseChainAdapter](classes/BaseChainAdapter.md)
+
+## Interfaces
+
+- [BaseContext](interfaces/BaseContext.md)
+- [ChainAdapter](interfaces/ChainAdapter.md)
+
+## Type Aliases
+
+- [ChainContext](type-aliases/ChainContext.md)

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

@@ -0,0 +1,56 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [adapters/BaseChainAdapter](../README.md) / BaseChainAdapter
+
+# Abstract Class: BaseChainAdapter\<TCtx\>
+
+Defined in: src/adapters/BaseChainAdapter.ts:14
+
+## Extended by
+
+- [`NodeCryptoAdapter`](../../NodeCryptoAdapter/classes/NodeCryptoAdapter.md)
+- [`SolanaAdapter`](../../SolanaAdapter/classes/SolanaAdapter.md)
+
+## Type Parameters
+
+### TCtx
+
+`TCtx`
+
+## Implements
+
+- [`ChainAdapter`](../interfaces/ChainAdapter.md)\<`TCtx`\>
+
+## Constructors
+
+### Constructor
+
+> **new BaseChainAdapter**\<`TCtx`\>(): `BaseChainAdapter`\<`TCtx`\>
+
+#### Returns
+
+`BaseChainAdapter`\<`TCtx`\>
+
+## Methods
+
+### verify()
+
+> `abstract` **verify**(`context`): `boolean`
+
+Defined in: src/adapters/BaseChainAdapter.ts:15
+
+#### Parameters
+
+##### context
+
+[`ChainContext`](../type-aliases/ChainContext.md)\<`TCtx`\>
+
+#### Returns
+
+`boolean`
+
+#### Implementation of
+
+[`ChainAdapter`](../interfaces/ChainAdapter.md).[`verify`](../interfaces/ChainAdapter.md#verify)

package/docs/adapters/BaseChainAdapter/interfaces/BaseContext.md

@@ -0,0 +1,17 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [adapters/BaseChainAdapter](../README.md) / BaseContext
+
+# Interface: BaseContext
+
+Defined in: src/adapters/BaseChainAdapter.ts:4
+
+## Properties
+
+### canonicalMessageParts
+
+> **canonicalMessageParts**: [`CanonicalMessageParts`](../../../types/interfaces/CanonicalMessageParts.md)
+
+Defined in: src/adapters/BaseChainAdapter.ts:6

package/docs/adapters/BaseChainAdapter/interfaces/ChainAdapter.md

@@ -0,0 +1,33 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [adapters/BaseChainAdapter](../README.md) / ChainAdapter
+
+# Interface: ChainAdapter\<TCtx\>
+
+Defined in: src/adapters/BaseChainAdapter.ts:10
+
+## Type Parameters
+
+### TCtx
+
+`TCtx` = `unknown`
+
+## Methods
+
+### verify()
+
+> **verify**(`context`): `boolean`
+
+Defined in: src/adapters/BaseChainAdapter.ts:11
+
+#### Parameters
+
+##### context
+
+[`ChainContext`](../type-aliases/ChainContext.md)\<`TCtx`\>
+
+#### Returns
+
+`boolean`

package/docs/adapters/BaseChainAdapter/type-aliases/ChainContext.md

@@ -0,0 +1,23 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [adapters/BaseChainAdapter](../README.md) / ChainContext
+
+# Type Alias: ChainContext\<T\>
+
+> **ChainContext**\<`T`\> = [`BaseContext`](../interfaces/BaseContext.md) & `object` & `T`
+
+Defined in: src/adapters/BaseChainAdapter.ts:8
+
+## Type Declaration
+
+### chain
+
+> **chain**: `string`
+
+## Type Parameters
+
+### T
+
+`T`

package/docs/adapters/NodeCryptoAdapter/README.md

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

package/docs/adapters/NodeCryptoAdapter/classes/NodeCryptoAdapter.md

@@ -0,0 +1,254 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [adapters/NodeCryptoAdapter](../README.md) / NodeCryptoAdapter
+
+# Class: NodeCryptoAdapter
+
+Defined in: src/adapters/NodeCryptoAdapter.ts:20
+
+## Extends
+
+- [`BaseChainAdapter`](../../BaseChainAdapter/classes/BaseChainAdapter.md)\<[`NodeCryptoContext`](../type-aliases/NodeCryptoContext.md)\>
+
+## Constructors
+
+### Constructor
+
+> **new NodeCryptoAdapter**(): `NodeCryptoAdapter`
+
+#### Returns
+
+`NodeCryptoAdapter`
+
+#### Inherited from
+
+[`BaseChainAdapter`](../../BaseChainAdapter/classes/BaseChainAdapter.md).[`constructor`](../../BaseChainAdapter/classes/BaseChainAdapter.md#constructor)
+
+## Methods
+
+### getProtocolMeta()
+
+> **getProtocolMeta**(`tx`): `null` \| `string`
+
+Defined in: src/adapters/NodeCryptoAdapter.ts:57
+
+Extract protocol metadata from a simulated transaction
+
+#### Parameters
+
+##### tx
+
+###### instructions?
+
+`object`[]
+
+#### Returns
+
+`null` \| `string`
+
+***
+
+### parseMeta()
+
+> **parseMeta**(`tx`): `null` \| [`ProtocolMetaFields`](../../../utils/protocolMeta/interfaces/ProtocolMetaFields.md)
+
+Defined in: src/adapters/NodeCryptoAdapter.ts:74
+
+Get parsed ProtocolMeta object, or null if none or invalid
+
+#### Parameters
+
+##### tx
+
+###### instructions?
+
+`object`[]
+
+#### Returns
+
+`null` \| [`ProtocolMetaFields`](../../../utils/protocolMeta/interfaces/ProtocolMetaFields.md)
+
+***
+
+### verify()
+
+> **verify**(`context`): `boolean`
+
+Defined in: src/adapters/NodeCryptoAdapter.ts:22
+
+Verify the signature over canonical message using Node.js crypto
+
+#### Parameters
+
+##### context
+
+[`ChainContext`](../../BaseChainAdapter/type-aliases/ChainContext.md)\<[`NodeCryptoContext`](../type-aliases/NodeCryptoContext.md)\>
+
+#### Returns
+
+`boolean`
+
+#### Overrides
+
+[`BaseChainAdapter`](../../BaseChainAdapter/classes/BaseChainAdapter.md).[`verify`](../../BaseChainAdapter/classes/BaseChainAdapter.md#verify)
+
+***
+
+### verifyTransactionMatchesCode()
+
+> **verifyTransactionMatchesCode**(`actionCode`, `tx`): `void`
+
+Defined in: src/adapters/NodeCryptoAdapter.ts:84
+
+Validate that a transaction's meta aligns with the bound `actionCode`.
+Throws ProtocolError if validation fails.
+
+#### Parameters
+
+##### actionCode
+
+[`ActionCode`](../../../types/interfaces/ActionCode.md)
+
+##### tx
+
+###### instructions?
+
+`object`[]
+
+#### Returns
+
+`void`
+
+***
+
+### verifyTransactionSignedByIntentOwner()
+
+> **verifyTransactionSignedByIntentOwner**(`tx`): `void`
+
+Defined in: src/adapters/NodeCryptoAdapter.ts:125
+
+Verify that the transaction is signed by the "intendedFor" pubkey
+as declared in the protocol meta of the transaction.
+Throws ProtocolError if validation fails.
+
+#### Parameters
+
+##### tx
+
+###### instructions?
+
+`object`[]
+
+###### signatures?
+
+`object`[]
+
+#### Returns
+
+`void`
+
+***
+
+### attachProtocolMeta()
+
+> `static` **attachProtocolMeta**(`tx`, `meta`): `object`
+
+Defined in: src/adapters/NodeCryptoAdapter.ts:159
+
+Attach protocol meta to a simulated transaction.
+
+#### Parameters
+
+##### tx
+
+###### instructions?
+
+`object`[]
+
+##### meta
+
+[`ProtocolMetaFields`](../../../utils/protocolMeta/interfaces/ProtocolMetaFields.md)
+
+#### Returns
+
+`object`
+
+##### instructions
+
+> **instructions**: `object`[]
+
+***
+
+### createProtocolMetaInstruction()
+
+> `static` **createProtocolMetaInstruction**(`meta`): `object`
+
+Defined in: src/adapters/NodeCryptoAdapter.ts:46
+
+Create a protocol meta instruction for NodeCrypto (simulated)
+
+#### Parameters
+
+##### meta
+
+[`ProtocolMetaFields`](../../../utils/protocolMeta/interfaces/ProtocolMetaFields.md)
+
+#### Returns
+
+`object`
+
+##### data
+
+> **data**: `string`
+
+##### type
+
+> **type**: `string`
+
+***
+
+### generateKeyPair()
+
+> `static` **generateKeyPair**(): `object`
+
+Defined in: src/adapters/NodeCryptoAdapter.ts:185
+
+Generate a key pair for testing
+
+#### Returns
+
+`object`
+
+##### privateKey
+
+> **privateKey**: `KeyObject`
+
+##### publicKey
+
+> **publicKey**: `KeyObject`
+
+***
+
+### signMessage()
+
+> `static` **signMessage**(`message`, `privateKey`): `string`
+
+Defined in: src/adapters/NodeCryptoAdapter.ts:173
+
+Sign a message with a private key
+
+#### Parameters
+
+##### message
+
+`Uint8Array`
+
+##### privateKey
+
+`KeyObject`
+
+#### Returns
+
+`string`

package/docs/adapters/NodeCryptoAdapter/type-aliases/NodeCryptoContext.md

@@ -0,0 +1,27 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [adapters/NodeCryptoAdapter](../README.md) / NodeCryptoContext
+
+# Type Alias: NodeCryptoContext
+
+> **NodeCryptoContext** = `object`
+
+Defined in: src/adapters/NodeCryptoAdapter.ts:15
+
+## Properties
+
+### pubkey
+
+> **pubkey**: `string`
+
+Defined in: src/adapters/NodeCryptoAdapter.ts:16
+
+***
+
+### signature
+
+> **signature**: `string`
+
+Defined in: src/adapters/NodeCryptoAdapter.ts:17

package/docs/adapters/SolanaAdapter/README.md

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