@actioncodes/protocol 1.2.1 → 2.0.0

package/dist/actioncode.js

@@ -1,173 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ActionCode = void 0;
-const codegen_1 = require("./codegen");
-const buffer_1 = require("buffer");
-class ActionCode {
-    constructor(fields) {
-        this.fields = fields;
-    }
-    static fromPayload(input) {
-        if (!input.code || !input.pubkey || !input.signature || !input.timestamp || !input.expiresAt || !input.chain || !input.status) {
-            throw new Error("Missing required fields in ActionCode payload");
-        }
-        return new ActionCode(input);
-    }
-    static fromEncoded(encoded) {
-        const decoded = JSON.parse(buffer_1.Buffer.from(encoded, 'base64').toString('utf8'));
-        return ActionCode.fromPayload(decoded);
-    }
-    get encoded() {
-        return buffer_1.Buffer.from(JSON.stringify(this.fields), 'utf8').toString('base64');
-    }
-    isValid(protocol) {
-        if (this.expired)
-            return false;
-        const adapter = protocol.getChainAdapter(this.chain);
-        if (!adapter)
-            throw new Error(`Chain adapter not found for chain ${this.chain}`);
-        const isSignatureValid = adapter.verifyCodeSignature(this);
-        const isCodeValid = codegen_1.CodeGenerator.validateCode(this.fields.code, this.fields.pubkey, this.fields.timestamp, this.fields.prefix);
-        return isSignatureValid && isCodeValid;
-    }
-    updateStatus(status) {
-        this.fields.status = status;
-    }
-    get json() {
-        return this.fields;
-    }
-    // UX-focused helper methods
-    /**
-     * Get remaining time in milliseconds until expiration
-     * @returns Remaining time in milliseconds, or 0 if expired
-     */
-    get remainingTime() {
-        const now = Date.now();
-        return Math.max(0, this.fields.expiresAt - now); // TODO: rename to remainingTime
-    }
-    /**
-     * Check if the action code has expired
-     * @returns True if the code has expired
-     */
-    get expired() {
-        return this.remainingTime === 0; // TODO: rename to expired
-    }
-    /**
-     * Get the target chain for this action code
-     * @returns Chain identifier (e.g., "solana", "evm")
-     */
-    get chain() {
-        return this.fields.chain;
-    }
-    /**
-     * Get the current status of the action code
-     * @returns Current status
-     */
-    get status() {
-        return this.fields.status;
-    }
-    /**
-     * Get the action code string
-     * @returns The 8-character action code
-     */
-    get code() {
-        return this.fields.code;
-    }
-    /**
-     * Get the prefix used for this action code
-     * @returns Normalized prefix
-     */
-    get prefix() {
-        return this.fields.prefix;
-    }
-    /**
-     * Get the user's public key
-     * @returns User's public key
-     */
-    get pubkey() {
-        return this.fields.pubkey;
-    }
-    /**
-     * Get the transaction data (chain-specific)
-     * @returns Transaction data or undefined
-     */
-    get transaction() {
-        return this.fields.transaction;
-    }
-    /**
-     * Get metadata associated with this action code
-     * @returns Metadata object or undefined
-     */
-    get metadata() {
-        return this.fields.metadata;
-    }
-    /**
-     * Get a human-readable description of the action
-     * @returns Description string or undefined
-     */
-    get description() {
-        return this.fields.metadata?.description;
-    }
-    /**
-     * Get parameters associated with this action
-     * @returns Parameters object or undefined
-     */
-    get params() {
-        return this.fields.metadata?.params;
-    }
-    /**
-     * Get the timestamp when the code was generated
-     * @returns Timestamp in milliseconds
-     */
-    get timestamp() {
-        return this.fields.timestamp;
-    }
-    /**
-     * Get the user's signature
-     * @returns User's signature string
-     */
-    get signature() {
-        return this.fields.signature;
-    }
-    /**
-     * Get a human-readable display string for the action code
-     * @returns Formatted display string
-     */
-    get displayString() {
-        const prefix = this.fields.prefix === 'DEFAULT' ? '' : `${this.fields.prefix}-`;
-        const code = this.fields.code;
-        const chain = this.fields.chain;
-        const status = this.fields.status;
-        return `${prefix}${code} (${chain}, ${status})`;
-    }
-    /**
-     * Get a formatted time string showing remaining time
-     * @returns Human-readable time string (e.g., "1m 30s remaining")
-     */
-    get remainingTimeString() {
-        const remaining = this.remainingTime;
-        if (remaining === 0) {
-            return 'Expired';
-        }
-        const minutes = Math.floor(remaining / 60000);
-        const seconds = Math.floor((remaining % 60000) / 1000);
-        if (minutes > 0) {
-            return `${minutes}m ${seconds}s remaining`;
-        }
-        else {
-            return `${seconds}s remaining`;
-        }
-    }
-    /**
-     * Get the code hash for this action code
-     * it is also used in the protocol meta as the code id
-     * @returns Code hash string
-     */
-    get codeHash() {
-        return codegen_1.CodeGenerator.deriveCodeHash(this.fields.pubkey, this.fields.prefix, this.fields.timestamp);
-    }
-    get intentType() {
-        return this.fields.transaction?.intentType || 'transaction';
-    }
-}
-exports.ActionCode = ActionCode;

package/dist/adapters/base.d.ts

@@ -1,93 +0,0 @@
-import { ActionCode } from '../actioncode';
-import { ProtocolMetaV1 } from '../meta';
-/**
- * Base adapter class for chain-specific protocol meta operations
- * @template T - Chain-specific transaction type
- */
-export declare abstract class BaseChainAdapter<T = any> {
-    abstract readonly chain: string;
-    /**
-     * Encode protocol meta for this chain
-     * @param meta - ProtocolMetaV1 object
-     * @returns Chain-specific encoded data
-     */
-    abstract encodeMeta(meta: ProtocolMetaV1): any;
-    /**
-     * Decode protocol meta from chain-specific transaction
-     * @param tx - Chain-specific transaction
-     * @returns Decoded ProtocolMetaV1 or null
-     */
-    abstract decodeMeta(tx: T): ProtocolMetaV1 | null;
-    /**
-     * Inject protocol meta into chain-specific transaction
-     * @param serializedTx - Serialized transaction string
-     * @param meta - ProtocolMetaV1 object
-     * @returns Serialized transaction with injected meta
-     */
-    abstract injectMeta(serializedTx: string, meta: ProtocolMetaV1): string;
-    /**
-     * Validate transaction with protocol meta and authority list
-     * @param tx - Chain-specific transaction
-     * @param authorities - Array of valid protocol authority identifiers
-     * @param expectedPrefix - Expected protocol prefix (default: 'DEFAULT')
-     * @returns True if transaction is valid
-     */
-    abstract validate(tx: T, authorities: string[], expectedPrefix?: string): boolean;
-    /**
-     * Check if the issuer has signed the transaction
-     * @param tx - Chain-specific transaction
-     * @param issuer - Issuer public key to check
-     * @returns True if issuer has signed
-     */
-    abstract hasIssuerSignature(tx: T, issuer: string): boolean;
-    /**
-     * Detect tampered transactions by cross-checking metadata
-     * @param tx - Chain-specific transaction
-     * @param authorities - Array of valid protocol authority identifiers
-     * @param expectedPrefix - Expected protocol prefix
-     * @returns True if transaction is valid and not tampered
-     */
-    detectTampering(tx: T, authorities: string[], expectedPrefix?: string): boolean;
-    /**
-     * Chain-specific transaction integrity validation
-     * Override this method for additional validation logic
-     * @param tx - Chain-specific transaction
-     * @param meta - Decoded protocol meta
-     * @returns True if transaction integrity is valid
-     */
-    protected abstract validateTransactionIntegrity(tx: T, meta: ProtocolMetaV1): boolean;
-    /**
-     * Get the code signature message
-     * @param code - The code to sign
-     * @param timestamp - The timestamp of the code
-     * @param prefix - The prefix of the code
-     * @returns The code signature message
-     */
-    getCodeSignatureMessage(code: string, timestamp: number, prefix?: string): string;
-    /**
-     * Verify the code signature
-     * This is specific to the chain and should be implemented by the concrete adapter
-     * It will be used to verify the code signature for the action code if the right wallet is used to sign the code
-     * @param actionCode - The action code to verify
-     * @returns True if the code signature is valid
-     */
-    abstract verifyCodeSignature(actionCode: ActionCode): boolean;
-    /**
-     * Sign the transaction with the protocol key using a callback approach
-     * This method should be implemented by each chain-specific adapter to handle
-     * the chain's specific signing mechanism asynchronously
-     * @param tx - Chain-specific transaction to sign
-     * @param protocolPrivateKey - Private key or Keypair object depending on the chain
-     * @param signCallback - Callback function that performs the actual signing
-     * @returns Promise that resolves to the signed transaction
-     */
-    abstract signWithProtocolKey(actionCode: ActionCode, key: any): Promise<ActionCode>;
-    /**
-     * Verify the finalized transaction
-     * @param tx - The finalized transaction to verify
-     * @returns True if the transaction is valid
-     */
-    abstract verifyFinalizedTransaction(tx: any, actionCode: ActionCode): boolean;
-    abstract validateSignedMessage(message: string, signedMessage: string, pubkey: string): boolean;
-}
-//# sourceMappingURL=base.d.ts.map

package/dist/adapters/base.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/adapters/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAEzC;;;GAGG;AACH,8BAAsB,gBAAgB,CAAC,CAAC,GAAG,GAAG;IAC1C,QAAQ,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEhC;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,IAAI,EAAE,cAAc,GAAG,GAAG;IAE9C;;;;OAIG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,GAAG,cAAc,GAAG,IAAI;IAEjD;;;;;OAKG;IACH,QAAQ,CAAC,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,GAAG,MAAM;IAEvE;;;;;;OAMG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO;IAEjF;;;;;OAKG;IACH,QAAQ,CAAC,kBAAkB,CAAC,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO;IAE3D;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,EAAE,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,cAAc,GAAE,MAAkB,GAAG,OAAO;IA8B1F;;;;;;OAMG;IACH,SAAS,CAAC,QAAQ,CAAC,4BAA4B,CAAC,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO;IAErF;;;;;;OAMG;IACH,uBAAuB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,GAAE,MAA6B,GAAG,MAAM;IAIvG;;;;;;OAMG;IACH,QAAQ,CAAC,mBAAmB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO;IAE7D;;;;;;;;OAQG;IACH,QAAQ,CAAC,mBAAmB,CACxB,UAAU,EAAE,UAAU,EACtB,GAAG,EAAE,GAAG,GACT,OAAO,CAAC,UAAU,CAAC;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,0BAA0B,CAAC,EAAE,EAAE,GAAG,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO;IAE7E,QAAQ,CAAC,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO;CAClG"}

package/dist/adapters/base.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseChainAdapter = void 0;
-const constants_1 = require("../constants");
-/**
- * Base adapter class for chain-specific protocol meta operations
- * @template T - Chain-specific transaction type
- */
-class BaseChainAdapter {
-    /**
-     * Detect tampered transactions by cross-checking metadata
-     * @param tx - Chain-specific transaction
-     * @param authorities - Array of valid protocol authority identifiers
-     * @param expectedPrefix - Expected protocol prefix
-     * @returns True if transaction is valid and not tampered
-     */
-    detectTampering(tx, authorities, expectedPrefix = 'DEFAULT') {
-        // First, decode the protocol meta from the transaction
-        const meta = this.decodeMeta(tx);
-        if (!meta) {
-            return false; // No protocol meta found
-        }
-        // Validate the meta structure
-        if (meta.version !== '1') {
-            return false; // Invalid version
-        }
-        if (meta.prefix !== expectedPrefix) {
-            return false; // Wrong prefix
-        }
-        // Check if issuer is in the authorities list
-        if (!meta.iss || !authorities.includes(meta.iss)) {
-            return false; // Invalid issuer
-        }
-        // Verify the issuer has actually signed the transaction
-        if (!this.hasIssuerSignature(tx, meta.iss)) {
-            return false; // Issuer didn't sign
-        }
-        // Additional chain-specific validation
-        return this.validateTransactionIntegrity(tx, meta);
-    }
-    /**
-     * Get the code signature message
-     * @param code - The code to sign
-     * @param timestamp - The timestamp of the code
-     * @param prefix - The prefix of the code
-     * @returns The code signature message
-     */
-    getCodeSignatureMessage(code, timestamp, prefix = constants_1.PROTOCOL_CODE_PREFIX) {
-        return `${prefix}:${code}:${timestamp}`;
-    }
-}
-exports.BaseChainAdapter = BaseChainAdapter;

package/dist/adapters/solana/index.d.ts

@@ -1,2 +0,0 @@
-export * from './solana';
-//# sourceMappingURL=index.d.ts.map

package/dist/adapters/solana/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/adapters/solana/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC"}

package/dist/adapters/solana/index.js

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./solana"), exports);

package/dist/adapters/solana/solana.d.ts

@@ -1,113 +0,0 @@
-import { Transaction, TransactionInstruction, VersionedTransaction, Keypair, VersionedTransactionResponse } from '@solana/web3.js';
-import { ProtocolMetaV1 } from '../../meta';
-import { BaseChainAdapter } from '../base';
-import { ActionCode } from '../../actioncode';
-/**
- * Solana transaction type union
- */
-export type SolanaTransaction = Transaction | VersionedTransaction;
-/**
- * Simple Solana adapter for protocol meta operations
- * Supports both legacy and versioned transactions
- */
-export declare class SolanaAdapter extends BaseChainAdapter<SolanaTransaction> {
-    private static readonly MEMO_PROGRAM_ID;
-    readonly chain = "solana";
-    /**
-     * Encode protocol meta as a Solana memo instruction
-     * @param meta - The protocol meta to encode
-     * @returns TransactionInstruction for the memo
-     */
-    encodeMeta(meta: ProtocolMetaV1): TransactionInstruction;
-    /**
-     * Decode protocol meta from Solana transaction (legacy or versioned)
-     * @param tx - The Solana transaction (can be deserialized object or base64 string)
-     * @returns Decoded ProtocolMetaV1 or null if not found
-     */
-    decodeMeta(tx: SolanaTransaction | string): ProtocolMetaV1 | null;
-    /**
-     * Deserialize a Solana transaction from base64 string
-     * @param base64String - Base64 encoded transaction
-     * @returns SolanaTransaction object
-     */
-    deserializeTransaction(base64String: string): SolanaTransaction;
-    /**
-     * Inject protocol meta into Solana transaction
-     * @param serializedTx - Serialized transaction string (base64)
-     * @param meta - ProtocolMetaV1 object
-     * @returns Serialized transaction with injected meta
-     */
-    injectMeta(serializedTx: string, meta: ProtocolMetaV1): string;
-    /**
-     * Validate transaction with protocol meta and authority list
-     * @param tx - The Solana transaction
-     * @param authorities - Array of valid protocol authority public keys (base58)
-     * @param expectedPrefix - Expected protocol prefix (default: 'DEFAULT')
-     * @returns True if transaction is valid
-     */
-    validate(tx: SolanaTransaction, authorities: string[], expectedPrefix?: string): boolean;
-    /**
-     * Check if the issuer has signed the transaction
-     * @param tx - The Solana transaction (can be deserialized object or base64 string)
-     * @param issuer - Issuer public key to check
-     * @returns True if issuer has signed
-     */
-    hasIssuerSignature(tx: SolanaTransaction | string, issuer: string): boolean;
-    /**
-     * Decode protocol meta from legacy Solana transaction
-     */
-    private decodeLegacyTransaction;
-    /**
-     * Decode protocol meta from versioned Solana transaction
-     */
-    private decodeVersionedTransaction;
-    /**
-     * Decode protocol meta from MessageV0
-     */
-    private decodeMessageV0;
-    /**
-     * Check if the issuer has signed a legacy transaction
-     */
-    private hasIssuerSignatureLegacy;
-    /**
-     * Check if the issuer has signed a versioned transaction
-     */
-    private hasIssuerSignatureVersioned;
-    /**
-     * Validate Solana transaction integrity with additional checks
-     * @param tx - The Solana transaction
-     * @param meta - Decoded protocol meta
-     * @returns True if transaction integrity is valid
-     */
-    protected validateTransactionIntegrity(tx: SolanaTransaction, meta: ProtocolMetaV1): boolean;
-    verifyCodeSignature(actionCode: ActionCode): boolean;
-    /**
-     * Decode protocol meta from base64 string (for backward compatibility)
-     * @param base64String - Base64 encoded transaction
-     * @returns Decoded ProtocolMetaV1 or null
-     */
-    decodeFromBase64(base64String: string): ProtocolMetaV1 | null;
-    /**
-     * Sign the transaction with the protocol key
-     * @param actionCode - The action code containing the transaction
-     * @param key - The keypair to sign with
-     * @returns Promise that resolves to the signed action code
-     */
-    signWithProtocolKey(actionCode: ActionCode, key: Keypair): Promise<ActionCode>;
-    /**
-     * Verify the finalized transaction from blockchain
-     * @param tx - The finalized transaction response from blockchain
-     * @param actionCode - The action code to verify against
-     * @returns True if the transaction is valid and matches the action code
-     */
-    verifyFinalizedTransaction(tx: VersionedTransactionResponse, actionCode: ActionCode): boolean;
-    /**
-     * Validate a signed message for sign-only mode
-     * @param message - The message that was signed
-     * @param signedMessage - The signed message (base64 or hex)
-     * @param pubkey - The public key that should have signed the message
-     * @returns True if the signature is valid
-     */
-    validateSignedMessage(message: string, signedMessage: string, pubkey: string): boolean;
-}
-//# sourceMappingURL=solana.d.ts.map

package/dist/adapters/solana/solana.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"solana.d.ts","sourceRoot":"","sources":["../../../src/adapters/solana/solana.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,WAAW,EACX,sBAAsB,EACtB,oBAAoB,EAGpB,OAAO,EACP,4BAA4B,EAC/B,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAE,cAAc,EAAsB,MAAM,YAAY,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAE3C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAI9C;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG,oBAAoB,CAAC;AAEnE;;;GAGG;AACH,qBAAa,aAAc,SAAQ,gBAAgB,CAAC,iBAAiB,CAAC;IAClE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAmB;IAE1D,QAAQ,CAAC,KAAK,YAAY;IAE1B;;;;OAIG;IACH,UAAU,CAAC,IAAI,EAAE,cAAc,GAAG,sBAAsB;IAgBxD;;;;OAIG;IACH,UAAU,CAAC,EAAE,EAAE,iBAAiB,GAAG,MAAM,GAAG,cAAc,GAAG,IAAI;IAoBjE;;;;OAIG;IACI,sBAAsB,CAAC,YAAY,EAAE,MAAM,GAAG,iBAAiB;IActE;;;;;OAKG;IACH,UAAU,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,cAAc,GAAG,MAAM;IA2E9D;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,cAAc,GAAE,MAAkB,GAAG,OAAO;IAInG;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,EAAE,iBAAiB,GAAG,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO;IAoB3E;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAqB/B;;OAEG;IACH,OAAO,CAAC,0BAA0B;IAUlC;;OAEG;IACH,OAAO,CAAC,eAAe;IAuBvB;;OAEG;IACH,OAAO,CAAC,wBAAwB;IAMhC;;OAEG;IACH,OAAO,CAAC,2BAA2B;IAenC;;;;;OAKG;IACH,SAAS,CAAC,4BAA4B,CAAC,EAAE,EAAE,iBAAiB,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO;IA6BrF,mBAAmB,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO;IAa3D;;;;OAIG;IACH,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,cAAc,GAAG,IAAI;IAI7D;;;;;OAKG;IACG,mBAAmB,CACrB,UAAU,EAAE,UAAU,EACtB,GAAG,EAAE,OAAO,GACb,OAAO,CAAC,UAAU,CAAC;IA4CtB;;;;;OAKG;IACH,0BAA0B,CAAC,EAAE,EAAE,4BAA4B,EAAE,UAAU,EAAE,UAAU,GAAG,OAAO;IAwH7F;;;;;;OAMG;IACH,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO;CAYzF"}