@actioncodes/protocol 2.0.22 → 2.0.24

package/docs/types/interfaces/ActionCode.md

@@ -1,60 +1,57 @@
-[**@actioncodes/protocol-v2**](../../README.md)
+[**@actioncodes/protocol**](../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../modules.md) / [types](../README.md) / ActionCode
+[@actioncodes/protocol](../../modules.md) / [types](../README.md) / ActionCode
 
 # Interface: ActionCode
 
-Defined in: src/types.ts:1
-
-## Properties
-
-### code
+Defined in: src/types.ts:5
 
-> **code**: `string`
+## Extended by
 
-Defined in: src/types.ts:2
+- [`DelegatedActionCode`](DelegatedActionCode.md)
+- [`ActionCodeRevoke`](ActionCodeRevoke.md)
 
-***
+## Properties
 
-### expiresAt
+### chain
 
-> **expiresAt**: `number`
+> **chain**: `"solana"`
 
-Defined in: src/types.ts:5
+Defined in: src/types.ts:6
 
 ***
 
-### pubkey
+### code
 
-> **pubkey**: `string`
+> **code**: `string`
 
-Defined in: src/types.ts:3
+Defined in: src/types.ts:7
 
 ***
 
-### secret?
+### expiresAt
 
-> `optional` **secret**: `string`
+> **expiresAt**: `number`
 
-Defined in: src/types.ts:9
+Defined in: src/types.ts:10
 
 ***
 
-### secretHint?
+### pubkey
 
-> `optional` **secretHint**: `string`
+> **pubkey**: `string`
 
-Defined in: src/types.ts:7
+Defined in: src/types.ts:8
 
 ***
 
-### signature?
+### signature
 
-> `optional` **signature**: `string`
+> **signature**: `string`
 
-Defined in: src/types.ts:6
+Defined in: src/types.ts:11
 
 ***
 
@@ -62,4 +59,4 @@ Defined in: src/types.ts:6
 
 > **timestamp**: `number`
 
-Defined in: src/types.ts:4
+Defined in: src/types.ts:9

package/docs/types/interfaces/ActionCodeRevoke.md

@@ -0,0 +1,93 @@
+[**@actioncodes/protocol**](../../README.md)
+
+***
+
+[@actioncodes/protocol](../../modules.md) / [types](../README.md) / ActionCodeRevoke
+
+# Interface: ActionCodeRevoke
+
+Defined in: src/types.ts:43
+
+## Extends
+
+- [`ActionCode`](ActionCode.md)
+
+## Properties
+
+### chain
+
+> **chain**: `"solana"`
+
+Defined in: src/types.ts:6
+
+#### Inherited from
+
+[`ActionCode`](ActionCode.md).[`chain`](ActionCode.md#chain)
+
+***
+
+### code
+
+> **code**: `string`
+
+Defined in: src/types.ts:7
+
+#### Inherited from
+
+[`ActionCode`](ActionCode.md).[`code`](ActionCode.md#code)
+
+***
+
+### expiresAt
+
+> **expiresAt**: `number`
+
+Defined in: src/types.ts:10
+
+#### Inherited from
+
+[`ActionCode`](ActionCode.md).[`expiresAt`](ActionCode.md#expiresat)
+
+***
+
+### pubkey
+
+> **pubkey**: `string`
+
+Defined in: src/types.ts:8
+
+#### Inherited from
+
+[`ActionCode`](ActionCode.md).[`pubkey`](ActionCode.md#pubkey)
+
+***
+
+### revokeSignature
+
+> **revokeSignature**: `string`
+
+Defined in: src/types.ts:44
+
+***
+
+### signature
+
+> **signature**: `string`
+
+Defined in: src/types.ts:11
+
+#### Inherited from
+
+[`ActionCode`](ActionCode.md).[`signature`](ActionCode.md#signature)
+
+***
+
+### timestamp
+
+> **timestamp**: `number`
+
+Defined in: src/types.ts:9
+
+#### Inherited from
+
+[`ActionCode`](ActionCode.md).[`timestamp`](ActionCode.md#timestamp)

package/docs/types/interfaces/CanonicalMessageParts.md

@@ -1,12 +1,12 @@
-[**@actioncodes/protocol-v2**](../../README.md)
+[**@actioncodes/protocol**](../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../modules.md) / [types](../README.md) / CanonicalMessageParts
+[@actioncodes/protocol](../../modules.md) / [types](../README.md) / CanonicalMessageParts
 
 # Interface: CanonicalMessageParts
 
-Defined in: src/types.ts:12
+Defined in: src/types.ts:14
 
 ## Properties
 
@@ -14,15 +14,7 @@ Defined in: src/types.ts:12
 
 > **pubkey**: `string`
 
-Defined in: src/types.ts:13
-
-***
-
-### secret?
-
-> `optional` **secret**: `string`
-
-Defined in: src/types.ts:16
+Defined in: src/types.ts:15
 
 ***
 
@@ -30,4 +22,4 @@ Defined in: src/types.ts:16
 
 > **windowStart**: `number`
 
-Defined in: src/types.ts:14
+Defined in: src/types.ts:16

package/docs/types/interfaces/CanonicalRevokeMessageParts.md

@@ -0,0 +1,33 @@
+[**@actioncodes/protocol**](../../README.md)
+
+***
+
+[@actioncodes/protocol](../../modules.md) / [types](../README.md) / CanonicalRevokeMessageParts
+
+# Interface: CanonicalRevokeMessageParts
+
+Defined in: src/types.ts:19
+
+## Properties
+
+### codeHash
+
+> **codeHash**: `string`
+
+Defined in: src/types.ts:21
+
+***
+
+### pubkey
+
+> **pubkey**: `string`
+
+Defined in: src/types.ts:20
+
+***
+
+### windowStart
+
+> **windowStart**: `number`
+
+Defined in: src/types.ts:22

package/docs/types/interfaces/CodeGenerationConfig.md

@@ -1,12 +1,12 @@
-[**@actioncodes/protocol-v2**](../../README.md)
+[**@actioncodes/protocol**](../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../modules.md) / [types](../README.md) / CodeGenerationConfig
+[@actioncodes/protocol](../../modules.md) / [types](../README.md) / CodeGenerationConfig
 
 # Interface: CodeGenerationConfig
 
-Defined in: src/types.ts:19
+Defined in: src/types.ts:25
 
 ## Properties
 
@@ -14,7 +14,7 @@ Defined in: src/types.ts:19
 
 > `optional` **clockSkewMs**: `number`
 
-Defined in: src/types.ts:22
+Defined in: src/types.ts:28
 
 ***
 
@@ -22,7 +22,7 @@ Defined in: src/types.ts:22
 
 > **codeLength**: `number`
 
-Defined in: src/types.ts:20
+Defined in: src/types.ts:26
 
 ***
 
@@ -30,4 +30,4 @@ Defined in: src/types.ts:20
 
 > **ttlMs**: `number`
 
-Defined in: src/types.ts:21
+Defined in: src/types.ts:27

package/docs/types/interfaces/DelegatedActionCode.md

@@ -0,0 +1,97 @@
+[**@actioncodes/protocol**](../../README.md)
+
+***
+
+[@actioncodes/protocol](../../modules.md) / [types](../README.md) / DelegatedActionCode
+
+# Interface: DelegatedActionCode
+
+Defined in: src/types.ts:39
+
+## Extends
+
+- [`ActionCode`](ActionCode.md)
+
+## Extended by
+
+- [`DelegatedActionCodeRevoke`](DelegatedActionCodeRevoke.md)
+
+## Properties
+
+### chain
+
+> **chain**: `"solana"`
+
+Defined in: src/types.ts:6
+
+#### Inherited from
+
+[`ActionCode`](ActionCode.md).[`chain`](ActionCode.md#chain)
+
+***
+
+### code
+
+> **code**: `string`
+
+Defined in: src/types.ts:7
+
+#### Inherited from
+
+[`ActionCode`](ActionCode.md).[`code`](ActionCode.md#code)
+
+***
+
+### delegationProof
+
+> **delegationProof**: [`DelegationProof`](DelegationProof.md)
+
+Defined in: src/types.ts:40
+
+***
+
+### expiresAt
+
+> **expiresAt**: `number`
+
+Defined in: src/types.ts:10
+
+#### Inherited from
+
+[`ActionCode`](ActionCode.md).[`expiresAt`](ActionCode.md#expiresat)
+
+***
+
+### pubkey
+
+> **pubkey**: `string`
+
+Defined in: src/types.ts:8
+
+#### Inherited from
+
+[`ActionCode`](ActionCode.md).[`pubkey`](ActionCode.md#pubkey)
+
+***
+
+### signature
+
+> **signature**: `string`
+
+Defined in: src/types.ts:11
+
+#### Inherited from
+
+[`ActionCode`](ActionCode.md).[`signature`](ActionCode.md#signature)
+
+***
+
+### timestamp
+
+> **timestamp**: `number`
+
+Defined in: src/types.ts:9
+
+#### Inherited from
+
+[`ActionCode`](ActionCode.md).[`timestamp`](ActionCode.md#timestamp)

package/docs/types/interfaces/DelegatedActionCodeRevoke.md

@@ -0,0 +1,105 @@
+[**@actioncodes/protocol**](../../README.md)
+
+***
+
+[@actioncodes/protocol](../../modules.md) / [types](../README.md) / DelegatedActionCodeRevoke
+
+# Interface: DelegatedActionCodeRevoke
+
+Defined in: src/types.ts:47
+
+## Extends
+
+- [`DelegatedActionCode`](DelegatedActionCode.md)
+
+## Properties
+
+### chain
+
+> **chain**: `"solana"`
+
+Defined in: src/types.ts:6
+
+#### Inherited from
+
+[`DelegatedActionCode`](DelegatedActionCode.md).[`chain`](DelegatedActionCode.md#chain)
+
+***
+
+### code
+
+> **code**: `string`
+
+Defined in: src/types.ts:7
+
+#### Inherited from
+
+[`DelegatedActionCode`](DelegatedActionCode.md).[`code`](DelegatedActionCode.md#code)
+
+***
+
+### delegationProof
+
+> **delegationProof**: [`DelegationProof`](DelegationProof.md)
+
+Defined in: src/types.ts:40
+
+#### Inherited from
+
+[`DelegatedActionCode`](DelegatedActionCode.md).[`delegationProof`](DelegatedActionCode.md#delegationproof)
+
+***
+
+### expiresAt
+
+> **expiresAt**: `number`
+
+Defined in: src/types.ts:10
+
+#### Inherited from
+
+[`DelegatedActionCode`](DelegatedActionCode.md).[`expiresAt`](DelegatedActionCode.md#expiresat)
+
+***
+
+### pubkey
+
+> **pubkey**: `string`
+
+Defined in: src/types.ts:8
+
+#### Inherited from
+
+[`DelegatedActionCode`](DelegatedActionCode.md).[`pubkey`](DelegatedActionCode.md#pubkey)
+
+***
+
+### revokeSignature
+
+> **revokeSignature**: `string`
+
+Defined in: src/types.ts:48
+
+***
+
+### signature
+
+> **signature**: `string`
+
+Defined in: src/types.ts:11
+
+#### Inherited from
+
+[`DelegatedActionCode`](DelegatedActionCode.md).[`signature`](DelegatedActionCode.md#signature)
+
+***
+
+### timestamp
+
+> **timestamp**: `number`
+
+Defined in: src/types.ts:9
+
+#### Inherited from
+
+[`DelegatedActionCode`](DelegatedActionCode.md).[`timestamp`](DelegatedActionCode.md#timestamp)

package/docs/types/interfaces/DelegationProof.md

@@ -0,0 +1,49 @@
+[**@actioncodes/protocol**](../../README.md)
+
+***
+
+[@actioncodes/protocol](../../modules.md) / [types](../README.md) / DelegationProof
+
+# Interface: DelegationProof
+
+Defined in: src/types.ts:31
+
+## Properties
+
+### chain
+
+> **chain**: `string`
+
+Defined in: src/types.ts:35
+
+***
+
+### delegatedPubkey
+
+> **delegatedPubkey**: `string`
+
+Defined in: src/types.ts:33
+
+***
+
+### expiresAt
+
+> **expiresAt**: `number`
+
+Defined in: src/types.ts:34
+
+***
+
+### signature
+
+> **signature**: `string`
+
+Defined in: src/types.ts:36
+
+***
+
+### walletPubkey
+
+> **walletPubkey**: `string`
+
+Defined in: src/types.ts:32

package/docs/types/type-aliases/Chain.md

@@ -0,0 +1,11 @@
+[**@actioncodes/protocol**](../../README.md)
+
+***
+
+[@actioncodes/protocol](../../modules.md) / [types](../README.md) / Chain
+
+# Type Alias: Chain
+
+> **Chain** = keyof *typeof* [`SUPPORTED_CHAINS`](../../constants/variables/SUPPORTED_CHAINS.md)
+
+Defined in: src/types.ts:3

package/docs/utils/canonical/README.md

@@ -1,8 +1,8 @@
-[**@actioncodes/protocol-v2**](../../README.md)
+[**@actioncodes/protocol**](../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../modules.md) / utils/canonical
+[@actioncodes/protocol](../../modules.md) / utils/canonical
 
 # utils/canonical
 
@@ -10,7 +10,11 @@
 
 - [CANONICAL\_MESSAGE\_PREFIX](variables/CANONICAL_MESSAGE_PREFIX.md)
 - [CANONICAL\_MESSAGE\_VERSION](variables/CANONICAL_MESSAGE_VERSION.md)
+- [CANONICAL\_REVOKE\_MESSAGE\_PREFIX](variables/CANONICAL_REVOKE_MESSAGE_PREFIX.md)
 
 ## Functions
 
+- [getCanonicalMessageParts](functions/getCanonicalMessageParts.md)
 - [serializeCanonical](functions/serializeCanonical.md)
+- [serializeCanonicalRevoke](functions/serializeCanonicalRevoke.md)
+- [serializeDelegationProof](functions/serializeDelegationProof.md)

package/docs/utils/canonical/functions/getCanonicalMessageParts.md

@@ -0,0 +1,21 @@
+[**@actioncodes/protocol**](../../../README.md)
+
+***
+
+[@actioncodes/protocol](../../../modules.md) / [utils/canonical](../README.md) / getCanonicalMessageParts
+
+# Function: getCanonicalMessageParts()
+
+> **getCanonicalMessageParts**(`pubkey`): `Uint8Array`
+
+Defined in: src/utils/canonical.ts:100
+
+## Parameters
+
+### pubkey
+
+`string`
+
+## Returns
+
+`Uint8Array`

package/docs/utils/canonical/functions/serializeCanonical.md

@@ -1,14 +1,14 @@
-[**@actioncodes/protocol-v2**](../../../README.md)
+[**@actioncodes/protocol**](../../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../../modules.md) / [utils/canonical](../README.md) / serializeCanonical
+[@actioncodes/protocol](../../../modules.md) / [utils/canonical](../README.md) / serializeCanonical
 
 # Function: serializeCanonical()
 
 > **serializeCanonical**(`parts`): `Uint8Array`
 
-Defined in: src/utils/canonical.ts:6
+Defined in: src/utils/canonical.ts:12
 
 ## Parameters
 

package/docs/utils/canonical/functions/serializeCanonicalRevoke.md

@@ -0,0 +1,21 @@
+[**@actioncodes/protocol**](../../../README.md)
+
+***
+
+[@actioncodes/protocol](../../../modules.md) / [utils/canonical](../README.md) / serializeCanonicalRevoke
+
+# Function: serializeCanonicalRevoke()
+
+> **serializeCanonicalRevoke**(`parts`): `Uint8Array`
+
+Defined in: src/utils/canonical.ts:50
+
+## Parameters
+
+### parts
+
+[`CanonicalRevokeMessageParts`](../../../types/interfaces/CanonicalRevokeMessageParts.md)
+
+## Returns
+
+`Uint8Array`

package/docs/utils/canonical/functions/serializeDelegationProof.md

@@ -0,0 +1,21 @@
+[**@actioncodes/protocol**](../../../README.md)
+
+***
+
+[@actioncodes/protocol](../../../modules.md) / [utils/canonical](../README.md) / serializeDelegationProof
+
+# Function: serializeDelegationProof()
+
+> **serializeDelegationProof**(`proof`): `Uint8Array`
+
+Defined in: src/utils/canonical.ts:104
+
+## Parameters
+
+### proof
+
+`Omit`\<[`DelegationProof`](../../../types/interfaces/DelegationProof.md), `"signature"`\>
+
+## Returns
+
+`Uint8Array`

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

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

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

@@ -1,11 +1,11 @@
-[**@actioncodes/protocol-v2**](../../../README.md)
+[**@actioncodes/protocol**](../../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../../modules.md) / [utils/canonical](../README.md) / CANONICAL\_MESSAGE\_VERSION
+[@actioncodes/protocol](../../../modules.md) / [utils/canonical](../README.md) / CANONICAL\_MESSAGE\_VERSION
 
 # Variable: CANONICAL\_MESSAGE\_VERSION
 
 > `const` **CANONICAL\_MESSAGE\_VERSION**: `1` = `1`
 
-Defined in: src/utils/canonical.ts:3
+Defined in: src/utils/canonical.ts:8