@actioncodes/protocol 1.0.3 → 1.1.1
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.
- package/dist/adapters/base.d.ts +19 -2
- package/dist/adapters/base.d.ts.map +1 -1
- package/dist/adapters/base.js +1 -1
- package/dist/adapters/solana/solana.d.ts +16 -3
- package/dist/adapters/solana/solana.d.ts.map +1 -1
- package/dist/adapters/solana/solana.js +107 -14
- package/dist/protocol.js +3 -3
- package/docs/actioncode/classes/ActionCode.md +23 -23
- package/docs/actioncode/interfaces/ActionCodeFields.md +11 -11
- package/docs/actioncode/interfaces/ActionCodeMetadata.md +3 -3
- package/docs/actioncode/interfaces/ActionCodeTransaction.md +4 -4
- package/docs/actioncode/type-aliases/ActionCodeStatus.md +1 -1
- package/docs/adapters/base/classes/BaseChainAdapter.md +72 -14
- package/docs/adapters/solana/solana/classes/SolanaAdapter.md +97 -33
- package/docs/adapters/solana/solana/type-aliases/SolanaTransaction.md +1 -1
- package/docs/codegen/classes/CodeGenerator.md +14 -14
- package/docs/constants/type-aliases/SupportedChain.md +1 -1
- package/docs/constants/variables/CODE_LENGTH.md +1 -1
- package/docs/constants/variables/CODE_TTL.md +1 -1
- package/docs/constants/variables/MAX_PREFIX_LENGTH.md +1 -1
- package/docs/constants/variables/MIN_PREFIX_LENGTH.md +1 -1
- package/docs/constants/variables/PROTOCOL_CODE_PREFIX.md +1 -1
- package/docs/constants/variables/PROTOCOL_PREFIX.md +1 -1
- package/docs/constants/variables/PROTOCOL_VERSION.md +1 -1
- package/docs/constants/variables/SUPPORTED_CHAINS.md +1 -1
- package/docs/meta/classes/ProtocolMetaParser.md +6 -6
- package/docs/meta/interfaces/ProtocolMetaV1.md +7 -7
- package/docs/protocol/classes/ActionCodesProtocol.md +21 -21
- package/docs/protocol/interfaces/ProtocolConfig.md +7 -7
- package/package.json +1 -1
@@ -6,7 +6,7 @@
|
|
6
6
|
|
7
7
|
# Class: ProtocolMetaParser
|
8
8
|
|
9
|
-
Defined in: [meta.ts:19](https://github.com/otaprotocol/actioncodes/blob/
|
9
|
+
Defined in: [meta.ts:19](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/meta.ts#L19)
|
10
10
|
|
11
11
|
Protocol meta parser for structured memo/message parsing
|
12
12
|
|
@@ -26,7 +26,7 @@ Protocol meta parser for structured memo/message parsing
|
|
26
26
|
|
27
27
|
> `static` **fromInitiator**(`initiator`, `iss`, `prefix`, `params?`, `timestamp?`): [`ProtocolMetaV1`](../interfaces/ProtocolMetaV1.md)
|
28
28
|
|
29
|
-
Defined in: [meta.ts:74](https://github.com/otaprotocol/actioncodes/blob/
|
29
|
+
Defined in: [meta.ts:74](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/meta.ts#L74)
|
30
30
|
|
31
31
|
Create protocol meta from code and parameters
|
32
32
|
|
@@ -74,7 +74,7 @@ ProtocolMeta object
|
|
74
74
|
|
75
75
|
> `static` **parse**(`metaString`): `null` \| [`ProtocolMetaV1`](../interfaces/ProtocolMetaV1.md)
|
76
76
|
|
77
|
-
Defined in: [meta.ts:27](https://github.com/otaprotocol/actioncodes/blob/
|
77
|
+
Defined in: [meta.ts:27](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/meta.ts#L27)
|
78
78
|
|
79
79
|
Parse protocol meta from string
|
80
80
|
|
@@ -98,7 +98,7 @@ Parsed ProtocolMeta object or null if invalid
|
|
98
98
|
|
99
99
|
> `static` **serialize**(`meta`): `string`
|
100
100
|
|
101
|
-
Defined in: [meta.ts:55](https://github.com/otaprotocol/actioncodes/blob/
|
101
|
+
Defined in: [meta.ts:55](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/meta.ts#L55)
|
102
102
|
|
103
103
|
Serialize ProtocolMeta to string
|
104
104
|
|
@@ -122,7 +122,7 @@ Serialized protocol meta string
|
|
122
122
|
|
123
123
|
> `static` **validateCode**(`meta`, `timestamp?`): `boolean`
|
124
124
|
|
125
|
-
Defined in: [meta.ts:99](https://github.com/otaprotocol/actioncodes/blob/
|
125
|
+
Defined in: [meta.ts:99](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/meta.ts#L99)
|
126
126
|
|
127
127
|
Validate if a code matches the protocol meta
|
128
128
|
|
@@ -152,7 +152,7 @@ True if the meta is valid
|
|
152
152
|
|
153
153
|
> `static` **validateMetaFromString**(`metaString`, `timestamp?`): `boolean`
|
154
154
|
|
155
|
-
Defined in: [meta.ts:110](https://github.com/otaprotocol/actioncodes/blob/
|
155
|
+
Defined in: [meta.ts:110](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/meta.ts#L110)
|
156
156
|
|
157
157
|
Validate if a code matches the protocol meta by parsing from string
|
158
158
|
|
@@ -6,7 +6,7 @@
|
|
6
6
|
|
7
7
|
# Interface: ProtocolMetaV1
|
8
8
|
|
9
|
-
Defined in: [meta.ts:7](https://github.com/otaprotocol/actioncodes/blob/
|
9
|
+
Defined in: [meta.ts:7](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/meta.ts#L7)
|
10
10
|
|
11
11
|
Protocol meta structure for code verification
|
12
12
|
|
@@ -16,7 +16,7 @@ Protocol meta structure for code verification
|
|
16
16
|
|
17
17
|
> **id**: `string`
|
18
18
|
|
19
|
-
Defined in: [meta.ts:11](https://github.com/otaprotocol/actioncodes/blob/
|
19
|
+
Defined in: [meta.ts:11](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/meta.ts#L11)
|
20
20
|
|
21
21
|
***
|
22
22
|
|
@@ -24,7 +24,7 @@ Defined in: [meta.ts:11](https://github.com/otaprotocol/actioncodes/blob/007a9e0
|
|
24
24
|
|
25
25
|
> **initiator**: `string`
|
26
26
|
|
27
|
-
Defined in: [meta.ts:10](https://github.com/otaprotocol/actioncodes/blob/
|
27
|
+
Defined in: [meta.ts:10](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/meta.ts#L10)
|
28
28
|
|
29
29
|
***
|
30
30
|
|
@@ -32,7 +32,7 @@ Defined in: [meta.ts:10](https://github.com/otaprotocol/actioncodes/blob/007a9e0
|
|
32
32
|
|
33
33
|
> `optional` **iss**: `string`
|
34
34
|
|
35
|
-
Defined in: [meta.ts:12](https://github.com/otaprotocol/actioncodes/blob/
|
35
|
+
Defined in: [meta.ts:12](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/meta.ts#L12)
|
36
36
|
|
37
37
|
***
|
38
38
|
|
@@ -40,7 +40,7 @@ Defined in: [meta.ts:12](https://github.com/otaprotocol/actioncodes/blob/007a9e0
|
|
40
40
|
|
41
41
|
> `optional` **params**: `string`
|
42
42
|
|
43
|
-
Defined in: [meta.ts:13](https://github.com/otaprotocol/actioncodes/blob/
|
43
|
+
Defined in: [meta.ts:13](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/meta.ts#L13)
|
44
44
|
|
45
45
|
***
|
46
46
|
|
@@ -48,7 +48,7 @@ Defined in: [meta.ts:13](https://github.com/otaprotocol/actioncodes/blob/007a9e0
|
|
48
48
|
|
49
49
|
> **prefix**: `string`
|
50
50
|
|
51
|
-
Defined in: [meta.ts:9](https://github.com/otaprotocol/actioncodes/blob/
|
51
|
+
Defined in: [meta.ts:9](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/meta.ts#L9)
|
52
52
|
|
53
53
|
***
|
54
54
|
|
@@ -56,4 +56,4 @@ Defined in: [meta.ts:9](https://github.com/otaprotocol/actioncodes/blob/007a9e0d
|
|
56
56
|
|
57
57
|
> **version**: `string`
|
58
58
|
|
59
|
-
Defined in: [meta.ts:8](https://github.com/otaprotocol/actioncodes/blob/
|
59
|
+
Defined in: [meta.ts:8](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/meta.ts#L8)
|
@@ -6,7 +6,7 @@
|
|
6
6
|
|
7
7
|
# Class: ActionCodesProtocol
|
8
8
|
|
9
|
-
Defined in: [protocol.ts:31](https://github.com/otaprotocol/actioncodes/blob/
|
9
|
+
Defined in: [protocol.ts:31](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L31)
|
10
10
|
|
11
11
|
OTA Protocol - Main entry point for the One-Time Action Code Protocol
|
12
12
|
|
@@ -19,7 +19,7 @@ action codes across multiple blockchain networks.
|
|
19
19
|
|
20
20
|
> **new ActionCodesProtocol**(`config?`): `ActionCodesProtocol`
|
21
21
|
|
22
|
-
Defined in: [protocol.ts:35](https://github.com/otaprotocol/actioncodes/blob/
|
22
|
+
Defined in: [protocol.ts:35](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L35)
|
23
23
|
|
24
24
|
#### Parameters
|
25
25
|
|
@@ -37,7 +37,7 @@ Defined in: [protocol.ts:35](https://github.com/otaprotocol/actioncodes/blob/007
|
|
37
37
|
|
38
38
|
> **attachTransaction**(`actionCode`, `transaction`, `txType?`): [`ActionCode`](../../actioncode/classes/ActionCode.md)
|
39
39
|
|
40
|
-
Defined in: [protocol.ts:161](https://github.com/otaprotocol/actioncodes/blob/
|
40
|
+
Defined in: [protocol.ts:161](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L161)
|
41
41
|
|
42
42
|
Attach a transaction to an action code
|
43
43
|
|
@@ -73,7 +73,7 @@ Updated ActionCode
|
|
73
73
|
|
74
74
|
> **createActionCode**(`pubkey`, `signFn`, `chain`, `prefix`, `timestamp?`): `Promise`\<[`ActionCode`](../../actioncode/classes/ActionCode.md)\>
|
75
75
|
|
76
|
-
Defined in: [protocol.ts:111](https://github.com/otaprotocol/actioncodes/blob/
|
76
|
+
Defined in: [protocol.ts:111](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L111)
|
77
77
|
|
78
78
|
Create an action code
|
79
79
|
|
@@ -121,7 +121,7 @@ Promise resolving to a complete ActionCode object
|
|
121
121
|
|
122
122
|
> **createProtocolMeta**(`actionCode`, `issuer?`, `params?`): [`ProtocolMetaV1`](../../meta/interfaces/ProtocolMetaV1.md)
|
123
123
|
|
124
|
-
Defined in: [protocol.ts:226](https://github.com/otaprotocol/actioncodes/blob/
|
124
|
+
Defined in: [protocol.ts:226](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L226)
|
125
125
|
|
126
126
|
Create protocol meta for a transaction
|
127
127
|
|
@@ -157,7 +157,7 @@ ProtocolMetaV1 object
|
|
157
157
|
|
158
158
|
> **decodeProtocolMeta**(`transaction`, `chain`): `null` \| [`ProtocolMetaV1`](../../meta/interfaces/ProtocolMetaV1.md)
|
159
159
|
|
160
|
-
Defined in: [protocol.ts:260](https://github.com/otaprotocol/actioncodes/blob/
|
160
|
+
Defined in: [protocol.ts:260](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L260)
|
161
161
|
|
162
162
|
Decode protocol meta from a transaction
|
163
163
|
|
@@ -187,7 +187,7 @@ Decoded ProtocolMetaV1 or null
|
|
187
187
|
|
188
188
|
> **decodeProtocolMetaTyped**\<`T`\>(`transaction`, `chain`): `null` \| [`ProtocolMetaV1`](../../meta/interfaces/ProtocolMetaV1.md)
|
189
189
|
|
190
|
-
Defined in: [protocol.ts:341](https://github.com/otaprotocol/actioncodes/blob/
|
190
|
+
Defined in: [protocol.ts:341](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L341)
|
191
191
|
|
192
192
|
Decode protocol meta with type safety
|
193
193
|
|
@@ -223,7 +223,7 @@ Decoded ProtocolMetaV1 or null
|
|
223
223
|
|
224
224
|
> **detectTampering**\<`T`\>(`transaction`, `chain`, `authorities`, `expectedPrefix?`): `boolean`
|
225
225
|
|
226
|
-
Defined in: [protocol.ts:321](https://github.com/otaprotocol/actioncodes/blob/
|
226
|
+
Defined in: [protocol.ts:321](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L321)
|
227
227
|
|
228
228
|
Detect tampered transactions with type safety
|
229
229
|
|
@@ -271,7 +271,7 @@ True if transaction is valid and not tampered
|
|
271
271
|
|
272
272
|
> **encodeProtocolMeta**(`meta`, `chain`): `any`
|
273
273
|
|
274
|
-
Defined in: [protocol.ts:245](https://github.com/otaprotocol/actioncodes/blob/
|
274
|
+
Defined in: [protocol.ts:245](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L245)
|
275
275
|
|
276
276
|
Encode protocol meta for a specific chain
|
277
277
|
|
@@ -301,7 +301,7 @@ Chain-specific encoded meta
|
|
301
301
|
|
302
302
|
> **finalizeActionCode**(`actionCode`, `txSignature`): [`ActionCode`](../../actioncode/classes/ActionCode.md)
|
303
303
|
|
304
|
-
Defined in: [protocol.ts:194](https://github.com/otaprotocol/actioncodes/blob/
|
304
|
+
Defined in: [protocol.ts:194](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L194)
|
305
305
|
|
306
306
|
Finalize an action code with transaction signature
|
307
307
|
|
@@ -331,7 +331,7 @@ Updated ActionCode
|
|
331
331
|
|
332
332
|
> **getChainAdapter**\<`T`\>(`chain`): `undefined` \| [`BaseChainAdapter`](../../adapters/base/classes/BaseChainAdapter.md)\<`T`\>
|
333
333
|
|
334
|
-
Defined in: [protocol.ts:77](https://github.com/otaprotocol/actioncodes/blob/
|
334
|
+
Defined in: [protocol.ts:77](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L77)
|
335
335
|
|
336
336
|
Get chain adapter with proper typing
|
337
337
|
|
@@ -361,7 +361,7 @@ Chain adapter or undefined
|
|
361
361
|
|
362
362
|
> **getConfig**(): [`ProtocolConfig`](../interfaces/ProtocolConfig.md)
|
363
363
|
|
364
|
-
Defined in: [protocol.ts:354](https://github.com/otaprotocol/actioncodes/blob/
|
364
|
+
Defined in: [protocol.ts:354](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L354)
|
365
365
|
|
366
366
|
Get protocol configuration
|
367
367
|
|
@@ -377,7 +377,7 @@ Current protocol configuration
|
|
377
377
|
|
378
378
|
> **getRegisteredChains**(): `string`[]
|
379
379
|
|
380
|
-
Defined in: [protocol.ts:59](https://github.com/otaprotocol/actioncodes/blob/
|
380
|
+
Defined in: [protocol.ts:59](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L59)
|
381
381
|
|
382
382
|
Get registered chain adapters
|
383
383
|
|
@@ -393,7 +393,7 @@ Array of registered chain identifiers
|
|
393
393
|
|
394
394
|
> **isChainSupported**(`chain`): `boolean`
|
395
395
|
|
396
|
-
Defined in: [protocol.ts:68](https://github.com/otaprotocol/actioncodes/blob/
|
396
|
+
Defined in: [protocol.ts:68](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L68)
|
397
397
|
|
398
398
|
Check if a chain is supported
|
399
399
|
|
@@ -417,7 +417,7 @@ True if chain is supported
|
|
417
417
|
|
418
418
|
> **registerAdapter**\<`T`\>(`adapter`): `void`
|
419
419
|
|
420
|
-
Defined in: [protocol.ts:51](https://github.com/otaprotocol/actioncodes/blob/
|
420
|
+
Defined in: [protocol.ts:51](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L51)
|
421
421
|
|
422
422
|
Register a chain adapter
|
423
423
|
|
@@ -445,7 +445,7 @@ Chain adapter implementation
|
|
445
445
|
|
446
446
|
> **updateConfig**(`updates`): `void`
|
447
447
|
|
448
|
-
Defined in: [protocol.ts:362](https://github.com/otaprotocol/actioncodes/blob/
|
448
|
+
Defined in: [protocol.ts:362](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L362)
|
449
449
|
|
450
450
|
Update protocol configuration
|
451
451
|
|
@@ -467,7 +467,7 @@ Configuration updates
|
|
467
467
|
|
468
468
|
> **validateActionCode**(`actionCode`): `boolean`
|
469
469
|
|
470
|
-
Defined in: [protocol.ts:86](https://github.com/otaprotocol/actioncodes/blob/
|
470
|
+
Defined in: [protocol.ts:86](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L86)
|
471
471
|
|
472
472
|
Validate an action code
|
473
473
|
|
@@ -491,7 +491,7 @@ True if valid
|
|
491
491
|
|
492
492
|
> **validateTransaction**(`transaction`, `chain`, `authorities`, `expectedPrefix?`): `boolean`
|
493
493
|
|
494
|
-
Defined in: [protocol.ts:277](https://github.com/otaprotocol/actioncodes/blob/
|
494
|
+
Defined in: [protocol.ts:277](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L277)
|
495
495
|
|
496
496
|
Validate a transaction with protocol meta
|
497
497
|
|
@@ -533,7 +533,7 @@ True if transaction is valid
|
|
533
533
|
|
534
534
|
> **validateTransactionTyped**\<`T`\>(`transaction`, `chain`, `authorities`, `expectedPrefix?`): `boolean`
|
535
535
|
|
536
|
-
Defined in: [protocol.ts:299](https://github.com/otaprotocol/actioncodes/blob/
|
536
|
+
Defined in: [protocol.ts:299](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L299)
|
537
537
|
|
538
538
|
Type-safe transaction validation for specific chains
|
539
539
|
|
@@ -581,7 +581,7 @@ True if transaction is valid
|
|
581
581
|
|
582
582
|
> `static` **create**(): `ActionCodesProtocol`
|
583
583
|
|
584
|
-
Defined in: [protocol.ts:370](https://github.com/otaprotocol/actioncodes/blob/
|
584
|
+
Defined in: [protocol.ts:370](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L370)
|
585
585
|
|
586
586
|
Create a new protocol instance with default configuration
|
587
587
|
|
@@ -597,7 +597,7 @@ New protocol instance
|
|
597
597
|
|
598
598
|
> `static` **createWithConfig**(`config`): `ActionCodesProtocol`
|
599
599
|
|
600
|
-
Defined in: [protocol.ts:379](https://github.com/otaprotocol/actioncodes/blob/
|
600
|
+
Defined in: [protocol.ts:379](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L379)
|
601
601
|
|
602
602
|
Create a new protocol instance with custom configuration
|
603
603
|
|
@@ -6,7 +6,7 @@
|
|
6
6
|
|
7
7
|
# Interface: ProtocolConfig
|
8
8
|
|
9
|
-
Defined in: [protocol.ts:10](https://github.com/otaprotocol/actioncodes/blob/
|
9
|
+
Defined in: [protocol.ts:10](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L10)
|
10
10
|
|
11
11
|
OTA Protocol Configuration
|
12
12
|
|
@@ -16,7 +16,7 @@ OTA Protocol Configuration
|
|
16
16
|
|
17
17
|
> **codeLength**: `number`
|
18
18
|
|
19
|
-
Defined in: [protocol.ts:18](https://github.com/otaprotocol/actioncodes/blob/
|
19
|
+
Defined in: [protocol.ts:18](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L18)
|
20
20
|
|
21
21
|
Code length in digits
|
22
22
|
|
@@ -26,7 +26,7 @@ Code length in digits
|
|
26
26
|
|
27
27
|
> **codeTTL**: `number`
|
28
28
|
|
29
|
-
Defined in: [protocol.ts:16](https://github.com/otaprotocol/actioncodes/blob/
|
29
|
+
Defined in: [protocol.ts:16](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L16)
|
30
30
|
|
31
31
|
Code TTL in milliseconds
|
32
32
|
|
@@ -36,7 +36,7 @@ Code TTL in milliseconds
|
|
36
36
|
|
37
37
|
> **defaultPrefix**: `string`
|
38
38
|
|
39
|
-
Defined in: [protocol.ts:14](https://github.com/otaprotocol/actioncodes/blob/
|
39
|
+
Defined in: [protocol.ts:14](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L14)
|
40
40
|
|
41
41
|
Default prefix for action codes
|
42
42
|
|
@@ -46,7 +46,7 @@ Default prefix for action codes
|
|
46
46
|
|
47
47
|
> **maxPrefixLength**: `number`
|
48
48
|
|
49
|
-
Defined in: [protocol.ts:20](https://github.com/otaprotocol/actioncodes/blob/
|
49
|
+
Defined in: [protocol.ts:20](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L20)
|
50
50
|
|
51
51
|
Maximum prefix length
|
52
52
|
|
@@ -56,7 +56,7 @@ Maximum prefix length
|
|
56
56
|
|
57
57
|
> **minPrefixLength**: `number`
|
58
58
|
|
59
|
-
Defined in: [protocol.ts:22](https://github.com/otaprotocol/actioncodes/blob/
|
59
|
+
Defined in: [protocol.ts:22](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L22)
|
60
60
|
|
61
61
|
Minimum prefix length
|
62
62
|
|
@@ -66,6 +66,6 @@ Minimum prefix length
|
|
66
66
|
|
67
67
|
> **version**: `string`
|
68
68
|
|
69
|
-
Defined in: [protocol.ts:12](https://github.com/otaprotocol/actioncodes/blob/
|
69
|
+
Defined in: [protocol.ts:12](https://github.com/otaprotocol/actioncodes/blob/57f8663219c9af5c455731c797e721cd72058ff4/src/protocol.ts#L12)
|
70
70
|
|
71
71
|
Protocol version
|