@actioncodes/protocol 1.1.6 → 1.2.0
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/actioncode.d.ts +4 -0
- package/dist/actioncode.d.ts.map +1 -1
- package/dist/actioncode.js +3 -0
- package/dist/adapters/base.d.ts +1 -0
- package/dist/adapters/base.d.ts.map +1 -1
- package/dist/adapters/solana/solana.d.ts +8 -0
- package/dist/adapters/solana/solana.d.ts.map +1 -1
- package/dist/adapters/solana/solana.js +30 -7
- package/dist/protocol.d.ts +13 -4
- package/dist/protocol.d.ts.map +1 -1
- package/dist/protocol.js +85 -18
- package/docs/actioncode/classes/ActionCode.md +37 -23
- package/docs/actioncode/interfaces/ActionCodeFields.md +11 -11
- package/docs/actioncode/interfaces/ActionCodeMetadata.md +3 -3
- package/docs/actioncode/interfaces/ActionCodeTransaction.md +28 -4
- package/docs/actioncode/type-aliases/ActionCodeStatus.md +1 -1
- package/docs/adapters/base/classes/BaseChainAdapter.md +39 -13
- package/docs/adapters/solana/solana/classes/SolanaAdapter.md +55 -15
- 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 +68 -26
- 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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/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/a8b35c1
|
|
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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/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/a8b35c1
|
|
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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/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/a8b35c1
|
|
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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/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/a8b35c1
|
|
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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/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/a8b35c13
|
|
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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L35)
|
23
23
|
|
24
24
|
#### Parameters
|
25
25
|
|
@@ -33,11 +33,53 @@ Defined in: [protocol.ts:35](https://github.com/otaprotocol/actioncodes/blob/a8b
|
|
33
33
|
|
34
34
|
## Methods
|
35
35
|
|
36
|
+
### attachMessage()
|
37
|
+
|
38
|
+
> **attachMessage**(`actionCode`, `message`, `params?`, `messageType?`): [`ActionCode`](../../actioncode/classes/ActionCode.md)
|
39
|
+
|
40
|
+
Defined in: [protocol.ts:226](https://github.com/otaprotocol/actioncodes/blob/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L226)
|
41
|
+
|
42
|
+
Attach a message to an action code (sign-only mode, resolved state)
|
43
|
+
|
44
|
+
#### Parameters
|
45
|
+
|
46
|
+
##### actionCode
|
47
|
+
|
48
|
+
[`ActionCode`](../../actioncode/classes/ActionCode.md)
|
49
|
+
|
50
|
+
ActionCode to attach message to
|
51
|
+
|
52
|
+
##### message
|
53
|
+
|
54
|
+
`string`
|
55
|
+
|
56
|
+
The message that will be signed
|
57
|
+
|
58
|
+
##### params?
|
59
|
+
|
60
|
+
`string`
|
61
|
+
|
62
|
+
Optional parameters for protocol meta
|
63
|
+
|
64
|
+
##### messageType?
|
65
|
+
|
66
|
+
`string`
|
67
|
+
|
68
|
+
Optional message type
|
69
|
+
|
70
|
+
#### Returns
|
71
|
+
|
72
|
+
[`ActionCode`](../../actioncode/classes/ActionCode.md)
|
73
|
+
|
74
|
+
Updated ActionCode with transaction containing message
|
75
|
+
|
76
|
+
***
|
77
|
+
|
36
78
|
### attachTransaction()
|
37
79
|
|
38
80
|
> **attachTransaction**(`actionCode`, `transaction`, `issuer`, `params?`, `txType?`): [`ActionCode`](../../actioncode/classes/ActionCode.md)
|
39
81
|
|
40
|
-
Defined in: [protocol.ts:
|
82
|
+
Defined in: [protocol.ts:168](https://github.com/otaprotocol/actioncodes/blob/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L168)
|
41
83
|
|
42
84
|
Attach a transaction to an action code with automatic protocol meta injection
|
43
85
|
|
@@ -85,7 +127,7 @@ Updated ActionCode with injected protocol meta
|
|
85
127
|
|
86
128
|
> **createActionCode**(`pubkey`, `signFn`, `chain`, `prefix`, `timestamp?`): `Promise`\<[`ActionCode`](../../actioncode/classes/ActionCode.md)\>
|
87
129
|
|
88
|
-
Defined in: [protocol.ts:
|
130
|
+
Defined in: [protocol.ts:116](https://github.com/otaprotocol/actioncodes/blob/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L116)
|
89
131
|
|
90
132
|
Create an action code
|
91
133
|
|
@@ -133,7 +175,7 @@ Promise resolving to a complete ActionCode object
|
|
133
175
|
|
134
176
|
> **createProtocolMeta**(`actionCode`, `issuer?`, `params?`, `timestamp?`): [`ProtocolMetaV1`](../../meta/interfaces/ProtocolMetaV1.md)
|
135
177
|
|
136
|
-
Defined in: [protocol.ts:
|
178
|
+
Defined in: [protocol.ts:314](https://github.com/otaprotocol/actioncodes/blob/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L314)
|
137
179
|
|
138
180
|
Create protocol meta for a transaction
|
139
181
|
|
@@ -175,7 +217,7 @@ ProtocolMetaV1 object
|
|
175
217
|
|
176
218
|
> **decodeProtocolMeta**(`transaction`, `chain`): `null` \| [`ProtocolMetaV1`](../../meta/interfaces/ProtocolMetaV1.md)
|
177
219
|
|
178
|
-
Defined in: [protocol.ts:
|
220
|
+
Defined in: [protocol.ts:350](https://github.com/otaprotocol/actioncodes/blob/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L350)
|
179
221
|
|
180
222
|
Decode protocol meta from a transaction
|
181
223
|
|
@@ -205,7 +247,7 @@ Decoded ProtocolMetaV1 or null
|
|
205
247
|
|
206
248
|
> **decodeProtocolMetaTyped**\<`T`\>(`transaction`, `chain`): `null` \| [`ProtocolMetaV1`](../../meta/interfaces/ProtocolMetaV1.md)
|
207
249
|
|
208
|
-
Defined in: [protocol.ts:
|
250
|
+
Defined in: [protocol.ts:432](https://github.com/otaprotocol/actioncodes/blob/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L432)
|
209
251
|
|
210
252
|
Decode protocol meta with type safety
|
211
253
|
|
@@ -241,7 +283,7 @@ Decoded ProtocolMetaV1 or null
|
|
241
283
|
|
242
284
|
> **detectTampering**\<`T`\>(`transaction`, `chain`, `authorities`, `expectedPrefix?`): `boolean`
|
243
285
|
|
244
|
-
Defined in: [protocol.ts:
|
286
|
+
Defined in: [protocol.ts:412](https://github.com/otaprotocol/actioncodes/blob/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L412)
|
245
287
|
|
246
288
|
Detect tampered transactions with type safety
|
247
289
|
|
@@ -289,7 +331,7 @@ True if transaction is valid and not tampered
|
|
289
331
|
|
290
332
|
> **encodeProtocolMeta**(`meta`, `chain`): `any`
|
291
333
|
|
292
|
-
Defined in: [protocol.ts:
|
334
|
+
Defined in: [protocol.ts:335](https://github.com/otaprotocol/actioncodes/blob/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L335)
|
293
335
|
|
294
336
|
Encode protocol meta for a specific chain
|
295
337
|
|
@@ -317,11 +359,11 @@ Chain-specific encoded meta
|
|
317
359
|
|
318
360
|
### finalizeActionCode()
|
319
361
|
|
320
|
-
> **finalizeActionCode**(`actionCode`, `
|
362
|
+
> **finalizeActionCode**(`actionCode`, `signature`): [`ActionCode`](../../actioncode/classes/ActionCode.md)
|
321
363
|
|
322
|
-
Defined in: [protocol.ts:
|
364
|
+
Defined in: [protocol.ts:264](https://github.com/otaprotocol/actioncodes/blob/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L264)
|
323
365
|
|
324
|
-
Finalize an action code
|
366
|
+
Finalize an action code based on its intent type
|
325
367
|
|
326
368
|
#### Parameters
|
327
369
|
|
@@ -331,11 +373,11 @@ Finalize an action code with transaction signature
|
|
331
373
|
|
332
374
|
ActionCode to finalize
|
333
375
|
|
334
|
-
#####
|
376
|
+
##### signature
|
335
377
|
|
336
378
|
`string`
|
337
379
|
|
338
|
-
Transaction signature
|
380
|
+
Transaction signature (for transaction intent) or signed message (for sign-only intent)
|
339
381
|
|
340
382
|
#### Returns
|
341
383
|
|
@@ -349,7 +391,7 @@ Updated ActionCode
|
|
349
391
|
|
350
392
|
> **getChainAdapter**\<`T`\>(`chain`): `undefined` \| [`BaseChainAdapter`](../../adapters/base/classes/BaseChainAdapter.md)\<`T`\>
|
351
393
|
|
352
|
-
Defined in: [protocol.ts:77](https://github.com/otaprotocol/actioncodes/blob/
|
394
|
+
Defined in: [protocol.ts:77](https://github.com/otaprotocol/actioncodes/blob/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L77)
|
353
395
|
|
354
396
|
Get chain adapter with proper typing
|
355
397
|
|
@@ -379,7 +421,7 @@ Chain adapter or undefined
|
|
379
421
|
|
380
422
|
> **getConfig**(): [`ProtocolConfig`](../interfaces/ProtocolConfig.md)
|
381
423
|
|
382
|
-
Defined in: [protocol.ts:
|
424
|
+
Defined in: [protocol.ts:445](https://github.com/otaprotocol/actioncodes/blob/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L445)
|
383
425
|
|
384
426
|
Get protocol configuration
|
385
427
|
|
@@ -395,7 +437,7 @@ Current protocol configuration
|
|
395
437
|
|
396
438
|
> **getRegisteredChains**(): `string`[]
|
397
439
|
|
398
|
-
Defined in: [protocol.ts:59](https://github.com/otaprotocol/actioncodes/blob/
|
440
|
+
Defined in: [protocol.ts:59](https://github.com/otaprotocol/actioncodes/blob/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L59)
|
399
441
|
|
400
442
|
Get registered chain adapters
|
401
443
|
|
@@ -411,7 +453,7 @@ Array of registered chain identifiers
|
|
411
453
|
|
412
454
|
> **isChainSupported**(`chain`): `boolean`
|
413
455
|
|
414
|
-
Defined in: [protocol.ts:68](https://github.com/otaprotocol/actioncodes/blob/
|
456
|
+
Defined in: [protocol.ts:68](https://github.com/otaprotocol/actioncodes/blob/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L68)
|
415
457
|
|
416
458
|
Check if a chain is supported
|
417
459
|
|
@@ -435,7 +477,7 @@ True if chain is supported
|
|
435
477
|
|
436
478
|
> **registerAdapter**\<`T`\>(`adapter`): `void`
|
437
479
|
|
438
|
-
Defined in: [protocol.ts:51](https://github.com/otaprotocol/actioncodes/blob/
|
480
|
+
Defined in: [protocol.ts:51](https://github.com/otaprotocol/actioncodes/blob/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L51)
|
439
481
|
|
440
482
|
Register a chain adapter
|
441
483
|
|
@@ -463,7 +505,7 @@ Chain adapter implementation
|
|
463
505
|
|
464
506
|
> **updateConfig**(`updates`): `void`
|
465
507
|
|
466
|
-
Defined in: [protocol.ts:
|
508
|
+
Defined in: [protocol.ts:453](https://github.com/otaprotocol/actioncodes/blob/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L453)
|
467
509
|
|
468
510
|
Update protocol configuration
|
469
511
|
|
@@ -485,9 +527,9 @@ Configuration updates
|
|
485
527
|
|
486
528
|
> **validateActionCode**(`actionCode`): `boolean`
|
487
529
|
|
488
|
-
Defined in: [protocol.ts:86](https://github.com/otaprotocol/actioncodes/blob/
|
530
|
+
Defined in: [protocol.ts:86](https://github.com/otaprotocol/actioncodes/blob/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L86)
|
489
531
|
|
490
|
-
Validate an action code
|
532
|
+
Validate an action code, checking intent type and required fields
|
491
533
|
|
492
534
|
#### Parameters
|
493
535
|
|
@@ -509,7 +551,7 @@ True if valid
|
|
509
551
|
|
510
552
|
> **validateTransaction**(`transaction`, `chain`, `authorities`, `expectedPrefix?`): `boolean`
|
511
553
|
|
512
|
-
Defined in: [protocol.ts:
|
554
|
+
Defined in: [protocol.ts:367](https://github.com/otaprotocol/actioncodes/blob/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L367)
|
513
555
|
|
514
556
|
Validate a transaction with protocol meta
|
515
557
|
|
@@ -551,7 +593,7 @@ True if transaction is valid
|
|
551
593
|
|
552
594
|
> **validateTransactionTyped**\<`T`\>(`transaction`, `chain`, `authorities`, `expectedPrefix?`): `boolean`
|
553
595
|
|
554
|
-
Defined in: [protocol.ts:
|
596
|
+
Defined in: [protocol.ts:390](https://github.com/otaprotocol/actioncodes/blob/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L390)
|
555
597
|
|
556
598
|
Type-safe transaction validation for specific chains
|
557
599
|
|
@@ -599,7 +641,7 @@ True if transaction is valid
|
|
599
641
|
|
600
642
|
> `static` **create**(): `ActionCodesProtocol`
|
601
643
|
|
602
|
-
Defined in: [protocol.ts:
|
644
|
+
Defined in: [protocol.ts:461](https://github.com/otaprotocol/actioncodes/blob/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L461)
|
603
645
|
|
604
646
|
Create a new protocol instance with default configuration
|
605
647
|
|
@@ -615,7 +657,7 @@ New protocol instance
|
|
615
657
|
|
616
658
|
> `static` **createWithConfig**(`config`): `ActionCodesProtocol`
|
617
659
|
|
618
|
-
Defined in: [protocol.ts:
|
660
|
+
Defined in: [protocol.ts:470](https://github.com/otaprotocol/actioncodes/blob/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L470)
|
619
661
|
|
620
662
|
Create a new protocol instance with custom configuration
|
621
663
|
|
@@ -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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/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/d0ef10ae3bd279eafa4f9f7708c521c6ab240398/src/protocol.ts#L12)
|
70
70
|
|
71
71
|
Protocol version
|