cosmos-sdk/proto/cosmos/tx/signing/v1beta1/signing.proto

syntax = "proto3";
package cosmos.tx.signing.v1beta1;

import "cosmos/base/crypto/v1beta1/crypto.proto";

option go_package = "github.com/cosmos/cosmos-sdk/types/tx/signing";

// SignMode represents a signing mode with its own security guarantees.
enum SignMode {
    // SIGN_MODE_UNSPECIFIED specifies an unknown signing mode and will be rejected
    SIGN_MODE_UNSPECIFIED = 0;

    // SIGN_MODE_DIRECT specifies a signing mode which uses SignDoc and is verified
    // with raw bytes from Tx
    SIGN_MODE_DIRECT = 1;

    // SIGN_MODE_TEXTUAL is a future signing mode that will verify some human-readable
    // textual representation on top of the binary representation from SIGN_MODE_DIRECT
    SIGN_MODE_TEXTUAL = 2;

    // SIGN_MODE_LEGACY_AMINO_JSON is a backwards compatibility mode which uses
    // Amino JSON and will be removed in the future
    SIGN_MODE_LEGACY_AMINO_JSON = 127;
}

// SignatureDescriptors wraps multiple SignatureDescriptor's.
message SignatureDescriptors {
    // signatures are the signature descriptors
    repeated SignatureDescriptor signatures = 1;
}

// SignatureDescriptor is a convenience type which represents the full data for a
// signature including the public key of the signer, signing modes and the signature
// itself. It is primarily used for coordinating signatures between clients.
message SignatureDescriptor {
    // public_key is the public key of the signer
    cosmos.base.crypto.v1beta1.PublicKey public_key = 1;

    Data data = 2;

    // sequence is the sequence of the account, which describes the
    // number of committed transactions signed by a given address. It is used to prevent
    // replay attacks.
    uint64 sequence = 3;

    // Data represents signature data
    message Data {
        // sum is the oneof that specifies whether this represents single or multi-signature data
        oneof sum {
            // single represents a single signer
            Single single = 1;

            // multi represents a multisig signer
            Multi multi = 2;
        }

        // Single is the signature data for a single signer
        message Single {
            // mode is the signing mode of the single signer
            SignMode mode = 1;

            // signature is the raw signature bytes
            bytes signature = 2;
        }

        // Multi is the signature data for a multisig public key
        message Multi {
            // bitarray specifies which keys within the multisig are signing
            cosmos.base.crypto.v1beta1.CompactBitArray bitarray = 1;

            // signatures is the signatures of the multi-signature
            repeated Data signatures  = 2;
        }
    }
}