npm - @actioncodes/protocol - Versions diffs - 1.2.2 → 2.0.1 - Mend

@actioncodes/protocol 1.2.2 → 2.0.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.

Files changed (144) hide show

package/LICENSE +1 -1
package/README.md +318 -33
package/dist/ActionCodesProtocol.d.ts +37 -0
package/dist/ActionCodesProtocol.d.ts.map +1 -0
package/dist/adapters/BaseChainAdapter.d.ts +22 -0
package/dist/adapters/BaseChainAdapter.d.ts.map +1 -0
package/dist/adapters/SolanaAdapter.d.ts +44 -0
package/dist/adapters/SolanaAdapter.d.ts.map +1 -0
package/dist/constants.d.ts +6 -8
package/dist/constants.d.ts.map +1 -1
package/dist/errors.d.ts +63 -0
package/dist/errors.d.ts.map +1 -0
package/dist/index.cjs +3 -0
package/dist/index.cjs.map +25 -0
package/dist/index.d.ts +10 -8
package/dist/index.d.ts.map +1 -1
package/dist/index.js +3 -36
package/dist/index.js.map +25 -0
package/dist/strategy/DelegationStrategy.d.ts +45 -0
package/dist/strategy/DelegationStrategy.d.ts.map +1 -0
package/dist/strategy/WalletStrategy.d.ts +8 -0
package/dist/strategy/WalletStrategy.d.ts.map +1 -0
package/dist/types.d.ts +40 -0
package/dist/types.d.ts.map +1 -0
package/dist/utils/canonical.d.ts +5 -0
package/dist/utils/canonical.d.ts.map +1 -0
package/dist/utils/crypto.d.ts +13 -0
package/dist/utils/crypto.d.ts.map +1 -0
package/dist/utils/protocolMeta.d.ts +16 -0
package/dist/utils/protocolMeta.d.ts.map +1 -0
package/docs/ActionCodesProtocol/README.md +11 -0
package/docs/ActionCodesProtocol/classes/ActionCodesProtocol.md +147 -0
package/docs/README.md +10 -50
package/docs/adapters/BaseChainAdapter/README.md +20 -0
package/docs/adapters/BaseChainAdapter/classes/BaseChainAdapter.md +56 -0
package/docs/adapters/BaseChainAdapter/interfaces/BaseContext.md +17 -0
package/docs/adapters/BaseChainAdapter/interfaces/ChainAdapter.md +33 -0
package/docs/adapters/BaseChainAdapter/type-aliases/ChainContext.md +23 -0
package/docs/adapters/NodeCryptoAdapter/README.md +15 -0
package/docs/adapters/NodeCryptoAdapter/classes/NodeCryptoAdapter.md +254 -0
package/docs/adapters/NodeCryptoAdapter/type-aliases/NodeCryptoContext.md +27 -0
package/docs/adapters/SolanaAdapter/README.md +16 -0
package/docs/adapters/SolanaAdapter/classes/SolanaAdapter.md +190 -0
package/docs/adapters/SolanaAdapter/type-aliases/SolanaContext.md +27 -0
package/docs/adapters/SolanaAdapter/type-aliases/SolanaTransaction.md +13 -0
package/docs/constants/README.md +8 -13
package/docs/constants/variables/CODE_CHARSET_DIGITS.md +11 -0
package/docs/constants/variables/CODE_DEFAULT_LENGTH.md +11 -0
package/docs/constants/variables/CODE_MAX_LENGTH.md +11 -0
package/docs/constants/variables/CODE_MIN_LENGTH.md +11 -0
package/docs/constants/variables/PROTOCOL_META_MAX_BYTES.md +11 -0
package/docs/constants/variables/PROTOCOL_NORMALIZATION.md +11 -0
package/docs/constants/variables/SUPPORTED_CHAINS.md +3 -3
package/docs/errors/README.md +22 -0
package/docs/errors/classes/ExpiredCodeError.md +695 -0
package/docs/errors/classes/InvalidCodeFormatError.md +691 -0
package/docs/errors/classes/InvalidPubkeyFormatError.md +691 -0
package/docs/errors/classes/InvalidSignatureError.md +687 -0
package/docs/errors/classes/MetaMismatchError.md +695 -0
package/docs/errors/classes/MissingMetaError.md +681 -0
package/docs/errors/classes/ProtocolError.md +637 -0
package/docs/errors/classes/TransactionNotSignedByIntendedOwnerError.md +691 -0
package/docs/errors/enumerations/ProtocolErrorCode.md +121 -0
package/docs/index/README.md +83 -41
package/docs/modules.md +12 -9
package/docs/strategy/WalletStrategy/README.md +11 -0
package/docs/strategy/WalletStrategy/classes/WalletStrategy.md +67 -0
package/docs/types/README.md +14 -0
package/docs/types/interfaces/ActionCode.md +65 -0
package/docs/types/interfaces/CanonicalMessageParts.md +33 -0
package/docs/types/interfaces/CodeGenerationConfig.md +33 -0
package/docs/types/interfaces/CodeGenerationResult.md +25 -0
package/docs/utils/canonical/README.md +16 -0
package/docs/utils/canonical/functions/serializeCanonical.md +21 -0
package/docs/utils/canonical/variables/CANONICAL_MESSAGE_PREFIX.md +11 -0
package/docs/utils/canonical/variables/CANONICAL_MESSAGE_VERSION.md +11 -0
package/docs/utils/crypto/README.md +18 -0
package/docs/utils/crypto/functions/base32EncodeCrockford.md +21 -0
package/docs/utils/crypto/functions/codeHash.md +21 -0
package/docs/utils/crypto/functions/digestToDigits.md +25 -0
package/docs/utils/crypto/functions/generateRandomSecret.md +15 -0
package/docs/utils/crypto/functions/hkdfSha256.md +35 -0
package/docs/utils/crypto/functions/hmacSha256.md +25 -0
package/docs/utils/crypto/functions/sha256.md +21 -0
package/docs/utils/crypto/functions/truncateBits.md +25 -0
package/docs/utils/protocolMeta/README.md +21 -0
package/docs/utils/protocolMeta/functions/buildProtocolMeta.md +21 -0
package/docs/utils/protocolMeta/functions/parseProtocolMeta.md +21 -0
package/docs/utils/protocolMeta/functions/validateProtocolMetaFormat.md +21 -0
package/docs/utils/protocolMeta/interfaces/ProtocolMetaFields.md +41 -0
package/docs/utils/protocolMeta/variables/SCHEME.md +11 -0
package/package.json +42 -47
package/dist/actioncode.d.ts +0 -120
package/dist/actioncode.d.ts.map +0 -1
package/dist/actioncode.js +0 -186
package/dist/adapters/base.d.ts +0 -93
package/dist/adapters/base.d.ts.map +0 -1
package/dist/adapters/base.js +0 -65
package/dist/adapters/solana/index.d.ts +0 -2
package/dist/adapters/solana/index.d.ts.map +0 -1
package/dist/adapters/solana/index.js +0 -30
package/dist/adapters/solana/solana.d.ts +0 -113
package/dist/adapters/solana/solana.d.ts.map +0 -1
package/dist/adapters/solana/solana.js +0 -537
package/dist/codegen.d.ts +0 -76
package/dist/codegen.d.ts.map +0 -1
package/dist/codegen.js +0 -211
package/dist/constants.js +0 -24
package/dist/meta.d.ts +0 -54
package/dist/meta.d.ts.map +0 -1
package/dist/meta.js +0 -104
package/dist/protocol.d.ts +0 -179
package/dist/protocol.d.ts.map +0 -1
package/dist/protocol.js +0 -390
package/docs/_media/LICENSE +0 -201
package/docs/_media/README.md +0 -28
package/docs/actioncode/README.md +0 -21
package/docs/actioncode/classes/ActionCode.md +0 -430
package/docs/actioncode/interfaces/ActionCodeFields.md +0 -89
package/docs/actioncode/interfaces/ActionCodeMetadata.md +0 -25
package/docs/actioncode/interfaces/ActionCodeTransaction.md +0 -57
package/docs/actioncode/type-aliases/ActionCodeStatus.md +0 -11
package/docs/adapters/base/README.md +0 -11
package/docs/adapters/base/classes/BaseChainAdapter.md +0 -396
package/docs/adapters/solana/README.md +0 -19
package/docs/adapters/solana/solana/README.md +0 -15
package/docs/adapters/solana/solana/classes/SolanaAdapter.md +0 -506
package/docs/adapters/solana/solana/type-aliases/SolanaTransaction.md +0 -13
package/docs/codegen/README.md +0 -11
package/docs/codegen/classes/CodeGenerator.md +0 -341
package/docs/constants/type-aliases/SupportedChain.md +0 -11
package/docs/constants/variables/CODE_LENGTH.md +0 -11
package/docs/constants/variables/CODE_TTL.md +0 -11
package/docs/constants/variables/MAX_PREFIX_LENGTH.md +0 -11
package/docs/constants/variables/MIN_PREFIX_LENGTH.md +0 -11
package/docs/constants/variables/PROTOCOL_CODE_PREFIX.md +0 -11
package/docs/constants/variables/PROTOCOL_PREFIX.md +0 -11
package/docs/constants/variables/PROTOCOL_VERSION.md +0 -11
package/docs/meta/README.md +0 -15
package/docs/meta/classes/ProtocolMetaParser.md +0 -177
package/docs/meta/interfaces/ProtocolMetaV1.md +0 -59
package/docs/protocol/README.md +0 -51
package/docs/protocol/classes/ActionCodesProtocol.md +0 -676
package/docs/protocol/interfaces/ProtocolConfig.md +0 -71

package/docs/actioncode/classes/ActionCode.md DELETED Viewed

@@ -1,430 +0,0 @@
-[**@actioncodes/protocol**](../../README.md)
-***
-[@actioncodes/protocol](../../modules.md) / [actioncode](../README.md) / ActionCode
-# Class: ActionCode
-Defined in: [actioncode.ts:35](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L35)
-## Constructors
-### Constructor
-> **new ActionCode**(`fields`): `ActionCode`
-Defined in: [actioncode.ts:36](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L36)
-#### Parameters
-##### fields
-[`ActionCodeFields`](../interfaces/ActionCodeFields.md)
-#### Returns
-`ActionCode`
-## Accessors
-### chain
-#### Get Signature
-> **get** **chain**(): `string`
-Defined in: [actioncode.ts:102](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L102)
-Get the target chain for this action code
-##### Returns
-`string`
-Chain identifier (e.g., "solana", "evm")
-***
-### code
-#### Get Signature
-> **get** **code**(): `string`
-Defined in: [actioncode.ts:118](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L118)
-Get the action code string
-##### Returns
-`string`
-The 8-character action code
-***
-### codeHash
-#### Get Signature
-> **get** **codeHash**(): `string`
-Defined in: [actioncode.ts:224](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L224)
-Get the code hash for this action code
-it is also used in the protocol meta as the code id
-##### Returns
-`string`
-Code hash string
-***
-### description
-#### Get Signature
-> **get** **description**(): `undefined` \| `string`
-Defined in: [actioncode.ts:158](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L158)
-Get a human-readable description of the action
-##### Returns
-`undefined` \| `string`
-Description string or undefined
-***
-### displayString
-#### Get Signature
-> **get** **displayString**(): `string`
-Defined in: [actioncode.ts:190](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L190)
-Get a human-readable display string for the action code
-##### Returns
-`string`
-Formatted display string
-***
-### encoded
-#### Get Signature
-> **get** **encoded**(): `string`
-Defined in: [actioncode.ts:50](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L50)
-##### Returns
-`string`
-***
-### expired
-#### Get Signature
-> **get** **expired**(): `boolean`
-Defined in: [actioncode.ts:94](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L94)
-Check if the action code has expired
-##### Returns
-`boolean`
-True if the code has expired
-***
-### intentType
-#### Get Signature
-> **get** **intentType**(): `"transaction"` \| `"sign-only"`
-Defined in: [actioncode.ts:228](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L228)
-##### Returns
-`"transaction"` \| `"sign-only"`
-***
-### json
-#### Get Signature
-> **get** **json**(): [`ActionCodeFields`](../interfaces/ActionCodeFields.md)
-Defined in: [actioncode.ts:75](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L75)
-##### Returns
-[`ActionCodeFields`](../interfaces/ActionCodeFields.md)
-***
-### metadata
-#### Get Signature
-> **get** **metadata**(): `undefined` \| [`ActionCodeMetadata`](../interfaces/ActionCodeMetadata.md)
-Defined in: [actioncode.ts:150](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L150)
-Get metadata associated with this action code
-##### Returns
-`undefined` \| [`ActionCodeMetadata`](../interfaces/ActionCodeMetadata.md)
-Metadata object or undefined
-***
-### params
-#### Get Signature
-> **get** **params**(): `undefined` \| `Record`\<`string`, `any`\>
-Defined in: [actioncode.ts:166](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L166)
-Get parameters associated with this action
-##### Returns
-`undefined` \| `Record`\<`string`, `any`\>
-Parameters object or undefined
-***
-### prefix
-#### Get Signature
-> **get** **prefix**(): `string`
-Defined in: [actioncode.ts:126](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L126)
-Get the prefix used for this action code
-##### Returns
-`string`
-Normalized prefix
-***
-### pubkey
-#### Get Signature
-> **get** **pubkey**(): `string`
-Defined in: [actioncode.ts:134](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L134)
-Get the user's public key
-##### Returns
-`string`
-User's public key
-***
-### remainingTime
-#### Get Signature
-> **get** **remainingTime**(): `number`
-Defined in: [actioncode.ts:85](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L85)
-Get remaining time in milliseconds until expiration
-##### Returns
-`number`
-Remaining time in milliseconds, or 0 if expired
-***
-### remainingTimeString
-#### Get Signature
-> **get** **remainingTimeString**(): `string`
-Defined in: [actioncode.ts:203](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L203)
-Get a formatted time string showing remaining time
-##### Returns
-`string`
-Human-readable time string (e.g., "1m 30s remaining")
-***
-### signature
-#### Get Signature
-> **get** **signature**(): `string`
-Defined in: [actioncode.ts:182](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L182)
-Get the user's signature
-##### Returns
-`string`
-User's signature string
-***
-### status
-#### Get Signature
-> **get** **status**(): [`ActionCodeStatus`](../type-aliases/ActionCodeStatus.md)
-Defined in: [actioncode.ts:110](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L110)
-Get the current status of the action code
-##### Returns
-[`ActionCodeStatus`](../type-aliases/ActionCodeStatus.md)
-Current status
-***
-### timestamp
-#### Get Signature
-> **get** **timestamp**(): `number`
-Defined in: [actioncode.ts:174](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L174)
-Get the timestamp when the code was generated
-##### Returns
-`number`
-Timestamp in milliseconds
-***
-### transaction
-#### Get Signature
-> **get** **transaction**(): `undefined` \| [`ActionCodeTransaction`](../interfaces/ActionCodeTransaction.md)
-Defined in: [actioncode.ts:142](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L142)
-Get the transaction data (chain-specific)
-##### Returns
-`undefined` \| [`ActionCodeTransaction`](../interfaces/ActionCodeTransaction.md)
-Transaction data or undefined
-## Methods
-### isValid()
-> **isValid**(`protocol`): `boolean`
-Defined in: [actioncode.ts:54](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L54)
-#### Parameters
-##### protocol
-[`ActionCodesProtocol`](../../protocol/classes/ActionCodesProtocol.md)
-#### Returns
-`boolean`
-***
-### updateStatus()
-> **updateStatus**(`status`): `void`
-Defined in: [actioncode.ts:71](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L71)
-#### Parameters
-##### status
-[`ActionCodeStatus`](../type-aliases/ActionCodeStatus.md)
-#### Returns
-`void`
-***
-### fromEncoded()
-> `static` **fromEncoded**(`encoded`): `ActionCode`
-Defined in: [actioncode.ts:45](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L45)
-#### Parameters
-##### encoded
-`string`
-#### Returns
-`ActionCode`
-***
-### fromPayload()
-> `static` **fromPayload**(`input`): `ActionCode`
-Defined in: [actioncode.ts:38](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L38)
-#### Parameters
-##### input
-[`ActionCodeFields`](../interfaces/ActionCodeFields.md)
-#### Returns
-`ActionCode`

package/docs/actioncode/interfaces/ActionCodeFields.md DELETED Viewed

@@ -1,89 +0,0 @@
-[**@actioncodes/protocol**](../../README.md)
-***
-[@actioncodes/protocol](../../modules.md) / [actioncode](../README.md) / ActionCodeFields
-# Interface: ActionCodeFields
-Defined in: [actioncode.ts:22](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L22)
-## Properties
-### chain
-> **chain**: `"solana"`
-Defined in: [actioncode.ts:28](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L28)
-***
-### code
-> **code**: `string`
-Defined in: [actioncode.ts:23](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L23)
-***
-### expiresAt
-> **expiresAt**: `number`
-Defined in: [actioncode.ts:31](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L31)
-***
-### metadata?
-> `optional` **metadata**: [`ActionCodeMetadata`](ActionCodeMetadata.md)
-Defined in: [actioncode.ts:30](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L30)
-***
-### prefix
-> **prefix**: `string`
-Defined in: [actioncode.ts:24](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L24)
-***
-### pubkey
-> **pubkey**: `string`
-Defined in: [actioncode.ts:25](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L25)
-***
-### signature
-> **signature**: `string`
-Defined in: [actioncode.ts:27](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L27)
-***
-### status
-> **status**: [`ActionCodeStatus`](../type-aliases/ActionCodeStatus.md)
-Defined in: [actioncode.ts:32](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L32)
-***
-### timestamp
-> **timestamp**: `number`
-Defined in: [actioncode.ts:26](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L26)
-***
-### transaction?
-> `optional` **transaction**: [`ActionCodeTransaction`](ActionCodeTransaction.md)
-Defined in: [actioncode.ts:29](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L29)

package/docs/actioncode/interfaces/ActionCodeMetadata.md DELETED Viewed

@@ -1,25 +0,0 @@
-[**@actioncodes/protocol**](../../README.md)
-***
-[@actioncodes/protocol](../../modules.md) / [actioncode](../README.md) / ActionCodeMetadata
-# Interface: ActionCodeMetadata
-Defined in: [actioncode.ts:8](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L8)
-## Properties
-### description?
-> `optional` **description**: `string`
-Defined in: [actioncode.ts:9](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L9)
-***
-### params?
-> `optional` **params**: `Record`\<`string`, `any`\>
-Defined in: [actioncode.ts:10](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L10)

package/docs/actioncode/interfaces/ActionCodeTransaction.md DELETED Viewed

@@ -1,57 +0,0 @@
-[**@actioncodes/protocol**](../../README.md)
-***
-[@actioncodes/protocol](../../modules.md) / [actioncode](../README.md) / ActionCodeTransaction
-# Interface: ActionCodeTransaction
-Defined in: [actioncode.ts:13](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L13)
-## Properties
-### intentType?
-> `optional` **intentType**: `"transaction"` \| `"sign-only"`
-Defined in: [actioncode.ts:19](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L19)
-***
-### message?
-> `optional` **message**: `string`
-Defined in: [actioncode.ts:17](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L17)
-***
-### signedMessage?
-> `optional` **signedMessage**: `string`
-Defined in: [actioncode.ts:18](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L18)
-***
-### transaction?
-> `optional` **transaction**: `string`
-Defined in: [actioncode.ts:14](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L14)
-***
-### txSignature?
-> `optional` **txSignature**: `string`
-Defined in: [actioncode.ts:15](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L15)
-***
-### txType?
-> `optional` **txType**: `string`
-Defined in: [actioncode.ts:16](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L16)

package/docs/actioncode/type-aliases/ActionCodeStatus.md DELETED Viewed

@@ -1,11 +0,0 @@
-[**@actioncodes/protocol**](../../README.md)
-***
-[@actioncodes/protocol](../../modules.md) / [actioncode](../README.md) / ActionCodeStatus
-# Type Alias: ActionCodeStatus
-> **ActionCodeStatus** = `"pending"` \| `"resolved"` \| `"finalized"` \| `"expired"` \| `"error"`
-Defined in: [actioncode.ts:6](https://github.com/otaprotocol/actioncodes/blob/7fa582d3aecdeca51131d2fc9eec0802298f9a4d/src/actioncode.ts#L6)

package/docs/adapters/base/README.md DELETED Viewed

@@ -1,11 +0,0 @@
-[**@actioncodes/protocol**](../../README.md)
-***
-[@actioncodes/protocol](../../modules.md) / adapters/base
-# adapters/base
-## Classes
-- [BaseChainAdapter](classes/BaseChainAdapter.md)