@actioncodes/protocol 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +55 -0
  3. package/dist/actioncode.d.ts +114 -0
  4. package/dist/actioncode.d.ts.map +1 -0
  5. package/dist/actioncode.js +159 -0
  6. package/dist/adapters/base.d.ts +52 -0
  7. package/dist/adapters/base.d.ts.map +1 -0
  8. package/dist/adapters/base.js +41 -0
  9. package/dist/adapters/solana/index.d.ts +2 -0
  10. package/dist/adapters/solana/index.d.ts.map +1 -0
  11. package/dist/adapters/solana/index.js +17 -0
  12. package/dist/adapters/solana/solana.d.ts +84 -0
  13. package/dist/adapters/solana/solana.d.ts.map +1 -0
  14. package/dist/adapters/solana/solana.js +223 -0
  15. package/dist/codegen.d.ts +73 -0
  16. package/dist/codegen.d.ts.map +1 -0
  17. package/dist/codegen.js +118 -0
  18. package/dist/constants.d.ts +10 -0
  19. package/dist/constants.d.ts.map +1 -0
  20. package/dist/constants.js +11 -0
  21. package/dist/index.d.ts +9 -0
  22. package/dist/index.d.ts.map +1 -0
  23. package/dist/index.js +23 -0
  24. package/dist/meta.d.ts +54 -0
  25. package/dist/meta.d.ts.map +1 -0
  26. package/dist/meta.js +91 -0
  27. package/dist/protocol.d.ts +167 -0
  28. package/dist/protocol.d.ts.map +1 -0
  29. package/dist/protocol.js +280 -0
  30. package/docs/README.md +59 -0
  31. package/docs/_media/LICENSE +201 -0
  32. package/docs/_media/README.md +28 -0
  33. package/docs/actioncode/README.md +21 -0
  34. package/docs/actioncode/classes/ActionCode.md +412 -0
  35. package/docs/actioncode/interfaces/ActionCodeFields.md +95 -0
  36. package/docs/actioncode/interfaces/ActionCodeMetadata.md +25 -0
  37. package/docs/actioncode/interfaces/ActionCodeTransaction.md +39 -0
  38. package/docs/actioncode/type-aliases/ActionCodeStatus.md +11 -0
  39. package/docs/adapters/base/README.md +11 -0
  40. package/docs/adapters/base/classes/BaseChainAdapter.md +222 -0
  41. package/docs/adapters/solana/README.md +19 -0
  42. package/docs/adapters/solana/solana/README.md +15 -0
  43. package/docs/adapters/solana/solana/classes/SolanaAdapter.md +306 -0
  44. package/docs/adapters/solana/solana/type-aliases/SolanaTransaction.md +13 -0
  45. package/docs/codegen/README.md +11 -0
  46. package/docs/codegen/classes/CodeGenerator.md +337 -0
  47. package/docs/constants/README.md +22 -0
  48. package/docs/constants/type-aliases/SupportedChain.md +11 -0
  49. package/docs/constants/variables/CODE_LENGTH.md +11 -0
  50. package/docs/constants/variables/CODE_TTL.md +11 -0
  51. package/docs/constants/variables/MAX_PREFIX_LENGTH.md +11 -0
  52. package/docs/constants/variables/MIN_PREFIX_LENGTH.md +11 -0
  53. package/docs/constants/variables/PROTOCOL_CODE_PREFIX.md +11 -0
  54. package/docs/constants/variables/PROTOCOL_PREFIX.md +11 -0
  55. package/docs/constants/variables/PROTOCOL_VERSION.md +11 -0
  56. package/docs/constants/variables/SUPPORTED_CHAINS.md +11 -0
  57. package/docs/index/README.md +139 -0
  58. package/docs/meta/README.md +15 -0
  59. package/docs/meta/classes/ProtocolMetaParser.md +177 -0
  60. package/docs/meta/interfaces/ProtocolMetaV1.md +59 -0
  61. package/docs/modules.md +17 -0
  62. package/docs/protocol/README.md +51 -0
  63. package/docs/protocol/classes/ActionCodesProtocol.md +616 -0
  64. package/docs/protocol/interfaces/ProtocolConfig.md +71 -0
  65. package/package.json +90 -0
package/package.json ADDED
@@ -0,0 +1,90 @@
1
+ {
2
+ "name": "@actioncodes/protocol",
3
+ "version": "1.0.0",
4
+ "description": "Action Codes Protocol",
5
+ "main": "src/index.js",
6
+ "types": "dist/index.d.ts",
7
+ "exports": {
8
+ ".": {
9
+ "types": "./dist/index.d.ts",
10
+ "import": "./dist/index.js"
11
+ }
12
+ },
13
+ "scripts": {
14
+ "build": "pnpm run lint && pnpm run test && pnpm run build:js",
15
+ "build:js": "tsc",
16
+ "lint": "eslint .",
17
+ "test": "jest",
18
+ "test:watch": "jest --watch",
19
+ "docs": "typedoc --out docs/ --entryPointStrategy expand --tsconfig ./tsconfig.json --plugin typedoc-plugin-markdown ./src",
20
+ "publish:package": "pnpm run lint && pnpm build && pnpm publish --access public",
21
+ "release": "pnpm run lint && pnpm version patch && pnpm build && pnpm publish --access public",
22
+ "release:patch": "pnpm run lint && pnpm version patch && pnpm build && pnpm publish --access public",
23
+ "release:minor": "pnpm run lint && pnpm version minor && pnpm build && pnpm publish --access public",
24
+ "release:major": "pnpm run lint && pnpm version major && pnpm build && pnpm publish --access public",
25
+ "publish:dry": "pnpm run lint && pnpm build && pnpm publish --access public --dry-run",
26
+ "prepare": "husky"
27
+ },
28
+ "keywords": [
29
+ "solana",
30
+ "ota-protocol",
31
+ "ota-protocol-sdk",
32
+ "ota-protocol-utils",
33
+ "ota-protocol-types",
34
+ "ota-protocol-constants"
35
+ ],
36
+ "author": "OTA Protocol Core Team",
37
+ "license": "Apache-2.0",
38
+ "copyright": "Copyright 2025 OTA Protocol",
39
+ "homepage": "https://ota.codes",
40
+ "repository": {
41
+ "type": "git",
42
+ "url": "https://github.com/otaprotocol/actioncodes"
43
+ },
44
+ "publishConfig": {
45
+ "registry": "https://registry.npmjs.org/",
46
+ "tag": "latest",
47
+ "access": "public"
48
+ },
49
+ "files": [
50
+ "docs",
51
+ "dist",
52
+ "package.json",
53
+ "CHANGELOG.md",
54
+ "README.md",
55
+ "LICENSE"
56
+ ],
57
+ "packageManager": "pnpm@10.13.1",
58
+ "devDependencies": {
59
+ "@commitlint/cli": "^19.8.1",
60
+ "@commitlint/config-conventional": "^19.8.1",
61
+ "@eslint/js": "^9.31.0",
62
+ "@semantic-release/changelog": "^6.0.3",
63
+ "@semantic-release/git": "^10.0.1",
64
+ "@semantic-release/github": "^11.0.3",
65
+ "@semantic-release/npm": "^12.0.2",
66
+ "@types/jest": "^30.0.0",
67
+ "@typescript-eslint/eslint-plugin": "^8.37.0",
68
+ "@typescript-eslint/parser": "^8.37.0",
69
+ "bs58": "^6.0.0",
70
+ "eslint": "^9.31.0",
71
+ "eslint-plugin-jest": "^29.0.1",
72
+ "globals": "^16.3.0",
73
+ "husky": "^9.1.7",
74
+ "jest": "^30.0.4",
75
+ "semantic-release": "^24.2.7",
76
+ "ts-jest": "^29.4.0",
77
+ "ts-node": "^10.9.2",
78
+ "typedoc-plugin-markdown": "^4.6.3",
79
+ "typescript": "^5.8.3",
80
+ "typescript-eslint": "^8.37.0"
81
+ },
82
+ "dependencies": {
83
+ "js-sha256": "^0.11.1"
84
+ },
85
+ "peerDependencies": {
86
+ "@solana/spl-memo": "^0.2.5",
87
+ "@solana/web3.js": "^1.98.2",
88
+ "tweetnacl": "^1.0.3"
89
+ }
90
+ }