@actioncodes/protocol 2.0.22 → 2.0.24

package/docs/utils/canonical/variables/CANONICAL_REVOKE_MESSAGE_PREFIX.md

@@ -0,0 +1,11 @@
+[**@actioncodes/protocol**](../../../README.md)
+
+***
+
+[@actioncodes/protocol](../../../modules.md) / [utils/canonical](../README.md) / CANONICAL\_REVOKE\_MESSAGE\_PREFIX
+
+# Variable: CANONICAL\_REVOKE\_MESSAGE\_PREFIX
+
+> `const` **CANONICAL\_REVOKE\_MESSAGE\_PREFIX**: `"actioncodes-revoke"` = `"actioncodes-revoke"`
+
+Defined in: src/utils/canonical.ts:10

package/docs/utils/crypto/README.md

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../../README.md)
+[**@actioncodes/protocol**](../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../modules.md) / utils/crypto
+[@actioncodes/protocol](../../modules.md) / utils/crypto
 
 # utils/crypto
 
@@ -11,7 +11,6 @@
 - [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)

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

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../../../README.md)
+[**@actioncodes/protocol**](../../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../../modules.md) / [utils/crypto](../README.md) / base32EncodeCrockford
+[@actioncodes/protocol](../../../modules.md) / [utils/crypto](../README.md) / base32EncodeCrockford
 
 # Function: base32EncodeCrockford()
 

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

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../../../README.md)
+[**@actioncodes/protocol**](../../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../../modules.md) / [utils/crypto](../README.md) / codeHash
+[@actioncodes/protocol](../../../modules.md) / [utils/crypto](../README.md) / codeHash
 
 # Function: codeHash()
 

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

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../../../README.md)
+[**@actioncodes/protocol**](../../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../../modules.md) / [utils/crypto](../README.md) / digestToDigits
+[@actioncodes/protocol](../../../modules.md) / [utils/crypto](../README.md) / digestToDigits
 
 # Function: digestToDigits()
 

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

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../../../README.md)
+[**@actioncodes/protocol**](../../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../../modules.md) / [utils/crypto](../README.md) / hkdfSha256
+[@actioncodes/protocol](../../../modules.md) / [utils/crypto](../README.md) / hkdfSha256
 
 # Function: hkdfSha256()
 

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

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../../../README.md)
+[**@actioncodes/protocol**](../../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../../modules.md) / [utils/crypto](../README.md) / hmacSha256
+[@actioncodes/protocol](../../../modules.md) / [utils/crypto](../README.md) / hmacSha256
 
 # Function: hmacSha256()
 

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

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../../../README.md)
+[**@actioncodes/protocol**](../../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../../modules.md) / [utils/crypto](../README.md) / sha256
+[@actioncodes/protocol](../../../modules.md) / [utils/crypto](../README.md) / sha256
 
 # Function: sha256()
 

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

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../../../README.md)
+[**@actioncodes/protocol**](../../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../../modules.md) / [utils/crypto](../README.md) / truncateBits
+[@actioncodes/protocol](../../../modules.md) / [utils/crypto](../README.md) / truncateBits
 
 # Function: truncateBits()
 

package/docs/utils/protocolMeta/README.md

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../../README.md)
+[**@actioncodes/protocol**](../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../modules.md) / utils/protocolMeta
+[@actioncodes/protocol](../../modules.md) / utils/protocolMeta
 
 # utils/protocolMeta
 

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

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

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

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

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

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

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

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../../../README.md)
+[**@actioncodes/protocol**](../../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../../modules.md) / [utils/protocolMeta](../README.md) / ProtocolMetaFields
+[@actioncodes/protocol](../../../modules.md) / [utils/protocolMeta](../README.md) / ProtocolMetaFields
 
 # Interface: ProtocolMetaFields
 
@@ -26,11 +26,19 @@ Defined in: src/utils/protocolMeta.ts:7
 
 ***
 
+### iss?
+
+> `optional` **iss**: `string`
+
+Defined in: src/utils/protocolMeta.ts:8
+
+***
+
 ### p?
 
 > `optional` **p**: `Record`\<`string`, `unknown`\>
 
-Defined in: src/utils/protocolMeta.ts:8
+Defined in: src/utils/protocolMeta.ts:9
 
 ***
 

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@actioncodes/protocol",
-  "version": "2.0.22",
+  "version": "2.0.24",
   "module": "index.ts",
   "type": "module",
   "license": "Apache-2.0",
@@ -15,16 +15,16 @@
   },
   "keywords": [
     "solana",
-    "ota-protocol",
-    "ota-protocol-sdk",
-    "ota-protocol-utils",
-    "ota-protocol-types",
-    "ota-protocol-constants"
+    "actioncodes protocol",
+    "actioncodes protocol sdk",
+    "actioncodes protocol utils",
+    "actioncodes protocol types",
+    "actioncodes protocol constants"
   ],
   "homepage": "https://actioncodes.org",
   "repository": {
     "type": "git",
-    "url": "https://github.com/otaprotocol/protocol-v2"
+    "url": "https://github.com/actioncodesorg/protocol-v2"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",

package/docs/adapters/BaseChainAdapter/interfaces/BaseContext.md

@@ -1,17 +0,0 @@
-[**@actioncodes/protocol-v2**](../../../README.md)
-
-***
-
-[@actioncodes/protocol-v2](../../../modules.md) / [adapters/BaseChainAdapter](../README.md) / BaseContext
-
-# Interface: BaseContext
-
-Defined in: src/adapters/BaseChainAdapter.ts:4
-
-## Properties
-
-### canonicalMessageParts
-
-> **canonicalMessageParts**: [`CanonicalMessageParts`](../../../types/interfaces/CanonicalMessageParts.md)
-
-Defined in: src/adapters/BaseChainAdapter.ts:6

package/docs/adapters/BaseChainAdapter/type-aliases/ChainContext.md

@@ -1,23 +0,0 @@
-[**@actioncodes/protocol-v2**](../../../README.md)
-
-***
-
-[@actioncodes/protocol-v2](../../../modules.md) / [adapters/BaseChainAdapter](../README.md) / ChainContext
-
-# Type Alias: ChainContext\<T\>
-
-> **ChainContext**\<`T`\> = [`BaseContext`](../interfaces/BaseContext.md) & `object` & `T`
-
-Defined in: src/adapters/BaseChainAdapter.ts:8
-
-## Type Declaration
-
-### chain
-
-> **chain**: `string`
-
-## Type Parameters
-
-### T
-
-`T`

package/docs/adapters/NodeCryptoAdapter/README.md

@@ -1,15 +0,0 @@
-[**@actioncodes/protocol-v2**](../../README.md)
-
-***
-
-[@actioncodes/protocol-v2](../../modules.md) / adapters/NodeCryptoAdapter
-
-# adapters/NodeCryptoAdapter
-
-## Classes
-
-- [NodeCryptoAdapter](classes/NodeCryptoAdapter.md)
-
-## Type Aliases
-
-- [NodeCryptoContext](type-aliases/NodeCryptoContext.md)

package/docs/adapters/NodeCryptoAdapter/classes/NodeCryptoAdapter.md

@@ -1,254 +0,0 @@
-[**@actioncodes/protocol-v2**](../../../README.md)
-
-***
-
-[@actioncodes/protocol-v2](../../../modules.md) / [adapters/NodeCryptoAdapter](../README.md) / NodeCryptoAdapter
-
-# Class: NodeCryptoAdapter
-
-Defined in: src/adapters/NodeCryptoAdapter.ts:20
-
-## Extends
-
-- [`BaseChainAdapter`](../../BaseChainAdapter/classes/BaseChainAdapter.md)\<[`NodeCryptoContext`](../type-aliases/NodeCryptoContext.md)\>
-
-## Constructors
-
-### Constructor
-
-> **new NodeCryptoAdapter**(): `NodeCryptoAdapter`
-
-#### Returns
-
-`NodeCryptoAdapter`
-
-#### Inherited from
-
-[`BaseChainAdapter`](../../BaseChainAdapter/classes/BaseChainAdapter.md).[`constructor`](../../BaseChainAdapter/classes/BaseChainAdapter.md#constructor)
-
-## Methods
-
-### getProtocolMeta()
-
-> **getProtocolMeta**(`tx`): `null` \| `string`
-
-Defined in: src/adapters/NodeCryptoAdapter.ts:57
-
-Extract protocol metadata from a simulated transaction
-
-#### Parameters
-
-##### tx
-
-###### instructions?
-
-`object`[]
-
-#### Returns
-
-`null` \| `string`
-
-***
-
-### parseMeta()
-
-> **parseMeta**(`tx`): `null` \| [`ProtocolMetaFields`](../../../utils/protocolMeta/interfaces/ProtocolMetaFields.md)
-
-Defined in: src/adapters/NodeCryptoAdapter.ts:74
-
-Get parsed ProtocolMeta object, or null if none or invalid
-
-#### Parameters
-
-##### tx
-
-###### instructions?
-
-`object`[]
-
-#### Returns
-
-`null` \| [`ProtocolMetaFields`](../../../utils/protocolMeta/interfaces/ProtocolMetaFields.md)
-
-***
-
-### verify()
-
-> **verify**(`context`): `boolean`
-
-Defined in: src/adapters/NodeCryptoAdapter.ts:22
-
-Verify the signature over canonical message using Node.js crypto
-
-#### Parameters
-
-##### context
-
-[`ChainContext`](../../BaseChainAdapter/type-aliases/ChainContext.md)\<[`NodeCryptoContext`](../type-aliases/NodeCryptoContext.md)\>
-
-#### Returns
-
-`boolean`
-
-#### Overrides
-
-[`BaseChainAdapter`](../../BaseChainAdapter/classes/BaseChainAdapter.md).[`verify`](../../BaseChainAdapter/classes/BaseChainAdapter.md#verify)
-
-***
-
-### verifyTransactionMatchesCode()
-
-> **verifyTransactionMatchesCode**(`actionCode`, `tx`): `void`
-
-Defined in: src/adapters/NodeCryptoAdapter.ts:84
-
-Validate that a transaction's meta aligns with the bound `actionCode`.
-Throws ProtocolError if validation fails.
-
-#### Parameters
-
-##### actionCode
-
-[`ActionCode`](../../../types/interfaces/ActionCode.md)
-
-##### tx
-
-###### instructions?
-
-`object`[]
-
-#### Returns
-
-`void`
-
-***
-
-### verifyTransactionSignedByIntentOwner()
-
-> **verifyTransactionSignedByIntentOwner**(`tx`): `void`
-
-Defined in: src/adapters/NodeCryptoAdapter.ts:125
-
-Verify that the transaction is signed by the "intendedFor" pubkey
-as declared in the protocol meta of the transaction.
-Throws ProtocolError if validation fails.
-
-#### Parameters
-
-##### tx
-
-###### instructions?
-
-`object`[]
-
-###### signatures?
-
-`object`[]
-
-#### Returns
-
-`void`
-
-***
-
-### attachProtocolMeta()
-
-> `static` **attachProtocolMeta**(`tx`, `meta`): `object`
-
-Defined in: src/adapters/NodeCryptoAdapter.ts:159
-
-Attach protocol meta to a simulated transaction.
-
-#### Parameters
-
-##### tx
-
-###### instructions?
-
-`object`[]
-
-##### meta
-
-[`ProtocolMetaFields`](../../../utils/protocolMeta/interfaces/ProtocolMetaFields.md)
-
-#### Returns
-
-`object`
-
-##### instructions
-
-> **instructions**: `object`[]
-
-***
-
-### createProtocolMetaInstruction()
-
-> `static` **createProtocolMetaInstruction**(`meta`): `object`
-
-Defined in: src/adapters/NodeCryptoAdapter.ts:46
-
-Create a protocol meta instruction for NodeCrypto (simulated)
-
-#### Parameters
-
-##### meta
-
-[`ProtocolMetaFields`](../../../utils/protocolMeta/interfaces/ProtocolMetaFields.md)
-
-#### Returns
-
-`object`
-
-##### data
-
-> **data**: `string`
-
-##### type
-
-> **type**: `string`
-
-***
-
-### generateKeyPair()
-
-> `static` **generateKeyPair**(): `object`
-
-Defined in: src/adapters/NodeCryptoAdapter.ts:185
-
-Generate a key pair for testing
-
-#### Returns
-
-`object`
-
-##### privateKey
-
-> **privateKey**: `KeyObject`
-
-##### publicKey
-
-> **publicKey**: `KeyObject`
-
-***
-
-### signMessage()
-
-> `static` **signMessage**(`message`, `privateKey`): `string`
-
-Defined in: src/adapters/NodeCryptoAdapter.ts:173
-
-Sign a message with a private key
-
-#### Parameters
-
-##### message
-
-`Uint8Array`
-
-##### privateKey
-
-`KeyObject`
-
-#### Returns
-
-`string`

package/docs/adapters/NodeCryptoAdapter/type-aliases/NodeCryptoContext.md

@@ -1,27 +0,0 @@
-[**@actioncodes/protocol-v2**](../../../README.md)
-
-***
-
-[@actioncodes/protocol-v2](../../../modules.md) / [adapters/NodeCryptoAdapter](../README.md) / NodeCryptoContext
-
-# Type Alias: NodeCryptoContext
-
-> **NodeCryptoContext** = `object`
-
-Defined in: src/adapters/NodeCryptoAdapter.ts:15
-
-## Properties
-
-### pubkey
-
-> **pubkey**: `string`
-
-Defined in: src/adapters/NodeCryptoAdapter.ts:16
-
-***
-
-### signature
-
-> **signature**: `string`
-
-Defined in: src/adapters/NodeCryptoAdapter.ts:17

package/docs/adapters/SolanaAdapter/type-aliases/SolanaContext.md

@@ -1,27 +0,0 @@
-[**@actioncodes/protocol-v2**](../../../README.md)
-
-***
-
-[@actioncodes/protocol-v2](../../../modules.md) / [adapters/SolanaAdapter](../README.md) / SolanaContext
-
-# Type Alias: SolanaContext
-
-> **SolanaContext** = `object`
-
-Defined in: src/adapters/SolanaAdapter.ts:22
-
-## Properties
-
-### pubkey
-
-> **pubkey**: `string` \| `PublicKey`
-
-Defined in: src/adapters/SolanaAdapter.ts:23
-
-***
-
-### signature
-
-> **signature**: `string`
-
-Defined in: src/adapters/SolanaAdapter.ts:24

package/docs/types/interfaces/CodeGenerationResult.md

@@ -1,25 +0,0 @@
-[**@actioncodes/protocol-v2**](../../README.md)
-
-***
-
-[@actioncodes/protocol-v2](../../modules.md) / [types](../README.md) / CodeGenerationResult
-
-# Interface: CodeGenerationResult
-
-Defined in: src/types.ts:25
-
-## Properties
-
-### actionCode
-
-> **actionCode**: [`ActionCode`](ActionCode.md)
-
-Defined in: src/types.ts:26
-
-***
-
-### canonicalMessage
-
-> **canonicalMessage**: `Uint8Array`
-
-Defined in: src/types.ts:27

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

@@ -1,15 +0,0 @@
-[**@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`