@actioncodes/protocol 1.0.0

package/docs/_media/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/docs/_media/README.md

@@ -0,0 +1,28 @@
+# Action Codes Protocol (Formerly OTA Protocol)
+
+Action Codes enables short-lived, verifiable action codes to authorize blockchain transactions and intents.
+
+This document contains the official Action Codes specifications under AIPs (Action Codes Improvement Proposal) in multiple languages.
+
+## Available Languages
+
+- [English](./en/aips/aip-0.md)
+- More languages coming soon...
+
+## Specifications
+
+- [AIP-0: One-Time Action Code Architecture](./en/aips/aip-0.md)
+- [AIP-1: Protocol Meta Format](./en/aips/aip-1.md)
+- [AIP-2: Authority Signature Validation](./en/aips/aip-2.md)
+- [AIP-3: Intent Resolution & Routing](./en/aips/aip-3.md)
+- [AIP-4: Prefix System](./en/aips/aip-4.md)
+
+---
+
+## Links
+
+- [Docs and SDK](https://ota.codes/protocol)
+- [One-time Code Generator](https://app.ota.codes)
+- [Protocol Authority](https://relay.ota.codes/.well-known/authorities)
+
+---

package/docs/actioncode/README.md

@@ -0,0 +1,21 @@
+[**@actioncodes/protocol**](../README.md)
+
+***
+
+[@actioncodes/protocol](../modules.md) / actioncode
+
+# actioncode
+
+## Classes
+
+- [ActionCode](classes/ActionCode.md)
+
+## Interfaces
+
+- [ActionCodeFields](interfaces/ActionCodeFields.md)
+- [ActionCodeMetadata](interfaces/ActionCodeMetadata.md)
+- [ActionCodeTransaction](interfaces/ActionCodeTransaction.md)
+
+## Type Aliases
+
+- [ActionCodeStatus](type-aliases/ActionCodeStatus.md)

package/docs/actioncode/classes/ActionCode.md

@@ -0,0 +1,412 @@
+[**@actioncodes/protocol**](../../README.md)
+
+***
+
+[@actioncodes/protocol](../../modules.md) / [actioncode](../README.md) / ActionCode
+
+# Class: ActionCode\<T\>
+
+Defined in: [actioncode.ts:30](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L30)
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Constructors
+
+### Constructor
+
+> **new ActionCode**\<`T`\>(`fields`): `ActionCode`\<`T`\>
+
+Defined in: [actioncode.ts:31](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L31)
+
+#### Parameters
+
+##### fields
+
+[`ActionCodeFields`](../interfaces/ActionCodeFields.md)\<`T`\>
+
+#### Returns
+
+`ActionCode`\<`T`\>
+
+## Accessors
+
+### chain
+
+#### Get Signature
+
+> **get** **chain**(): `string`
+
+Defined in: [actioncode.ts:86](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L86)
+
+Get the target chain for this action code
+
+##### Returns
+
+`string`
+
+Chain identifier (e.g., "solana", "evm")
+
+***
+
+### code
+
+#### Get Signature
+
+> **get** **code**(): `string`
+
+Defined in: [actioncode.ts:102](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L102)
+
+Get the action code string
+
+##### Returns
+
+`string`
+
+The 8-character action code
+
+***
+
+### codeHash
+
+#### Get Signature
+
+> **get** **codeHash**(): `string`
+
+Defined in: [actioncode.ts:208](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L208)
+
+Get the code hash for this action code
+it is also used in the protocol meta as the code id
+
+##### Returns
+
+`string`
+
+Code hash string
+
+***
+
+### description
+
+#### Get Signature
+
+> **get** **description**(): `undefined` \| `string`
+
+Defined in: [actioncode.ts:142](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L142)
+
+Get a human-readable description of the action
+
+##### Returns
+
+`undefined` \| `string`
+
+Description string or undefined
+
+***
+
+### displayString
+
+#### Get Signature
+
+> **get** **displayString**(): `string`
+
+Defined in: [actioncode.ts:174](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L174)
+
+Get a human-readable display string for the action code
+
+##### Returns
+
+`string`
+
+Formatted display string
+
+***
+
+### encoded
+
+#### Get Signature
+
+> **get** **encoded**(): `string`
+
+Defined in: [actioncode.ts:45](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L45)
+
+##### Returns
+
+`string`
+
+***
+
+### expired
+
+#### Get Signature
+
+> **get** **expired**(): `boolean`
+
+Defined in: [actioncode.ts:78](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L78)
+
+Check if the action code has expired
+
+##### Returns
+
+`boolean`
+
+True if the code has expired
+
+***
+
+### isValid
+
+#### Get Signature
+
+> **get** **isValid**(): `boolean`
+
+Defined in: [actioncode.ts:49](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L49)
+
+##### Returns
+
+`boolean`
+
+***
+
+### json
+
+#### Get Signature
+
+> **get** **json**(): [`ActionCodeFields`](../interfaces/ActionCodeFields.md)\<`T`\>
+
+Defined in: [actioncode.ts:59](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L59)
+
+##### Returns
+
+[`ActionCodeFields`](../interfaces/ActionCodeFields.md)\<`T`\>
+
+***
+
+### metadata
+
+#### Get Signature
+
+> **get** **metadata**(): `undefined` \| [`ActionCodeMetadata`](../interfaces/ActionCodeMetadata.md)
+
+Defined in: [actioncode.ts:134](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L134)
+
+Get metadata associated with this action code
+
+##### Returns
+
+`undefined` \| [`ActionCodeMetadata`](../interfaces/ActionCodeMetadata.md)
+
+Metadata object or undefined
+
+***
+
+### params
+
+#### Get Signature
+
+> **get** **params**(): `undefined` \| `Record`\<`string`, `any`\>
+
+Defined in: [actioncode.ts:150](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L150)
+
+Get parameters associated with this action
+
+##### Returns
+
+`undefined` \| `Record`\<`string`, `any`\>
+
+Parameters object or undefined
+
+***
+
+### prefix
+
+#### Get Signature
+
+> **get** **prefix**(): `string`
+
+Defined in: [actioncode.ts:110](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L110)
+
+Get the prefix used for this action code
+
+##### Returns
+
+`string`
+
+Normalized prefix
+
+***
+
+### pubkey
+
+#### Get Signature
+
+> **get** **pubkey**(): `string`
+
+Defined in: [actioncode.ts:118](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L118)
+
+Get the user's public key
+
+##### Returns
+
+`string`
+
+User's public key
+
+***
+
+### remainingTime
+
+#### Get Signature
+
+> **get** **remainingTime**(): `number`
+
+Defined in: [actioncode.ts:69](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L69)
+
+Get remaining time in milliseconds until expiration
+
+##### Returns
+
+`number`
+
+Remaining time in milliseconds, or 0 if expired
+
+***
+
+### remainingTimeString
+
+#### Get Signature
+
+> **get** **remainingTimeString**(): `string`
+
+Defined in: [actioncode.ts:187](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L187)
+
+Get a formatted time string showing remaining time
+
+##### Returns
+
+`string`
+
+Human-readable time string (e.g., "1m 30s remaining")
+
+***
+
+### signature
+
+#### Get Signature
+
+> **get** **signature**(): `string`
+
+Defined in: [actioncode.ts:166](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L166)
+
+Get the user's signature
+
+##### Returns
+
+`string`
+
+User's signature string
+
+***
+
+### status
+
+#### Get Signature
+
+> **get** **status**(): [`ActionCodeStatus`](../type-aliases/ActionCodeStatus.md)
+
+Defined in: [actioncode.ts:94](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L94)
+
+Get the current status of the action code
+
+##### Returns
+
+[`ActionCodeStatus`](../type-aliases/ActionCodeStatus.md)
+
+Current status
+
+***
+
+### timestamp
+
+#### Get Signature
+
+> **get** **timestamp**(): `number`
+
+Defined in: [actioncode.ts:158](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L158)
+
+Get the timestamp when the code was generated
+
+##### Returns
+
+`number`
+
+Timestamp in milliseconds
+
+***
+
+### transaction
+
+#### Get Signature
+
+> **get** **transaction**(): `undefined` \| [`ActionCodeTransaction`](../interfaces/ActionCodeTransaction.md)\<`T`\>
+
+Defined in: [actioncode.ts:126](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L126)
+
+Get the transaction data (chain-specific)
+
+##### Returns
+
+`undefined` \| [`ActionCodeTransaction`](../interfaces/ActionCodeTransaction.md)\<`T`\>
+
+Transaction data or undefined
+
+## Methods
+
+### fromEncoded()
+
+> `static` **fromEncoded**\<`T`\>(`encoded`): `ActionCode`\<`T`\>
+
+Defined in: [actioncode.ts:40](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L40)
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### encoded
+
+`string`
+
+#### Returns
+
+`ActionCode`\<`T`\>
+
+***
+
+### fromPayload()
+
+> `static` **fromPayload**\<`T`\>(`input`): `ActionCode`\<`T`\>
+
+Defined in: [actioncode.ts:33](https://github.com/otaprotocol/actioncodes/blob/b4bc06f6d42b5f06660c6f068ac123b4cd9daff7/src/actioncode.ts#L33)
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### input
+
+[`ActionCodeFields`](../interfaces/ActionCodeFields.md)\<`T`\>
+
+#### Returns
+
+`ActionCode`\<`T`\>