Type Alias GenerateSignatureBody

Type Declaration

• {
      blockchainKind?:
          | "Algorand"
          | "Aptos"
          | "Bitcoin"
          | "BitcoinCash"
          | "Canton"
          | "Cardano"
          | "Concordium"
          | "Cosmos"
          | "Evm"
          | "Hedera"
          | "Icp"
          | "Iota"
          | "Kaspa"
          | "Near"
          | "Polymesh"
          | "Solana"
          | "Starknet"
          | "Stellar"
          | "Substrate"
          | "Sui"
          | "Tezos"
          | "Ton"
          | "Tron"
          | "Xrpl";
      externalId?: string;
      hash: string;
      kind: "Hash";
      network?: string;
      taprootMerkleRoot?: string;
  }

  • OptionalblockchainKind?:
        | "Algorand"
        | "Aptos"
        | "Bitcoin"
        | "BitcoinCash"
        | "Canton"
        | "Cardano"
        | "Concordium"
        | "Cosmos"
        | "Evm"
        | "Hedera"
        | "Icp"
        | "Iota"
        | "Kaspa"
        | "Near"
        | "Polymesh"
        | "Solana"
        | "Starknet"
        | "Stellar"
        | "Substrate"
        | "Sui"
        | "Tezos"
        | "Ton"
        | "Tron"
        | "Xrpl"

  • OptionalexternalId?: string

    A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).

  • hash: string

    32-byte hash in hex encoded format.

  • kind: "Hash"

  • Optionalnetwork?: string

  • OptionaltaprootMerkleRoot?: string

    Required when signing with a Schnorr key. Specify the merkle root for tweaking the signing key, or the empty string "" to tweak with the default merkle root.

• {
      blockchainKind?:
          | "Algorand"
          | "Aptos"
          | "Bitcoin"
          | "BitcoinCash"
          | "Canton"
          | "Cardano"
          | "Concordium"
          | "Cosmos"
          | "Evm"
          | "Hedera"
          | "Icp"
          | "Iota"
          | "Kaspa"
          | "Near"
          | "Polymesh"
          | "Solana"
          | "Starknet"
          | "Stellar"
          | "Substrate"
          | "Sui"
          | "Tezos"
          | "Ton"
          | "Tron"
          | "Xrpl";
      externalId?: string;
      kind: "Message";
      message: string;
      network?: string;
  }

  • OptionalblockchainKind?:
        | "Algorand"
        | "Aptos"
        | "Bitcoin"
        | "BitcoinCash"
        | "Canton"
        | "Cardano"
        | "Concordium"
        | "Cosmos"
        | "Evm"
        | "Hedera"
        | "Icp"
        | "Iota"
        | "Kaspa"
        | "Near"
        | "Polymesh"
        | "Solana"
        | "Starknet"
        | "Stellar"
        | "Substrate"
        | "Sui"
        | "Tezos"
        | "Ton"
        | "Tron"
        | "Xrpl"

  • OptionalexternalId?: string

    A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).

  • kind: "Message"

  • message: string

    An arbitrary hex encoded message.

  • Optionalnetwork?: string

• {
      blockchainKind?:
          | "Algorand"
          | "Aptos"
          | "Bitcoin"
          | "BitcoinCash"
          | "Canton"
          | "Cardano"
          | "Concordium"
          | "Cosmos"
          | "Evm"
          | "Hedera"
          | "Icp"
          | "Iota"
          | "Kaspa"
          | "Near"
          | "Polymesh"
          | "Solana"
          | "Starknet"
          | "Stellar"
          | "Substrate"
          | "Sui"
          | "Tezos"
          | "Ton"
          | "Tron"
          | "Xrpl";
      externalId?: string;
      kind: "Transaction";
      network?: string;
      transaction: string
      | {};
  }

  • OptionalblockchainKind?:
        | "Algorand"
        | "Aptos"
        | "Bitcoin"
        | "BitcoinCash"
        | "Canton"
        | "Cardano"
        | "Concordium"
        | "Cosmos"
        | "Evm"
        | "Hedera"
        | "Icp"
        | "Iota"
        | "Kaspa"
        | "Near"
        | "Polymesh"
        | "Solana"
        | "Starknet"
        | "Stellar"
        | "Substrate"
        | "Sui"
        | "Tezos"
        | "Ton"
        | "Tron"
        | "Xrpl"

  • OptionalexternalId?: string

    A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).

  • kind: "Transaction"

  • Optionalnetwork?: string

  • transaction: string | {}

    The unsigned hex-encoded transaction or JSON object for compatible networks

• {
      blockchainKind?:
          | "Algorand"
          | "Aptos"
          | "Bitcoin"
          | "BitcoinCash"
          | "Canton"
          | "Cardano"
          | "Concordium"
          | "Cosmos"
          | "Evm"
          | "Hedera"
          | "Icp"
          | "Iota"
          | "Kaspa"
          | "Near"
          | "Polymesh"
          | "Solana"
          | "Starknet"
          | "Stellar"
          | "Substrate"
          | "Sui"
          | "Tezos"
          | "Ton"
          | "Tron"
          | "Xrpl";
      externalId?: string;
      kind: "Eip191";
      message: string;
      network?: string;
  }

  • OptionalblockchainKind?:
        | "Algorand"
        | "Aptos"
        | "Bitcoin"
        | "BitcoinCash"
        | "Canton"
        | "Cardano"
        | "Concordium"
        | "Cosmos"
        | "Evm"
        | "Hedera"
        | "Icp"
        | "Iota"
        | "Kaspa"
        | "Near"
        | "Polymesh"
        | "Solana"
        | "Starknet"
        | "Stellar"
        | "Substrate"
        | "Sui"
        | "Tezos"
        | "Ton"
        | "Tron"
        | "Xrpl"

  • OptionalexternalId?: string

    A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).

  • kind: "Eip191"

  • message: string

    Hex-encoded message.

  • Optionalnetwork?: string

• {
      blockchainKind?:
          | "Algorand"
          | "Aptos"
          | "Bitcoin"
          | "BitcoinCash"
          | "Canton"
          | "Cardano"
          | "Concordium"
          | "Cosmos"
          | "Evm"
          | "Hedera"
          | "Icp"
          | "Iota"
          | "Kaspa"
          | "Near"
          | "Polymesh"
          | "Solana"
          | "Starknet"
          | "Stellar"
          | "Substrate"
          | "Sui"
          | "Tezos"
          | "Ton"
          | "Tron"
          | "Xrpl";
      domain: {
          chainId?: number
          | string;
          name?: string;
          salt?: string;
          verifyingContract?: string;
          version?: string;
      };
      externalId?: string;
      kind: "Eip712";
      message: { [x: string]: unknown };
      network?: string;
      types: { [x: string]: { name: string; type: string }[] };
  }

  • OptionalblockchainKind?:
        | "Algorand"
        | "Aptos"
        | "Bitcoin"
        | "BitcoinCash"
        | "Canton"
        | "Cardano"
        | "Concordium"
        | "Cosmos"
        | "Evm"
        | "Hedera"
        | "Icp"
        | "Iota"
        | "Kaspa"
        | "Near"
        | "Polymesh"
        | "Solana"
        | "Starknet"
        | "Stellar"
        | "Substrate"
        | "Sui"
        | "Tezos"
        | "Ton"
        | "Tron"
        | "Xrpl"

  • domain: {
        chainId?: number | string;
        name?: string;
        salt?: string;
        verifyingContract?: string;
        version?: string;
    }

    Domain separator.

    • OptionalchainId?: number | string

      Chain ID.

    • Optionalname?: string

      Name of the signing domain.

    • Optionalsalt?: string

      32-byte value as a last-resort domain separator.

    • OptionalverifyingContract?: string

      The address of the contract that will verify the signature.

    • Optionalversion?: string

      Current major version of the signing domain.

  • OptionalexternalId?: string

    A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).

  • kind: "Eip712"

  • message: { [x: string]: unknown }

    Structured message to sign.

  • Optionalnetwork?: string

  • types: { [x: string]: { name: string; type: string }[] }

    Type definitions.

• {
      address: string;
      blockchainKind?:
          | "Algorand"
          | "Aptos"
          | "Bitcoin"
          | "BitcoinCash"
          | "Canton"
          | "Cardano"
          | "Concordium"
          | "Cosmos"
          | "Evm"
          | "Hedera"
          | "Icp"
          | "Iota"
          | "Kaspa"
          | "Near"
          | "Polymesh"
          | "Solana"
          | "Starknet"
          | "Stellar"
          | "Substrate"
          | "Sui"
          | "Tezos"
          | "Ton"
          | "Tron"
          | "Xrpl";
      chainId: number;
      externalId?: string;
      kind: "Eip7702";
      network?: string;
      nonce: number;
  }

  • address: string

    The address of the contract the signer's EOA will be delegated to.

  • OptionalblockchainKind?:
        | "Algorand"
        | "Aptos"
        | "Bitcoin"
        | "BitcoinCash"
        | "Canton"
        | "Cardano"
        | "Concordium"
        | "Cosmos"
        | "Evm"
        | "Hedera"
        | "Icp"
        | "Iota"
        | "Kaspa"
        | "Near"
        | "Polymesh"
        | "Solana"
        | "Starknet"
        | "Stellar"
        | "Substrate"
        | "Sui"
        | "Tezos"
        | "Ton"
        | "Tron"
        | "Xrpl"

  • chainId: number

    Chain ID.

  • OptionalexternalId?: string

    A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).

  • kind: "Eip7702"

  • Optionalnetwork?: string

  • nonce: number

    The current nonce of the signer EOA.

• {
      blockchainKind?:
          | "Algorand"
          | "Aptos"
          | "Bitcoin"
          | "BitcoinCash"
          | "Canton"
          | "Cardano"
          | "Concordium"
          | "Cosmos"
          | "Evm"
          | "Hedera"
          | "Icp"
          | "Iota"
          | "Kaspa"
          | "Near"
          | "Polymesh"
          | "Solana"
          | "Starknet"
          | "Stellar"
          | "Substrate"
          | "Sui"
          | "Tezos"
          | "Ton"
          | "Tron"
          | "Xrpl";
      domain: {
          chainId?: number
          | string;
          name?: string;
          revision?: number | string;
          version?: string;
      };
      externalId?: string;
      kind: "Snip12";
      message: { [x: string]: unknown };
      network?: string;
      primaryType: string;
      types: { [x: string]: { name: string; type: string }[] };
  }

  • OptionalblockchainKind?:
        | "Algorand"
        | "Aptos"
        | "Bitcoin"
        | "BitcoinCash"
        | "Canton"
        | "Cardano"
        | "Concordium"
        | "Cosmos"
        | "Evm"
        | "Hedera"
        | "Icp"
        | "Iota"
        | "Kaspa"
        | "Near"
        | "Polymesh"
        | "Solana"
        | "Starknet"
        | "Stellar"
        | "Substrate"
        | "Sui"
        | "Tezos"
        | "Ton"
        | "Tron"
        | "Xrpl"

  • domain: {
        chainId?: number | string;
        name?: string;
        revision?: number | string;
        version?: string;
    }

    Domain separator.

    • OptionalchainId?: number | string

      Chain ID.

    • Optionalname?: string

      Name of the signing domain.

    • Optionalrevision?: number | string

      Revision of the domain.

    • Optionalversion?: string

      Current major version of the signing domain.

  • OptionalexternalId?: string

    A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).

  • kind: "Snip12"

  • message: { [x: string]: unknown }

    Structured message to sign.

  • Optionalnetwork?: string

  • primaryType: string

    The primary type of the message.

  • types: { [x: string]: { name: string; type: string }[] }

    Type definitions.

• {
      blockchainKind?:
          | "Algorand"
          | "Aptos"
          | "Bitcoin"
          | "BitcoinCash"
          | "Canton"
          | "Cardano"
          | "Concordium"
          | "Cosmos"
          | "Evm"
          | "Hedera"
          | "Icp"
          | "Iota"
          | "Kaspa"
          | "Near"
          | "Polymesh"
          | "Solana"
          | "Starknet"
          | "Stellar"
          | "Substrate"
          | "Sui"
          | "Tezos"
          | "Ton"
          | "Tron"
          | "Xrpl";
      externalId?: string;
      kind: "Psbt";
      network?: string;
      psbt: string;
  }

  • OptionalblockchainKind?:
        | "Algorand"
        | "Aptos"
        | "Bitcoin"
        | "BitcoinCash"
        | "Canton"
        | "Cardano"
        | "Concordium"
        | "Cosmos"
        | "Evm"
        | "Hedera"
        | "Icp"
        | "Iota"
        | "Kaspa"
        | "Near"
        | "Polymesh"
        | "Solana"
        | "Starknet"
        | "Stellar"
        | "Substrate"
        | "Sui"
        | "Tezos"
        | "Ton"
        | "Tron"
        | "Xrpl"

  • OptionalexternalId?: string

    A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).

  • kind: "Psbt"

  • Optionalnetwork?: string

  • psbt: string

    The hex encoded PSBT.

• {
      blockchainKind?:
          | "Algorand"
          | "Aptos"
          | "Bitcoin"
          | "BitcoinCash"
          | "Canton"
          | "Cardano"
          | "Concordium"
          | "Cosmos"
          | "Evm"
          | "Hedera"
          | "Icp"
          | "Iota"
          | "Kaspa"
          | "Near"
          | "Polymesh"
          | "Solana"
          | "Starknet"
          | "Stellar"
          | "Substrate"
          | "Sui"
          | "Tezos"
          | "Ton"
          | "Tron"
          | "Xrpl";
      externalId?: string;
      format?: "Simple"
      | "Full";
      kind: "Bip322";
      message: string;
      network?: string;
  }

  • OptionalblockchainKind?:
        | "Algorand"
        | "Aptos"
        | "Bitcoin"
        | "BitcoinCash"
        | "Canton"
        | "Cardano"
        | "Concordium"
        | "Cosmos"
        | "Evm"
        | "Hedera"
        | "Icp"
        | "Iota"
        | "Kaspa"
        | "Near"
        | "Polymesh"
        | "Solana"
        | "Starknet"
        | "Stellar"
        | "Substrate"
        | "Sui"
        | "Tezos"
        | "Ton"
        | "Tron"
        | "Xrpl"

  • OptionalexternalId?: string

    A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).

  • Optionalformat?: "Simple" | "Full"

    Defaults to Simple if not present. The formatted signature is returned in the signedData field in the response.

  • kind: "Bip322"

  • message: string

    The generic message hex encoded.

  • Optionalnetwork?: string

• {
      blockchainKind?:
          | "Algorand"
          | "Aptos"
          | "Bitcoin"
          | "BitcoinCash"
          | "Canton"
          | "Cardano"
          | "Concordium"
          | "Cosmos"
          | "Evm"
          | "Hedera"
          | "Icp"
          | "Iota"
          | "Kaspa"
          | "Near"
          | "Polymesh"
          | "Solana"
          | "Starknet"
          | "Stellar"
          | "Substrate"
          | "Sui"
          | "Tezos"
          | "Ton"
          | "Tron"
          | "Xrpl";
      externalId?: string;
      kind: "SignDocDirect";
      network?: string;
      signDoc: string;
  }

  • OptionalblockchainKind?:
        | "Algorand"
        | "Aptos"
        | "Bitcoin"
        | "BitcoinCash"
        | "Canton"
        | "Cardano"
        | "Concordium"
        | "Cosmos"
        | "Evm"
        | "Hedera"
        | "Icp"
        | "Iota"
        | "Kaspa"
        | "Near"
        | "Polymesh"
        | "Solana"
        | "Starknet"
        | "Stellar"
        | "Substrate"
        | "Sui"
        | "Tezos"
        | "Ton"
        | "Tron"
        | "Xrpl"

  • OptionalexternalId?: string

    A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).

  • kind: "SignDocDirect"

  • Optionalnetwork?: string

  • signDoc: string

    The hex encoded SignDoc Protobuf.

• {
      blockchainKind?:
          | "Algorand"
          | "Aptos"
          | "Bitcoin"
          | "BitcoinCash"
          | "Canton"
          | "Cardano"
          | "Concordium"
          | "Cosmos"
          | "Evm"
          | "Hedera"
          | "Icp"
          | "Iota"
          | "Kaspa"
          | "Near"
          | "Polymesh"
          | "Solana"
          | "Starknet"
          | "Stellar"
          | "Substrate"
          | "Sui"
          | "Tezos"
          | "Ton"
          | "Tron"
          | "Xrpl";
      externalId?: string;
      kind: "SignerPayload";
      network?: string;
      payload: string
      | {};
  }

  • OptionalblockchainKind?:
        | "Algorand"
        | "Aptos"
        | "Bitcoin"
        | "BitcoinCash"
        | "Canton"
        | "Cardano"
        | "Concordium"
        | "Cosmos"
        | "Evm"
        | "Hedera"
        | "Icp"
        | "Iota"
        | "Kaspa"
        | "Near"
        | "Polymesh"
        | "Solana"
        | "Starknet"
        | "Stellar"
        | "Substrate"
        | "Sui"
        | "Tezos"
        | "Ton"
        | "Tron"
        | "Xrpl"

  • OptionalexternalId?: string

    A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).

  • kind: "SignerPayload"

  • Optionalnetwork?: string

  • payload: string | {}

    The unsigned Signer Payload formatted as JSON, or as a serialized hex-encoded buffer.

    Please refer to the original Polkadot definition for more details: SignerPayloadJson. Note that additional fields will be rejected.

    Field	Description	Type - Optional
    address	ss58-encoded address of the sending account.	String
    blockHash	The hash of the checkpoint block, hex encoded.	String
    blockNumber	The checkpoint block number, hex encoded.	String
    era	The number of blocks after the checkpoint for which a transaction is valid, hex encoded.	String
    genesisHash	The genesis hash of the chain, hex encoded.	String
    metadataHash	The metadataHash for the CheckMetadataHash SignedExtension, hex encoded.	String (optional)
    mode	flag indicating whether to verify the metadata hash or not.	Integer (optional)
    method	The encoded method with arguments, hex encoded.	String
    nonce	The nonce for the transaction, hex encoded.	String
    tip	The tip to increase transaction priority, hex encoded.	String
    version	The version of the extrinsic.	Integer
    specVersion	The current spec version for the runtime, hex encoded.	String
    transactionVersion	The current transaction version for the runtime, hex encoded.	String
    signedExtensions	The applicable signed extensions for this runtime.	Array

    {
      "network": "Polymesh",
      "kind": "SignerPayload",
      "payload": {
        "address": "5H5tTnmLUqRgvTZvTwCdBKYjKLBm2gkp7u38Q9UUdJa8m6rX",
        "blockHash": "0x2ace05e703aa50b48c0ccccfc8b424f7aab9a1e2c424ed12e45d20b1e8ffd0d6",
        "blockNumber": "0x00000000",
        "era": "0x00",
        "genesisHash": "0x2ace05e703aa50b48c0ccccfc8b424f7aab9a1e2c424ed12e45d20b1e8ffd0d6",
        "method": "0x07141f3da32e72ac6eb6cb40d9e757594363a617b2c3964a2b6ec6895c6648f48d500000",
        "nonce": "0x00000000",
        "tip": "0x00000000000000000000000000000000",
        "version": 4,
        "specVersion": "0x006adb7a",
        "transactionVersion": "0x00000007",
        "signedExtensions": []
      }
    }
    Copy

• {
      blockchainKind?:
          | "Algorand"
          | "Aptos"
          | "Bitcoin"
          | "BitcoinCash"
          | "Canton"
          | "Cardano"
          | "Concordium"
          | "Cosmos"
          | "Evm"
          | "Hedera"
          | "Icp"
          | "Iota"
          | "Kaspa"
          | "Near"
          | "Polymesh"
          | "Solana"
          | "Starknet"
          | "Stellar"
          | "Substrate"
          | "Sui"
          | "Tezos"
          | "Ton"
          | "Tron"
          | "Xrpl";
      context: "Signature1";
      externalAad?: string;
      externalId?: string;
      kind: "Cip8";
      network?: string;
      payload?: string;
  }

  • OptionalblockchainKind?:
        | "Algorand"
        | "Aptos"
        | "Bitcoin"
        | "BitcoinCash"
        | "Canton"
        | "Cardano"
        | "Concordium"
        | "Cosmos"
        | "Evm"
        | "Hedera"
        | "Icp"
        | "Iota"
        | "Kaspa"
        | "Near"
        | "Polymesh"
        | "Solana"
        | "Starknet"
        | "Stellar"
        | "Substrate"
        | "Sui"
        | "Tezos"
        | "Ton"
        | "Tron"
        | "Xrpl"

  • context: "Signature1"

  • OptionalexternalAad?: string

    Allows an application to ask the user to sign some extra data but NOT put it inside the COSE structure (only as part of the data to sign).

  • OptionalexternalId?: string

    A unique ID from your system. It can be leveraged to be used as an idempotency key (read more here).

  • kind: "Cip8"

  • Optionalnetwork?: string

  • Optionalpayload?: string

    The generic message hex encoded.