SimpleSignature
open class SimpleSignature : Disposable, AutoCloseable, SimpleSignatureInterface
A basic signature
This enumeration defines the set of simple or basic signature schemes supported by IOTA. Most signature schemes supported by IOTA end up comprising of a at least one simple signature scheme.
BCS
The BCS serialized form for this type is defined by the following ABNF:
simple-signature = bytes ; where the contents of the bytes are defined by
; <simple-signature-body>
simple-signature-body = (ed25519-flag ed25519-signature ed25519-public-key) /
(secp256k1-flag secp256k1-signature secp256k1-public-key) /
(secp256r1-flag secp256r1-signature secp256r1-public-key)
Note: Due to historical reasons, signatures are serialized slightly different from the majority of the types in IOTA. In particular if a signature is ever embedded in another structure it generally is serialized as bytes meaning it has a length prefix that defines the length of the completely serialized signature.
Functions
| Name | Summary |
|---|---|
| close | @Synchronized open override fun close() |
| destroy | open override fun destroy() |
| ed25519PubKey | open override fun ed25519PubKey(): Ed25519PublicKey |
| ed25519PubKeyOpt | open override fun ed25519PubKeyOpt(): Ed25519PublicKey? |
| ed25519Sig | open override fun ed25519Sig(): Ed25519Signature |
| ed25519SigOpt | open override fun ed25519SigOpt(): Ed25519Signature? |
| equals | open operator override fun equals(other: Any?): Boolean |
| hashCode | open override fun hashCode(): Int |
| isEd25519 | open override fun isEd25519(): Boolean |
| isSecp256k1 | open override fun isSecp256k1(): Boolean |
| isSecp256r1 | open override fun isSecp256r1(): Boolean |
| scheme | open override fun scheme(): SignatureScheme |
| secp256k1PubKey | open override fun secp256k1PubKey(): Secp256k1PublicKey |
| secp256k1PubKeyOpt | open override fun secp256k1PubKeyOpt(): Secp256k1PublicKey? |
| secp256k1Sig | open override fun secp256k1Sig(): Secp256k1Signature |
| secp256k1SigOpt | open override fun secp256k1SigOpt(): Secp256k1Signature? |
| secp256r1PubKey | open override fun secp256r1PubKey(): Secp256r1PublicKey |
| secp256r1PubKeyOpt | open override fun secp256r1PubKeyOpt(): Secp256r1PublicKey? |
| secp256r1Sig | open override fun secp256r1Sig(): Secp256r1Signature |
| secp256r1SigOpt | open override fun secp256r1SigOpt(): Secp256r1Signature? |
| signatureBytes | open override fun signatureBytes(): ByteArray The raw signature bytes, without the scheme flag or the public key. |
| toBase64 | open override fun toBase64(): String Base64-encode this signature as its `flag |
| toBytes | open override fun toBytes(): ByteArray |
| toPublicKey | open override fun toPublicKey(): PublicKey The public key embedded in this signature. |
| toString | open override fun toString(): String |
Companion object functions
| Name | Summary |
|---|---|
| fromBase64 | fun fromBase64(base64: String): SimpleSignature Decode a signature from the Base64 form produced by to_base64, i.e. base64 over the `flag |
| newEd25519 | fun newEd25519(signature: Ed25519Signature, publicKey: Ed25519PublicKey): SimpleSignature |
| newSecp256k1 | fun newSecp256k1(signature: Secp256k1Signature, publicKey: Secp256k1PublicKey): SimpleSignature |
| newSecp256r1 | fun newSecp256r1(signature: Secp256r1Signature, publicKey: Secp256r1PublicKey): SimpleSignature |