@actioncodes/protocol 1.2.1 → 2.0.0

package/docs/utils/crypto/README.md

@@ -0,0 +1,18 @@
+[**@actioncodes/protocol-v2**](../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../modules.md) / utils/crypto
+
+# utils/crypto
+
+## Functions
+
+- [base32EncodeCrockford](functions/base32EncodeCrockford.md)
+- [codeHash](functions/codeHash.md)
+- [digestToDigits](functions/digestToDigits.md)
+- [generateRandomSecret](functions/generateRandomSecret.md)
+- [hkdfSha256](functions/hkdfSha256.md)
+- [hmacSha256](functions/hmacSha256.md)
+- [sha256](functions/sha256.md)
+- [truncateBits](functions/truncateBits.md)

package/docs/utils/crypto/functions/base32EncodeCrockford.md

@@ -0,0 +1,21 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [utils/crypto](../README.md) / base32EncodeCrockford
+
+# Function: base32EncodeCrockford()
+
+> **base32EncodeCrockford**(`data`): `string`
+
+Defined in: src/utils/crypto.ts:40
+
+## Parameters
+
+### data
+
+`Uint8Array`
+
+## Returns
+
+`string`

package/docs/utils/crypto/functions/codeHash.md

@@ -0,0 +1,21 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [utils/crypto](../README.md) / codeHash
+
+# Function: codeHash()
+
+> **codeHash**(`code`): `string`
+
+Defined in: src/utils/crypto.ts:94
+
+## Parameters
+
+### code
+
+`string`
+
+## Returns
+
+`string`

package/docs/utils/crypto/functions/digestToDigits.md

@@ -0,0 +1,25 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [utils/crypto](../README.md) / digestToDigits
+
+# Function: digestToDigits()
+
+> **digestToDigits**(`digest`, `length`): `string`
+
+Defined in: src/utils/crypto.ts:73
+
+## Parameters
+
+### digest
+
+`Uint8Array`
+
+### length
+
+`number`
+
+## Returns
+
+`string`

package/docs/utils/crypto/functions/generateRandomSecret.md

@@ -0,0 +1,15 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [utils/crypto](../README.md) / generateRandomSecret
+
+# Function: generateRandomSecret()
+
+> **generateRandomSecret**(): `string`
+
+Defined in: src/utils/crypto.ts:102
+
+## Returns
+
+`string`

package/docs/utils/crypto/functions/hkdfSha256.md

@@ -0,0 +1,35 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [utils/crypto](../README.md) / hkdfSha256
+
+# Function: hkdfSha256()
+
+> **hkdfSha256**(`ikm`, `length`, `__namedParameters`): `Uint8Array`
+
+Defined in: src/utils/crypto.ts:22
+
+## Parameters
+
+### ikm
+
+`string` | `Uint8Array`\<`ArrayBufferLike`\>
+
+### length
+
+`number`
+
+### \_\_namedParameters
+
+#### info?
+
+`string` \| `Uint8Array`\<`ArrayBufferLike`\>
+
+#### salt?
+
+`string` \| `Uint8Array`\<`ArrayBufferLike`\>
+
+## Returns
+
+`Uint8Array`

package/docs/utils/crypto/functions/hmacSha256.md

@@ -0,0 +1,25 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [utils/crypto](../README.md) / hmacSha256
+
+# Function: hmacSha256()
+
+> **hmacSha256**(`key`, `data`): `Uint8Array`
+
+Defined in: src/utils/crypto.ts:14
+
+## Parameters
+
+### key
+
+`string` | `Uint8Array`\<`ArrayBufferLike`\>
+
+### data
+
+`string` | `Uint8Array`\<`ArrayBufferLike`\>
+
+## Returns
+
+`Uint8Array`

package/docs/utils/crypto/functions/sha256.md

@@ -0,0 +1,21 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [utils/crypto](../README.md) / sha256
+
+# Function: sha256()
+
+> **sha256**(`data`): `Uint8Array`
+
+Defined in: src/utils/crypto.ts:10
+
+## Parameters
+
+### data
+
+`string` | `Uint8Array`\<`ArrayBufferLike`\>
+
+## Returns
+
+`Uint8Array`

package/docs/utils/crypto/functions/truncateBits.md

@@ -0,0 +1,25 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [utils/crypto](../README.md) / truncateBits
+
+# Function: truncateBits()
+
+> **truncateBits**(`input`, `totalBits`): `Uint8Array`
+
+Defined in: src/utils/crypto.ts:58
+
+## Parameters
+
+### input
+
+`Uint8Array`
+
+### totalBits
+
+`number`
+
+## Returns
+
+`Uint8Array`

package/docs/utils/protocolMeta/README.md

@@ -0,0 +1,21 @@
+[**@actioncodes/protocol-v2**](../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../modules.md) / utils/protocolMeta
+
+# utils/protocolMeta
+
+## Interfaces
+
+- [ProtocolMetaFields](interfaces/ProtocolMetaFields.md)
+
+## Variables
+
+- [SCHEME](variables/SCHEME.md)
+
+## Functions
+
+- [buildProtocolMeta](functions/buildProtocolMeta.md)
+- [parseProtocolMeta](functions/parseProtocolMeta.md)
+- [validateProtocolMetaFormat](functions/validateProtocolMetaFormat.md)

package/docs/utils/protocolMeta/functions/buildProtocolMeta.md

@@ -0,0 +1,21 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [utils/protocolMeta](../README.md) / buildProtocolMeta
+
+# Function: buildProtocolMeta()
+
+> **buildProtocolMeta**(`fields`): `string`
+
+Defined in: src/utils/protocolMeta.ts:13
+
+## Parameters
+
+### fields
+
+[`ProtocolMetaFields`](../interfaces/ProtocolMetaFields.md)
+
+## Returns
+
+`string`

package/docs/utils/protocolMeta/functions/parseProtocolMeta.md

@@ -0,0 +1,21 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [utils/protocolMeta](../README.md) / parseProtocolMeta
+
+# Function: parseProtocolMeta()
+
+> **parseProtocolMeta**(`input`): [`ProtocolMetaFields`](../interfaces/ProtocolMetaFields.md)
+
+Defined in: src/utils/protocolMeta.ts:34
+
+## Parameters
+
+### input
+
+`string`
+
+## Returns
+
+[`ProtocolMetaFields`](../interfaces/ProtocolMetaFields.md)

package/docs/utils/protocolMeta/functions/validateProtocolMetaFormat.md

@@ -0,0 +1,21 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [utils/protocolMeta](../README.md) / validateProtocolMetaFormat
+
+# Function: validateProtocolMetaFormat()
+
+> **validateProtocolMetaFormat**(`input`): \{ `ok`: `true`; \} \| \{ `ok`: `false`; `reason`: `string`; \}
+
+Defined in: src/utils/protocolMeta.ts:74
+
+## Parameters
+
+### input
+
+`string`
+
+## Returns
+
+\{ `ok`: `true`; \} \| \{ `ok`: `false`; `reason`: `string`; \}

package/docs/utils/protocolMeta/interfaces/ProtocolMetaFields.md

@@ -0,0 +1,41 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [utils/protocolMeta](../README.md) / ProtocolMetaFields
+
+# Interface: ProtocolMetaFields
+
+Defined in: src/utils/protocolMeta.ts:4
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+Defined in: src/utils/protocolMeta.ts:6
+
+***
+
+### int
+
+> **int**: `string`
+
+Defined in: src/utils/protocolMeta.ts:7
+
+***
+
+### p?
+
+> `optional` **p**: `Record`\<`string`, `unknown`\>
+
+Defined in: src/utils/protocolMeta.ts:8
+
+***
+
+### ver
+
+> **ver**: `2`
+
+Defined in: src/utils/protocolMeta.ts:5

package/docs/utils/protocolMeta/variables/SCHEME.md

@@ -0,0 +1,11 @@
+[**@actioncodes/protocol-v2**](../../../README.md)
+
+***
+
+[@actioncodes/protocol-v2](../../../modules.md) / [utils/protocolMeta](../README.md) / SCHEME
+
+# Variable: SCHEME
+
+> `const` **SCHEME**: `"actioncodes:"` = `"actioncodes:"`
+
+Defined in: src/utils/protocolMeta.ts:11

package/package.json

@@ -1,31 +1,18 @@
 {
   "name": "@actioncodes/protocol",
-  "version": "1.2.1",
-  "description": "Action Codes Protocol",
+  "version": "2.0.0",
+  "module": "index.ts",
+  "type": "module",
+  "license": "Apache-2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "require": "./dist/index.js",
-      "import": "./dist/index.js"
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
     }
   },
-  "scripts": {
-    "build": "pnpm run lint && pnpm run test && pnpm run build:js",
-    "build:js": "tsc",
-    "lint": "eslint .",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "docs": "typedoc --out docs/ --entryPointStrategy expand --tsconfig ./tsconfig.json --plugin typedoc-plugin-markdown ./src",
-    "publish:package": "pnpm run lint && pnpm build && pnpm publish --access public",
-    "release": "pnpm run lint && pnpm version patch && pnpm build && pnpm publish --access public",
-    "release:patch": "pnpm run lint && pnpm version patch && pnpm build && pnpm publish --access public",
-    "release:minor": "pnpm run lint && pnpm version minor && pnpm build && pnpm publish --access public",
-    "release:major": "pnpm run lint && pnpm version major && pnpm build && pnpm publish --access public",
-    "publish:dry": "pnpm run lint && pnpm build && pnpm publish --access public --dry-run",
-    "prepare": "husky"
-  },
   "keywords": [
     "solana",
     "ota-protocol",
@@ -34,13 +21,10 @@
     "ota-protocol-types",
     "ota-protocol-constants"
   ],
-  "author": "OTA Protocol Core Team",
-  "license": "Apache-2.0",
-  "copyright": "Copyright 2025 OTA Protocol",
-  "homepage": "https://ota.codes",
+  "homepage": "https://actioncodes.org",
   "repository": {
     "type": "git",
-    "url": "https://github.com/otaprotocol/actioncodes"
+    "url": "https://github.com/otaprotocol/protocol-v2"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
@@ -55,38 +39,49 @@
     "README.md",
     "LICENSE"
   ],
-  "packageManager": "pnpm@10.13.1",
+  "scripts": {
+    "build": "bun lint && bun run test && bun run build:all",
+    "build:js": "bun run build.js",
+    "build:types": "tsc --project tsconfig.build.json",
+    "build:all": "bun run build:js && bun run build:types",
+    "lint": "eslint .",
+    "test": "bun test",
+    "docs": "typedoc --out docs/ --entryPointStrategy expand --tsconfig ./tsconfig.json --plugin typedoc-plugin-markdown ./src",
+    "publish:package": "bun lint && bun run build:all && bun publish --access public",
+    "release": "bun lint && bun version patch && bun run build:all && bun publish --access public",
+    "release:patch": "bun lint && bun version patch && bun run build:all && bun publish --access public",
+    "release:minor": "bun lint && bun version minor && bun run build:all && bun publish --access public",
+    "release:major": "bun lint && bun version major && bun run build:all && bun publish --access public",
+    "publish:dry": "bun lint && bun run build:all && bun publish --access public --dry-run",
+    "prepare": "husky"
+  },
   "devDependencies": {
-    "@commitlint/cli": "^19.8.1",
-    "@commitlint/config-conventional": "^19.8.1",
-    "@eslint/js": "^9.31.0",
+    "@commitlint/cli": "^20.0.0",
+    "@commitlint/config-conventional": "^20.0.0",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@semantic-release/github": "^11.0.3",
     "@semantic-release/npm": "^12.0.2",
+    "@types/bun": "latest",
     "@types/jest": "^30.0.0",
-    "@typescript-eslint/eslint-plugin": "^8.37.0",
-    "@typescript-eslint/parser": "^8.37.0",
-    "bs58": "^6.0.0",
-    "eslint": "^9.31.0",
-    "eslint-plugin-jest": "^29.0.1",
-    "globals": "^16.3.0",
+    "eslint": "^9.36.0",
+    "globals": "^16.4.0",
     "husky": "^9.1.7",
-    "jest": "^30.0.4",
-    "semantic-release": "^24.2.7",
-    "ts-jest": "^29.4.0",
-    "ts-node": "^10.9.2",
-    "typedoc-plugin-markdown": "^4.6.3",
-    "typescript": "^5.8.3",
-    "typescript-eslint": "^8.37.0"
-  },
-  "dependencies": {
-    "buffer": "^6.0.3",
-    "js-sha256": "^0.11.1"
+    "jest": "^30.2.0",
+    "ts-jest": "^29.4.4",
+    "typedoc": "^0.28.13",
+    "typedoc-plugin-markdown": "^4.9.0",
+    "typescript-eslint": "^8.45.0"
   },
   "peerDependencies": {
+    "@solana/web3.js": "^1.98.4",
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "@noble/hashes": "^2.0.1",
     "@solana/spl-memo": "^0.2.5",
-    "@solana/web3.js": "^1.98.2",
+    "bs58": "^6.0.0",
     "tweetnacl": "^1.0.3"
-  }
+  },
+  "packageManager": "pnpm@10.13.1"
 }

package/dist/actioncode.d.ts

@@ -1,120 +0,0 @@
-import { SUPPORTED_CHAINS } from "./constants";
-import { ActionCodesProtocol } from "./protocol";
-export type ActionCodeStatus = 'pending' | 'resolved' | 'finalized' | 'expired' | 'error';
-export interface ActionCodeMetadata {
-    description?: string;
-    params?: Record<string, any>;
-}
-export interface ActionCodeTransaction {
-    transaction?: string;
-    txSignature?: string;
-    txType?: string;
-    message?: string;
-    signedMessage?: string;
-    intentType?: 'transaction' | 'sign-only';
-}
-export interface ActionCodeFields {
-    code: string;
-    prefix: string;
-    pubkey: string;
-    timestamp: number;
-    signature: string;
-    chain: (typeof SUPPORTED_CHAINS)[number];
-    transaction?: ActionCodeTransaction;
-    metadata?: ActionCodeMetadata;
-    expiresAt: number;
-    status: ActionCodeStatus;
-}
-export declare class ActionCode {
-    private fields;
-    constructor(fields: ActionCodeFields);
-    static fromPayload(input: ActionCodeFields): ActionCode;
-    static fromEncoded(encoded: string): ActionCode;
-    get encoded(): string;
-    isValid(protocol: ActionCodesProtocol): boolean;
-    updateStatus(status: ActionCodeStatus): void;
-    get json(): ActionCodeFields;
-    /**
-     * Get remaining time in milliseconds until expiration
-     * @returns Remaining time in milliseconds, or 0 if expired
-     */
-    get remainingTime(): number;
-    /**
-     * Check if the action code has expired
-     * @returns True if the code has expired
-     */
-    get expired(): boolean;
-    /**
-     * Get the target chain for this action code
-     * @returns Chain identifier (e.g., "solana", "evm")
-     */
-    get chain(): string;
-    /**
-     * Get the current status of the action code
-     * @returns Current status
-     */
-    get status(): ActionCodeStatus;
-    /**
-     * Get the action code string
-     * @returns The 8-character action code
-     */
-    get code(): string;
-    /**
-     * Get the prefix used for this action code
-     * @returns Normalized prefix
-     */
-    get prefix(): string;
-    /**
-     * Get the user's public key
-     * @returns User's public key
-     */
-    get pubkey(): string;
-    /**
-     * Get the transaction data (chain-specific)
-     * @returns Transaction data or undefined
-     */
-    get transaction(): ActionCodeTransaction | undefined;
-    /**
-     * Get metadata associated with this action code
-     * @returns Metadata object or undefined
-     */
-    get metadata(): ActionCodeFields['metadata'] | undefined;
-    /**
-     * Get a human-readable description of the action
-     * @returns Description string or undefined
-     */
-    get description(): string | undefined;
-    /**
-     * Get parameters associated with this action
-     * @returns Parameters object or undefined
-     */
-    get params(): Record<string, any> | undefined;
-    /**
-     * Get the timestamp when the code was generated
-     * @returns Timestamp in milliseconds
-     */
-    get timestamp(): number;
-    /**
-     * Get the user's signature
-     * @returns User's signature string
-     */
-    get signature(): string;
-    /**
-     * Get a human-readable display string for the action code
-     * @returns Formatted display string
-     */
-    get displayString(): string;
-    /**
-     * Get a formatted time string showing remaining time
-     * @returns Human-readable time string (e.g., "1m 30s remaining")
-     */
-    get remainingTimeString(): string;
-    /**
-     * 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(): string;
-    get intentType(): 'transaction' | 'sign-only';
-}
-//# sourceMappingURL=actioncode.d.ts.map

package/dist/actioncode.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"actioncode.d.ts","sourceRoot":"","sources":["../src/actioncode.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAGjD,MAAM,MAAM,gBAAgB,GAAG,SAAS,GAAG,UAAU,GAAG,WAAW,GAAG,SAAS,GAAG,OAAO,CAAC;AAE1F,MAAM,WAAW,kBAAkB;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAChC;AAED,MAAM,WAAW,qBAAqB;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,aAAa,GAAG,WAAW,CAAC;CAC5C;AAED,MAAM,WAAW,gBAAgB;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;IACzC,WAAW,CAAC,EAAE,qBAAqB,CAAC;IACpC,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,gBAAgB,CAAC;CAC5B;AAED,qBAAa,UAAU;IACP,OAAO,CAAC,MAAM;gBAAN,MAAM,EAAE,gBAAgB;IAE5C,MAAM,CAAC,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,UAAU;IAOvD,MAAM,CAAC,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU;IAK/C,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED,OAAO,CAAC,QAAQ,EAAE,mBAAmB,GAAG,OAAO;IAiB/C,YAAY,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI;IAI5C,IAAI,IAAI,IAAI,gBAAgB,CAE3B;IAID;;;OAGG;IACH,IAAI,aAAa,IAAI,MAAM,CAG1B;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;;OAGG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,gBAAgB,CAE7B;IAED;;;OAGG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,qBAAqB,GAAG,SAAS,CAEnD;IAED;;;OAGG;IACH,IAAI,QAAQ,IAAI,gBAAgB,CAAC,UAAU,CAAC,GAAG,SAAS,CAEvD;IAED;;;OAGG;IACH,IAAI,WAAW,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED;;;OAGG;IACH,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,CAE5C;IAED;;;OAGG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;;OAGG;IACH,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;;OAGG;IACH,IAAI,aAAa,IAAI,MAAM,CAO1B;IAED;;;OAGG;IACH,IAAI,mBAAmB,IAAI,MAAM,CAchC;IAED;;;;OAIG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED,IAAI,UAAU,IAAI,aAAa,GAAG,WAAW,CAE5C;CACJ"}