@actioncodes/protocol 1.0.0

package/dist/meta.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProtocolMetaParser = void 0;
+const codegen_1 = require("./codegen");
+const constants_1 = require("./constants");
+/**
+ * Protocol meta parser for structured memo/message parsing
+ */
+class ProtocolMetaParser {
+    /**
+     * Parse protocol meta from string
+     * @param metaString - The protocol meta string to parse
+     * @returns Parsed ProtocolMeta object or null if invalid
+     */
+    static parse(metaString) {
+        const match = metaString.match(this.PROTOCOL_REGEX);
+        if (!match) {
+            return null;
+        }
+        const [, protocolPrefix, version, prefix, initiator, id, iss, params] = match;
+        // Validate protocol prefix
+        if (protocolPrefix !== constants_1.PROTOCOL_PREFIX) {
+            return null;
+        }
+        return {
+            version,
+            prefix,
+            initiator,
+            id,
+            iss,
+            params: params || undefined
+        };
+    }
+    /**
+     * Serialize ProtocolMeta to string
+     * @param meta - The protocol meta to serialize
+     * @returns Serialized protocol meta string
+     */
+    static serialize(meta) {
+        let result = `${constants_1.PROTOCOL_PREFIX}:v=${meta.version}&pre=${meta.prefix}&ini=${meta.initiator}&id=${meta.id}&iss=${meta.iss}`;
+        if (meta.params) {
+            result += `&p=${meta.params}`;
+        }
+        return result;
+    }
+    /**
+     * Create protocol meta from code and parameters
+     * @param initiator - The initiator public key
+     * @param iss - The issuer (protocol authority)
+     * @param prefix - The prefix (default: "DEFAULT")
+     * @param params - Optional parameters
+     * @param timestamp - Optional timestamp
+     * @returns ProtocolMeta object
+     */
+    static fromInitiator(initiator, iss, prefix = "DEFAULT", params, timestamp) {
+        const codeHash = codegen_1.CodeGenerator.deriveCodeHash(initiator, prefix, timestamp);
+        return {
+            version: constants_1.PROTOCOL_VERSION,
+            prefix,
+            initiator,
+            id: codeHash,
+            iss,
+            params
+        };
+    }
+    /**
+     * Validate if a code matches the protocol meta
+     * @param meta - The protocol meta to validate against
+     * @param timestamp - Optional timestamp for validation (if not provided, uses current time)
+     * @returns True if the meta is valid
+     */
+    static validateCode(meta, timestamp) {
+        const expectedHash = codegen_1.CodeGenerator.deriveCodeHash(meta.initiator, meta.prefix, timestamp);
+        return meta.id === expectedHash;
+    }
+    /**
+     * Validate if a code matches the protocol meta by parsing from string
+     * @param metaString - The protocol meta string to validate against
+     * @param timestamp - Optional timestamp for validation (if not provided, uses current time)
+     * @returns True if the code matches the meta
+     */
+    static validateMetaFromString(metaString, timestamp) {
+        const meta = this.parse(metaString);
+        if (!meta) {
+            return false;
+        }
+        return this.validateCode(meta, timestamp);
+    }
+}
+exports.ProtocolMetaParser = ProtocolMetaParser;
+ProtocolMetaParser.PROTOCOL_REGEX = /^([^:]+):v=(\d+)&pre=([^&]*)&ini=([^&]*)&id=([^&]*)&iss=([^&]+)(?:&p=([^&]+))?$/;

package/dist/protocol.d.ts

@@ -0,0 +1,167 @@
+import { ProtocolMetaV1 } from './meta';
+import { ActionCode } from './actioncode';
+import { BaseChainAdapter } from './adapters/base';
+import { SupportedChain } from './constants';
+/**
+ * OTA Protocol Configuration
+ */
+export interface ProtocolConfig {
+    /** Protocol version */
+    version: string;
+    /** Default prefix for action codes */
+    defaultPrefix: string;
+    /** Code TTL in milliseconds */
+    codeTTL: number;
+    /** Code length in digits */
+    codeLength: number;
+    /** Maximum prefix length */
+    maxPrefixLength: number;
+    /** Minimum prefix length */
+    minPrefixLength: number;
+}
+/**
+ * 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.
+ */
+export declare class ActionCodesProtocol {
+    private config;
+    private adapters;
+    constructor(config?: Partial<ProtocolConfig>);
+    /**
+     * Register a chain adapter
+     * @param adapter - Chain adapter implementation
+     */
+    registerAdapter<T>(adapter: BaseChainAdapter<T>): void;
+    /**
+     * Get registered chain adapters
+     * @returns Array of registered chain identifiers
+     */
+    getRegisteredChains(): string[];
+    /**
+     * Check if a chain is supported
+     * @param chain - Chain identifier
+     * @returns True if chain is supported
+     */
+    isChainSupported(chain: string): boolean;
+    /**
+     * Get chain adapter with proper typing
+     * @param chain - Chain identifier
+     * @returns Chain adapter or undefined
+     */
+    getChainAdapter<T = any>(chain: string): BaseChainAdapter<T> | undefined;
+    /**
+     * Generate an action code for a specific chain
+     * @param pubkey - User's public key
+     * @param signature - User's signature
+     * @param chain - Target chain
+     * @param prefix - Optional prefix (defaults to config defaultPrefix)
+     * @param timestamp - Optional timestamp (defaults to now)
+     * @returns ActionCode object
+     */
+    generateActionCode(pubkey: string, signature: string, chain: SupportedChain, prefix?: string, timestamp?: number): ActionCode<string>;
+    /**
+     * Validate an action code
+     * @param actionCode - ActionCode to validate
+     * @returns True if valid
+     */
+    validateActionCode(actionCode: ActionCode<string>): boolean;
+    /**
+     * Attach a transaction to an action code
+     * @param actionCode - ActionCode to attach transaction to
+     * @param transaction - Chain-specific transaction data
+     * @param txType - Optional transaction type
+     * @returns Updated ActionCode
+     */
+    attachTransaction(actionCode: ActionCode<string>, transaction: string, txType?: string): ActionCode<string>;
+    /**
+     * Finalize an action code with transaction signature
+     * @param actionCode - ActionCode to finalize
+     * @param txSignature - Transaction signature
+     * @returns Updated ActionCode
+     */
+    finalizeActionCode(actionCode: ActionCode<string>, txSignature: string): ActionCode<string>;
+    /**
+     * Create protocol meta for a transaction
+     * @param actionCode - ActionCode to create meta for
+     * @param issuer - Optional issuer public key
+     * @param params - Optional parameters
+     * @returns ProtocolMetaV1 object
+     */
+    createProtocolMeta(actionCode: ActionCode<string>, issuer?: string, params?: string): ProtocolMetaV1;
+    /**
+     * Encode protocol meta for a specific chain
+     * @param meta - ProtocolMetaV1 object
+     * @param chain - Target chain
+     * @returns Chain-specific encoded meta
+     */
+    encodeProtocolMeta(meta: ProtocolMetaV1, chain: string): any;
+    /**
+     * Decode protocol meta from a transaction
+     * @param transaction - Chain-specific transaction
+     * @param chain - Source chain
+     * @returns Decoded ProtocolMetaV1 or null
+     */
+    decodeProtocolMeta(transaction: any, chain: string): ProtocolMetaV1 | null;
+    /**
+     * Validate a transaction with protocol meta
+     * @param transaction - Chain-specific transaction
+     * @param chain - Source chain
+     * @param authorities - Array of valid protocol authority identifiers
+     * @param expectedPrefix - Expected protocol prefix
+     * @returns True if transaction is valid
+     */
+    validateTransaction(transaction: any, chain: string, authorities: string[], expectedPrefix?: string): boolean;
+    /**
+     * Type-safe transaction validation for specific chains
+     * @param transaction - Chain-specific transaction
+     * @param chain - Source chain
+     * @param authorities - Array of valid protocol authority identifiers
+     * @param expectedPrefix - Expected protocol prefix
+     * @returns True if transaction is valid
+     */
+    validateTransactionTyped<T>(transaction: T, chain: string, authorities: string[], expectedPrefix?: string): boolean;
+    /**
+     * Detect tampered transactions with type safety
+     * @param transaction - Chain-specific transaction
+     * @param chain - Source chain
+     * @param authorities - Array of valid protocol authority identifiers
+     * @param expectedPrefix - Expected protocol prefix
+     * @returns True if transaction is valid and not tampered
+     */
+    detectTampering<T>(transaction: T, chain: string, authorities: string[], expectedPrefix?: string): boolean;
+    /**
+     * Decode protocol meta with type safety
+     * @param transaction - Chain-specific transaction
+     * @param chain - Source chain
+     * @returns Decoded ProtocolMetaV1 or null
+     */
+    decodeProtocolMetaTyped<T>(transaction: T, chain: string): ProtocolMetaV1 | null;
+    /**
+     * Get protocol configuration
+     * @returns Current protocol configuration
+     */
+    getConfig(): ProtocolConfig;
+    /**
+     * Update protocol configuration
+     * @param updates - Configuration updates
+     */
+    updateConfig(updates: Partial<ProtocolConfig>): void;
+    /**
+     * Create a new protocol instance with default configuration
+     * @returns New protocol instance
+     */
+    static create(): ActionCodesProtocol;
+    /**
+     * Create a new protocol instance with custom configuration
+     * @param config - Custom configuration
+     * @returns New protocol instance
+     */
+    static createWithConfig(config: Partial<ProtocolConfig>): ActionCodesProtocol;
+}
+export type { ActionCode, ActionCodeStatus, ActionCodeTransaction } from './actioncode';
+export type { ProtocolMetaV1 } from './meta';
+export { SUPPORTED_CHAINS } from './constants';
+export type { SupportedChain } from './constants';
+//# sourceMappingURL=protocol.d.ts.map

package/dist/protocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.d.ts","sourceRoot":"","sources":["../src/protocol.ts"],"names":[],"mappings":"AACA,OAAO,EAAsB,cAAc,EAAE,MAAM,QAAQ,CAAC;AAC5D,OAAO,EAAE,UAAU,EAA2C,MAAM,cAAc,CAAC;AACnF,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EAA8D,cAAc,EAA2C,MAAM,aAAa,CAAC;AAElJ;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,uBAAuB;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,aAAa,EAAE,MAAM,CAAC;IACtB,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,4BAA4B;IAC5B,UAAU,EAAE,MAAM,CAAC;IACnB,4BAA4B;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,4BAA4B;IAC5B,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED;;;;;GAKG;AACH,qBAAa,mBAAmB;IAC5B,OAAO,CAAC,MAAM,CAAiB;IAC/B,OAAO,CAAC,QAAQ,CAAiD;gBAErD,MAAM,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC;IAY5C;;;OAGG;IACH,eAAe,CAAC,CAAC,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI;IAItD;;;OAGG;IACH,mBAAmB,IAAI,MAAM,EAAE;IAI/B;;;;OAIG;IACH,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAIxC;;;;OAIG;IACH,eAAe,CAAC,CAAC,GAAG,GAAG,EAAE,KAAK,EAAE,MAAM,GAAG,gBAAgB,CAAC,CAAC,CAAC,GAAG,SAAS;IAIxE;;;;;;;;OAQG;IACH,kBAAkB,CACd,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,cAAc,EACrB,MAAM,CAAC,EAAE,MAAM,EACf,SAAS,CAAC,EAAE,MAAM,GACnB,UAAU,CAAC,MAAM,CAAC;IA+BrB;;;;OAIG;IACH,kBAAkB,CAAC,UAAU,EAAE,UAAU,CAAC,MAAM,CAAC,GAAG,OAAO;IAgB3D;;;;;;OAMG;IACH,iBAAiB,CACb,UAAU,EAAE,UAAU,CAAC,MAAM,CAAC,EAC9B,WAAW,EAAE,MAAM,EACnB,MAAM,CAAC,EAAE,MAAM,GAChB,UAAU,CAAC,MAAM,CAAC;IAuBrB;;;;;OAKG;IACH,kBAAkB,CACd,UAAU,EAAE,UAAU,CAAC,MAAM,CAAC,EAC9B,WAAW,EAAE,MAAM,GACpB,UAAU,CAAC,MAAM,CAAC;IAsBrB;;;;;;OAMG;IACH,kBAAkB,CACd,UAAU,EAAE,UAAU,CAAC,MAAM,CAAC,EAC9B,MAAM,CAAC,EAAE,MAAM,EACf,MAAM,CAAC,EAAE,MAAM,GAChB,cAAc;IASjB;;;;;OAKG;IACH,kBAAkB,CAAC,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,MAAM,GAAG,GAAG;IAS5D;;;;;OAKG;IACH,kBAAkB,CAAC,WAAW,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,IAAI;IAS1E;;;;;;;OAOG;IACH,mBAAmB,CACf,WAAW,EAAE,GAAG,EAChB,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,EAAE,EACrB,cAAc,CAAC,EAAE,MAAM,GACxB,OAAO;IASV;;;;;;;OAOG;IACH,wBAAwB,CAAC,CAAC,EACtB,WAAW,EAAE,CAAC,EACd,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,EAAE,EACrB,cAAc,CAAC,EAAE,MAAM,GACxB,OAAO;IASV;;;;;;;OAOG;IACH,eAAe,CAAC,CAAC,EACb,WAAW,EAAE,CAAC,EACd,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,EAAE,EACrB,cAAc,CAAC,EAAE,MAAM,GACxB,OAAO;IASV;;;;;OAKG;IACH,uBAAuB,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,cAAc,GAAG,IAAI;IAShF;;;OAGG;IACH,SAAS,IAAI,cAAc;IAI3B;;;OAGG;IACH,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,IAAI;IAIpD;;;OAGG;IACH,MAAM,CAAC,MAAM,IAAI,mBAAmB;IAIpC;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,OAAO,CAAC,cAAc,CAAC,GAAG,mBAAmB;CAGhF;AAGD,YAAY,EAAE,UAAU,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AACxF,YAAY,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAC;AAG7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,YAAY,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC"}

package/dist/protocol.js

@@ -0,0 +1,280 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SUPPORTED_CHAINS = exports.ActionCodesProtocol = void 0;
+const codegen_1 = require("./codegen");
+const meta_1 = require("./meta");
+const actioncode_1 = require("./actioncode");
+const constants_1 = require("./constants");
+/**
+ * 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.
+ */
+class ActionCodesProtocol {
+    constructor(config) {
+        this.adapters = new Map();
+        this.config = {
+            version: constants_1.PROTOCOL_VERSION,
+            defaultPrefix: constants_1.PROTOCOL_CODE_PREFIX,
+            codeTTL: constants_1.CODE_TTL,
+            codeLength: constants_1.CODE_LENGTH,
+            maxPrefixLength: constants_1.MAX_PREFIX_LENGTH,
+            minPrefixLength: constants_1.MIN_PREFIX_LENGTH,
+            ...config
+        };
+    }
+    /**
+     * Register a chain adapter
+     * @param adapter - Chain adapter implementation
+     */
+    registerAdapter(adapter) {
+        this.adapters.set(adapter.chain, adapter);
+    }
+    /**
+     * Get registered chain adapters
+     * @returns Array of registered chain identifiers
+     */
+    getRegisteredChains() {
+        return Array.from(this.adapters.keys());
+    }
+    /**
+     * Check if a chain is supported
+     * @param chain - Chain identifier
+     * @returns True if chain is supported
+     */
+    isChainSupported(chain) {
+        return this.adapters.has(chain);
+    }
+    /**
+     * Get chain adapter with proper typing
+     * @param chain - Chain identifier
+     * @returns Chain adapter or undefined
+     */
+    getChainAdapter(chain) {
+        return this.adapters.get(chain);
+    }
+    /**
+     * Generate an action code for a specific chain
+     * @param pubkey - User's public key
+     * @param signature - User's signature
+     * @param chain - Target chain
+     * @param prefix - Optional prefix (defaults to config defaultPrefix)
+     * @param timestamp - Optional timestamp (defaults to now)
+     * @returns ActionCode object
+     */
+    generateActionCode(pubkey, signature, chain, prefix, timestamp) {
+        if (!this.isChainSupported(chain)) {
+            throw new Error(`Chain '${chain}' is not supported. Registered chains: ${this.getRegisteredChains().join(', ')}`);
+        }
+        const normalizedPrefix = prefix || this.config.defaultPrefix;
+        const ts = timestamp || Date.now();
+        // Generate code using CodeGenerator
+        const { code, issuedAt, expiresAt } = codegen_1.CodeGenerator.generateCode(pubkey, signature, normalizedPrefix, ts);
+        // Create ActionCode object
+        const actionCodeFields = {
+            code,
+            prefix: normalizedPrefix,
+            pubkey,
+            timestamp: issuedAt,
+            signature,
+            chain,
+            expiresAt,
+            status: 'pending'
+        };
+        return actioncode_1.ActionCode.fromPayload(actionCodeFields);
+    }
+    /**
+     * Validate an action code
+     * @param actionCode - ActionCode to validate
+     * @returns True if valid
+     */
+    validateActionCode(actionCode) {
+        const chain = actionCode.chain;
+        if (!this.isChainSupported(chain)) {
+            return false;
+        }
+        // Basic validation - check if expired
+        if (actionCode.expired) {
+            return false;
+        }
+        // Chain-specific validation would be done when attaching transactions
+        return true;
+    }
+    /**
+     * Attach a transaction to an action code
+     * @param actionCode - ActionCode to attach transaction to
+     * @param transaction - Chain-specific transaction data
+     * @param txType - Optional transaction type
+     * @returns Updated ActionCode
+     */
+    attachTransaction(actionCode, transaction, txType) {
+        const chain = actionCode.chain;
+        if (!this.isChainSupported(chain)) {
+            throw new Error(`Chain '${chain}' is not supported`);
+        }
+        // Create transaction object
+        const txObject = {
+            transaction,
+            txType: txType || chain
+        };
+        // Update ActionCode
+        const updatedFields = {
+            ...actionCode.json,
+            transaction: txObject,
+            status: 'resolved'
+        };
+        return actioncode_1.ActionCode.fromPayload(updatedFields);
+    }
+    /**
+     * Finalize an action code with transaction signature
+     * @param actionCode - ActionCode to finalize
+     * @param txSignature - Transaction signature
+     * @returns Updated ActionCode
+     */
+    finalizeActionCode(actionCode, txSignature) {
+        const currentTransaction = actionCode.transaction;
+        if (!currentTransaction) {
+            throw new Error('Cannot finalize ActionCode without attached transaction');
+        }
+        // Update transaction with signature
+        const updatedTransaction = {
+            ...currentTransaction,
+            txSignature
+        };
+        // Update ActionCode
+        const updatedFields = {
+            ...actionCode.json,
+            transaction: updatedTransaction,
+            status: 'finalized'
+        };
+        return actioncode_1.ActionCode.fromPayload(updatedFields);
+    }
+    /**
+     * Create protocol meta for a transaction
+     * @param actionCode - ActionCode to create meta for
+     * @param issuer - Optional issuer public key
+     * @param params - Optional parameters
+     * @returns ProtocolMetaV1 object
+     */
+    createProtocolMeta(actionCode, issuer, params) {
+        return meta_1.ProtocolMetaParser.fromInitiator(actionCode.pubkey, issuer || actionCode.pubkey, actionCode.prefix, params);
+    }
+    /**
+     * Encode protocol meta for a specific chain
+     * @param meta - ProtocolMetaV1 object
+     * @param chain - Target chain
+     * @returns Chain-specific encoded meta
+     */
+    encodeProtocolMeta(meta, chain) {
+        const adapter = this.adapters.get(chain);
+        if (!adapter) {
+            throw new Error(`Chain '${chain}' is not supported`);
+        }
+        return adapter.encode(meta);
+    }
+    /**
+     * Decode protocol meta from a transaction
+     * @param transaction - Chain-specific transaction
+     * @param chain - Source chain
+     * @returns Decoded ProtocolMetaV1 or null
+     */
+    decodeProtocolMeta(transaction, chain) {
+        const adapter = this.adapters.get(chain);
+        if (!adapter) {
+            return null;
+        }
+        return adapter.decode(transaction);
+    }
+    /**
+     * Validate a transaction with protocol meta
+     * @param transaction - Chain-specific transaction
+     * @param chain - Source chain
+     * @param authorities - Array of valid protocol authority identifiers
+     * @param expectedPrefix - Expected protocol prefix
+     * @returns True if transaction is valid
+     */
+    validateTransaction(transaction, chain, authorities, expectedPrefix) {
+        const adapter = this.adapters.get(chain);
+        if (!adapter) {
+            return false;
+        }
+        return adapter.validate(transaction, authorities, expectedPrefix);
+    }
+    /**
+     * Type-safe transaction validation for specific chains
+     * @param transaction - Chain-specific transaction
+     * @param chain - Source chain
+     * @param authorities - Array of valid protocol authority identifiers
+     * @param expectedPrefix - Expected protocol prefix
+     * @returns True if transaction is valid
+     */
+    validateTransactionTyped(transaction, chain, authorities, expectedPrefix) {
+        const adapter = this.getChainAdapter(chain);
+        if (!adapter) {
+            return false;
+        }
+        return adapter.validate(transaction, authorities, expectedPrefix);
+    }
+    /**
+     * Detect tampered transactions with type safety
+     * @param transaction - Chain-specific transaction
+     * @param chain - Source chain
+     * @param authorities - Array of valid protocol authority identifiers
+     * @param expectedPrefix - Expected protocol prefix
+     * @returns True if transaction is valid and not tampered
+     */
+    detectTampering(transaction, chain, authorities, expectedPrefix) {
+        const adapter = this.getChainAdapter(chain);
+        if (!adapter) {
+            return false;
+        }
+        return adapter.detectTampering(transaction, authorities, expectedPrefix);
+    }
+    /**
+     * Decode protocol meta with type safety
+     * @param transaction - Chain-specific transaction
+     * @param chain - Source chain
+     * @returns Decoded ProtocolMetaV1 or null
+     */
+    decodeProtocolMetaTyped(transaction, chain) {
+        const adapter = this.getChainAdapter(chain);
+        if (!adapter) {
+            return null;
+        }
+        return adapter.decode(transaction);
+    }
+    /**
+     * Get protocol configuration
+     * @returns Current protocol configuration
+     */
+    getConfig() {
+        return { ...this.config };
+    }
+    /**
+     * Update protocol configuration
+     * @param updates - Configuration updates
+     */
+    updateConfig(updates) {
+        this.config = { ...this.config, ...updates };
+    }
+    /**
+     * Create a new protocol instance with default configuration
+     * @returns New protocol instance
+     */
+    static create() {
+        return new ActionCodesProtocol();
+    }
+    /**
+     * Create a new protocol instance with custom configuration
+     * @param config - Custom configuration
+     * @returns New protocol instance
+     */
+    static createWithConfig(config) {
+        return new ActionCodesProtocol(config);
+    }
+}
+exports.ActionCodesProtocol = ActionCodesProtocol;
+// Export constants
+var constants_2 = require("./constants");
+Object.defineProperty(exports, "SUPPORTED_CHAINS", { enumerable: true, get: function () { return constants_2.SUPPORTED_CHAINS; } });

package/docs/README.md

@@ -0,0 +1,59 @@
+**@actioncodes/protocol**
+
+***
+
+# 🛡️ Action Codes Protocol
+
+![Coverage](https://img.shields.io/badge/coverage-99.25%25-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
+
+```
+/src         - SDK modules (codegen, meta, validator, blockchain adapters)
+/specs       - Formal specifications (AIPs)
+README.md    - You are here
+LICENSE      - Apache 2.0
+```
+
+---
+
+## 📄 Specifications
+
+[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
+
+This protocol is open source under the [Apache 2.0 License](_media/LICENSE).