@actioncodes/protocol 2.0.21 → 2.0.23

package/docs/ActionCodesProtocol/classes/ActionCodesProtocol.md

@@ -1,12 +1,12 @@
-[**@actioncodes/protocol-v2**](../../README.md)
+[**@actioncodes/protocol**](../../README.md)
 
 ***
 
-[@actioncodes/protocol-v2](../../modules.md) / [ActionCodesProtocol](../README.md) / ActionCodesProtocol
+[@actioncodes/protocol](../../modules.md) / [ActionCodesProtocol](../README.md) / ActionCodesProtocol
 
 # Class: ActionCodesProtocol
 
-Defined in: src/ActionCodesProtocol.ts:7
+Defined in: src/ActionCodesProtocol.ts:22
 
 ## Constructors
 
@@ -14,7 +14,7 @@ Defined in: src/ActionCodesProtocol.ts:7
 
 > **new ActionCodesProtocol**(`config`): `ActionCodesProtocol`
 
-Defined in: src/ActionCodesProtocol.ts:10
+Defined in: src/ActionCodesProtocol.ts:27
 
 #### Parameters
 
@@ -34,7 +34,7 @@ Defined in: src/ActionCodesProtocol.ts:10
 
 > **get** **adapter**(): `object`
 
-Defined in: src/ActionCodesProtocol.ts:26
+Defined in: src/ActionCodesProtocol.ts:51
 
 Typed access to specific adapters
 
@@ -46,43 +46,103 @@ Typed access to specific adapters
 
 > **solana**: [`SolanaAdapter`](../../adapters/SolanaAdapter/classes/SolanaAdapter.md)
 
+***
+
+### delegationStrategy
+
+#### Get Signature
+
+> **get** **delegationStrategy**(): [`DelegationStrategy`](../../strategy/DelegationStrategy/classes/DelegationStrategy.md)
+
+Defined in: src/ActionCodesProtocol.ts:62
+
+##### Returns
+
+[`DelegationStrategy`](../../strategy/DelegationStrategy/classes/DelegationStrategy.md)
+
+***
+
+### walletStrategy
+
+#### Get Signature
+
+> **get** **walletStrategy**(): [`WalletStrategy`](../../strategy/WalletStrategy/classes/WalletStrategy.md)
+
+Defined in: src/ActionCodesProtocol.ts:58
+
+Access to strategies
+
+##### Returns
+
+[`WalletStrategy`](../../strategy/WalletStrategy/classes/WalletStrategy.md)
+
 ## Methods
 
-### generateCode()
+### generate()
 
-> **generateCode**(`pubkey`, `providedSecret?`): `object`
+#### Call Signature
 
-Defined in: src/ActionCodesProtocol.ts:32
+> **generate**(`strategy`, `pubkey`, `chain`, `signFn`): `Promise`\<[`ActionCode`](../../types/interfaces/ActionCode.md)\>
 
-#### Parameters
+Defined in: src/ActionCodesProtocol.ts:67
 
-##### pubkey
+##### Parameters
 
-`string`
+###### strategy
 
-##### providedSecret?
+`"wallet"`
+
+###### pubkey
 
 `string`
 
-#### Returns
+###### chain
 
-`object`
+`"solana"`
 
-##### actionCode
+###### signFn
 
-> **actionCode**: [`ActionCode`](../../types/interfaces/ActionCode.md)
+[`SignFn`](../../adapters/BaseChainAdapter/type-aliases/SignFn.md)
 
-##### canonicalMessage
+##### Returns
+
+`Promise`\<[`ActionCode`](../../types/interfaces/ActionCode.md)\>
+
+#### Call Signature
+
+> **generate**(`strategy`, `delegationProof`, `chain`, `signFn`): `Promise`\<[`DelegatedActionCode`](../../types/interfaces/DelegatedActionCode.md)\>
+
+Defined in: src/ActionCodesProtocol.ts:73
+
+##### Parameters
+
+###### strategy
+
+`"delegation"`
+
+###### delegationProof
+
+[`DelegationProof`](../../types/interfaces/DelegationProof.md)
+
+###### chain
+
+`"solana"`
+
+###### signFn
 
-> **canonicalMessage**: `Uint8Array`
+[`SignFn`](../../adapters/BaseChainAdapter/type-aliases/SignFn.md)
+
+##### Returns
+
+`Promise`\<[`DelegatedActionCode`](../../types/interfaces/DelegatedActionCode.md)\>
 
 ***
 
 ### getAdapter()
 
-> **getAdapter**(`chain`): `undefined` \| [`ChainAdapter`](../../adapters/BaseChainAdapter/interfaces/ChainAdapter.md)\<`unknown`\>
+> **getAdapter**(`chain`): `undefined` \| [`ChainAdapter`](../../adapters/BaseChainAdapter/interfaces/ChainAdapter.md)
 
-Defined in: src/ActionCodesProtocol.ts:21
+Defined in: src/ActionCodesProtocol.ts:46
 
 Get a registered adapter
 
@@ -94,7 +154,19 @@ Get a registered adapter
 
 #### Returns
 
-`undefined` \| [`ChainAdapter`](../../adapters/BaseChainAdapter/interfaces/ChainAdapter.md)\<`unknown`\>
+`undefined` \| [`ChainAdapter`](../../adapters/BaseChainAdapter/interfaces/ChainAdapter.md)
+
+***
+
+### getConfig()
+
+> **getConfig**(): [`CodeGenerationConfig`](../../types/interfaces/CodeGenerationConfig.md)
+
+Defined in: src/ActionCodesProtocol.ts:36
+
+#### Returns
+
+[`CodeGenerationConfig`](../../types/interfaces/CodeGenerationConfig.md)
 
 ***
 
@@ -102,7 +174,7 @@ Get a registered adapter
 
 > **registerAdapter**(`chain`, `adapter`): `void`
 
-Defined in: src/ActionCodesProtocol.ts:16
+Defined in: src/ActionCodesProtocol.ts:41
 
 Register a chain adapter
 
@@ -122,26 +194,104 @@ Register a chain adapter
 
 ***
 
-### validateCode()
+### revoke()
 
-> **validateCode**(`actionCode`, `chain?`, `context?`): `Promise`\<`void`\>
+#### Call Signature
 
-Defined in: src/ActionCodesProtocol.ts:39
+> **revoke**(`strategy`, `actionCode`, `chain`, `signFn`): `Promise`\<[`ActionCodeRevoke`](../../types/interfaces/ActionCodeRevoke.md)\>
 
-#### Parameters
+Defined in: src/ActionCodesProtocol.ts:124
+
+##### Parameters
+
+###### strategy
+
+`"wallet"`
 
-##### actionCode
+###### actionCode
 
 [`ActionCode`](../../types/interfaces/ActionCode.md)
 
-##### chain?
+###### chain
 
-`string`
+`"solana"`
 
-##### context?
+###### signFn
 
-`Omit`\<[`ChainContext`](../../adapters/BaseChainAdapter/type-aliases/ChainContext.md)\<`unknown`\>, `"message"`\>
+[`SignFn`](../../adapters/BaseChainAdapter/type-aliases/SignFn.md)
 
-#### Returns
+##### Returns
+
+`Promise`\<[`ActionCodeRevoke`](../../types/interfaces/ActionCodeRevoke.md)\>
+
+#### Call Signature
+
+> **revoke**(`strategy`, `actionCode`, `chain`, `signFn`): `Promise`\<[`DelegatedActionCodeRevoke`](../../types/interfaces/DelegatedActionCodeRevoke.md)\>
+
+Defined in: src/ActionCodesProtocol.ts:130
+
+##### Parameters
+
+###### strategy
+
+`"delegation"`
+
+###### actionCode
+
+[`DelegatedActionCode`](../../types/interfaces/DelegatedActionCode.md)
+
+###### chain
+
+`"solana"`
+
+###### signFn
+
+[`SignFn`](../../adapters/BaseChainAdapter/type-aliases/SignFn.md)
+
+##### Returns
+
+`Promise`\<[`DelegatedActionCodeRevoke`](../../types/interfaces/DelegatedActionCodeRevoke.md)\>
+
+***
 
-`Promise`\<`void`\>
+### validate()
+
+#### Call Signature
+
+> **validate**(`strategy`, `actionCode`): `void`
+
+Defined in: src/ActionCodesProtocol.ts:193
+
+##### Parameters
+
+###### strategy
+
+`"wallet"`
+
+###### actionCode
+
+[`ActionCode`](../../types/interfaces/ActionCode.md)
+
+##### Returns
+
+`void`
+
+#### Call Signature
+
+> **validate**(`strategy`, `actionCode`): `void`
+
+Defined in: src/ActionCodesProtocol.ts:194
+
+##### Parameters
+
+###### strategy
+
+`"delegation"`
+
+###### actionCode
+
+[`DelegatedActionCode`](../../types/interfaces/DelegatedActionCode.md)
+
+##### Returns
+
+`void`