Packages

class ErgoProvingInterpreter extends ErgoInterpreter with ProverInterpreter

A class which is holding secrets and signing transactions. Signing a transaction means producing spending proofs for all of the input boxes of the transaction.

This interpreter also acts as a wallet, in the sense that it is a vault holding user's secrets.

There are two basic types of secrets, hierarchical deterministic keys corresponding to BIP-32 implementation, and also "primitive" keys, such as just secret exponent for a Schnorr signature scheme done in Ergo.

It is considered that there could be very many hierarchical deterministic keys (for example, if we are talking about an exchange there could be thousands of them), and not so many primitive keys. Optimizations are centered around this assumption.

Linear Supertypes
ProverInterpreter, ProverUtils, ErgoInterpreter, ScorexLogging, StrictLogging, ErgoLikeInterpreter, Interpreter, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ErgoProvingInterpreter
  2. ProverInterpreter
  3. ProverUtils
  4. ErgoInterpreter
  5. ScorexLogging
  6. StrictLogging
  7. ErgoLikeInterpreter
  8. Interpreter
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ErgoProvingInterpreter(secretKeys: IndexedSeq[SecretKey], params: BlockchainParameters, cachedHdPubKeysOpt: Option[IndexedSeq[ExtendedPublicKey]] = None)

    secretKeys

    - secrets used by the prover

    params

    - ergo network parameters at the moment of proving

    cachedHdPubKeysOpt

    - optionally, public keys corresponding to the BIP32-related secrets (to not to recompute them)

Type Members

  1. type CTX = ErgoLikeContext
    Definition Classes
    ErgoInterpreter → ErgoLikeInterpreter → Interpreter
  2. type ProofT = UncheckedTree
    Definition Classes
    ProverInterpreter → Interpreter

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val CostPerByteDeserialized: Int
    Definition Classes
    Interpreter
  5. val CostPerTreeByte: Int
    Definition Classes
    Interpreter
  6. val activatedScriptVersion: Byte

    Activated script version, 0 is for Ergo mainnet since block #1 until 417,792, 1 for Ergo mainnet since 417,792, etc.

    Activated script version, 0 is for Ergo mainnet since block #1 until 417,792, 1 for Ergo mainnet since 417,792, etc. Note: version N of ErgoProtocol corresponds to version N-1 of ErgoTree (aka script version)

  7. def addCryptoCost(reductionRes: SigmaBoolean, baseCost: Long, costLimit: Long): Long
    Attributes
    protected
    Definition Classes
    Interpreter
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def bagForMultisig(context: CTX, sigmaTree: SigmaBoolean, proof: Array[Byte], realSecretsToExtract: Seq[SigmaBoolean], simulatedSecretsToExtract: Seq[SigmaBoolean]): HintsBag
    Definition Classes
    ProverUtils
  10. def bagForMultisig(context: CTX, ergoTree: ErgoTree, proof: Array[Byte], realSecretsToExtract: Seq[SigmaBoolean], simulatedSecretsToExtract: Seq[SigmaBoolean]): HintsBag
    Definition Classes
    ProverUtils
  11. def bagForTransaction(tx: ErgoLikeTransaction, boxesToSpend: IndexedSeq[ErgoBox], dataBoxes: IndexedSeq[ErgoBox], stateContext: BlockchainStateContext, realSecretsToExtract: Seq[SigmaBoolean], simulatedSecretsToExtract: Seq[SigmaBoolean]): TransactionHintsBag

    Extract hints from (supposedly, partially) signed transaction.

    Extract hints from (supposedly, partially) signed transaction. Useful for distributed signing.

    tx

    - signed transaction

    boxesToSpend

    - input boxes the transaction are spending

    dataBoxes

    - read-only inputs of the transaction

    stateContext

    - context used for signing

    realSecretsToExtract

    - public images of secrets used in signing

    simulatedSecretsToExtract

    - public images of simulated secrets

    returns

    hints for (further) transaction signing

  12. val cachedHdPubKeysOpt: Option[IndexedSeq[ExtendedPublicKey]]
  13. def checkExpiredBox(box: ErgoBox, output: ErgoBoxCandidate, currentHeight: Height): Boolean

    Checks that expired box is spent in a proper way

    Checks that expired box is spent in a proper way

    box

    - box being spent

    output

    - newly created box when storage fee covered, otherwise any output box

    currentHeight

    - current height of the blockchain (at the moment of spending)

    returns

    whether the box is spent properly according to the storage fee rule

    Attributes
    protected
    Definition Classes
    ErgoInterpreter
  14. def checkSoftForkCondition(ergoTree: ErgoTree, context: CTX): Option[VerificationResult]
    Attributes
    protected
    Definition Classes
    Interpreter
  15. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  16. val computeCommitments: Strategy
    Definition Classes
    Interpreter
  17. def convertToUnchecked(proofTree: ProofTree): UncheckedSigmaTree
    Definition Classes
    ProverInterpreter
  18. def convertToUnproven(sigmaTree: SigmaBoolean): UnprovenTree
    Definition Classes
    ProverInterpreter
  19. def deserializeMeasured(context: CTX, scriptBytes: Array[Byte]): (CTX, Value[SType])
    Attributes
    protected
    Definition Classes
    Interpreter
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  22. def evalSettings: EvalSettings
    Attributes
    protected
    Definition Classes
    Interpreter
  23. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  24. def fullReduction(ergoTree: ErgoTree, ctx: CTX): ReductionResult
    Definition Classes
    Interpreter
  25. def fullReduction(ergoTree: ErgoTree, ctx: CTX, env: ScriptEnv): ReductionResult
    Definition Classes
    Interpreter
  26. def generateCommitments(sigmaTree: SigmaBoolean): HintsBag
    Definition Classes
    ProverInterpreter
  27. def generateCommitments(ergoTree: ErgoTree, ctx: CTX): HintsBag
    Definition Classes
    ProverInterpreter
  28. def generateCommitmentsFor(unsignedTx: UnsignedErgoLikeTransaction, boxesToSpend: IndexedSeq[ErgoBox], dataBoxes: IndexedSeq[ErgoBox], stateContext: BlockchainStateContext): Try[TransactionHintsBag]

    A method which is generating commitments to randomness.

    A method which is generating commitments to randomness. A commitment is about a first step of a zero-knowledge proof-of-knowledge knowledge protocol.

    Method checks whether secret is known to the prover, and returns None if the secret is not known.

    unsignedTx

    - transaction to be signed with commitments to be generated first

    boxesToSpend

    - boxes the transaction is spending

    dataBoxes

    - read-only inputs of the transaction

    stateContext

    - context used for signing

    returns

    - hints for signing transaction

  29. def generateCommitmentsFor(sigmaTree: SigmaBoolean, generateFor: Seq[SigmaBoolean]): HintsBag
    Definition Classes
    ProverUtils
  30. def generateCommitmentsFor(ergoTree: ErgoTree, context: CTX, generateFor: Seq[SigmaBoolean]): HintsBag
    Definition Classes
    ProverUtils
  31. def generateProof(sb: SigmaBoolean, message: Array[Byte], hintsBag: HintsBag): Array[Byte]
    Definition Classes
    ProverInterpreter
  32. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  33. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  34. val hdKeys: IndexedSeq[ExtendedSecretKey]

    Only secrets corresponding to hierarchical deterministic scheme (BIP-32 impl)

  35. val hdPubKeys: IndexedSeq[ExtendedPublicKey]

    Only public keys corresponding to hierarchical deterministic scheme (BIP-32 impl)

  36. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  37. def log: Logger
    Attributes
    protected
    Definition Classes
    ScorexLogging
    Annotations
    @inline()
  38. def logMessage(msg: String, t: Throwable): Unit
    Attributes
    protected
    Definition Classes
    ErgoInterpreter → Interpreter
  39. def logMessage(msg: String): Unit

    Override default logging for all Ergo interpreters.

    Override default logging for all Ergo interpreters.

    Attributes
    protected
    Definition Classes
    ErgoInterpreter → Interpreter
  40. val logger: Logger
    Attributes
    protected
    Definition Classes
    StrictLogging
  41. def markReal(hintsBag: HintsBag): Strategy
    Definition Classes
    ProverInterpreter
  42. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  43. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  44. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  45. val polishSimulated: Strategy
    Definition Classes
    ProverInterpreter
  46. def propositionFromErgoTree(ergoTree: ErgoTree, context: CTX): SigmaPropValue
    Attributes
    protected
    Definition Classes
    Interpreter
  47. def prove(env: ScriptEnv, ergoTree: ErgoTree, context: CTX, message: Array[Byte], hintsBag: HintsBag): Try[CostedProverResult]
    Definition Classes
    ProverInterpreter
  48. def prove(ergoTree: ErgoTree, context: CTX, message: Array[Byte]): Try[CostedProverResult]
    Definition Classes
    ProverInterpreter
  49. def prove(ergoTree: ErgoTree, context: CTX, message: Array[Byte], hintsBag: HintsBag): Try[CostedProverResult]
    Definition Classes
    ProverInterpreter
  50. def prove(unprovenTree: UnprovenTree, message: Array[Byte], hintsBag: HintsBag): ProofT
    Attributes
    protected
    Definition Classes
    ProverInterpreter
  51. def proving(hintsBag: HintsBag): Strategy
    Definition Classes
    ProverInterpreter
  52. def publicKeys: Seq[SigmaBoolean]
    Definition Classes
    ProverInterpreter
  53. def reduceToCryptoJITC(context: CTX, env: ScriptEnv, exp: SigmaPropValue): Try[ReductionResult]
    Attributes
    protected
    Definition Classes
    Interpreter
  54. val secretKeys: IndexedSeq[SecretKey]
  55. val secrets: IndexedSeq[SigmaProtocolPrivateInput[_]]

    Interpreter's secrets, in form of sigma protocols private inputs

    Interpreter's secrets, in form of sigma protocols private inputs

    Definition Classes
    ErgoProvingInterpreter → ProverInterpreter
  56. def setPositions(uc: UnprovenConjecture): UnprovenConjecture
    Attributes
    protected
    Definition Classes
    ProverInterpreter
  57. def sign(unsignedTx: UnsignedErgoLikeTransaction, boxesToSpend: IndexedSeq[ErgoBox], dataBoxes: IndexedSeq[ErgoBox], stateContext: BlockchainStateContext, txHints: TransactionHintsBag = TransactionHintsBag.empty): Try[ErgoLikeTransaction]

    Note

    requires unsignedTx and boxesToSpend have the same boxIds in the same order.

  58. def signInputs(unsignedTx: UnsignedErgoLikeTransaction, boxesToSpend: IndexedSeq[ErgoBox], dataBoxes: IndexedSeq[ErgoBox], stateContext: BlockchainStateContext, txHints: TransactionHintsBag): Try[(IndexedSeq[Input], Long)]
  59. def signMessage(sigmaTree: SigmaBoolean, message: Array[Byte], hintsBag: HintsBag): Try[Array[Byte]]
    Definition Classes
    ProverInterpreter
  60. def simulateAndCommit(hintsBag: HintsBag): Strategy
    Definition Classes
    ProverInterpreter
  61. def substDeserialize(context: CTX, updateContext: (CTX) => Unit, node: SValue): Option[SValue]
    Definition Classes
    ErgoLikeInterpreter → Interpreter
  62. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  63. def toString(): String
    Definition Classes
    AnyRef → Any
  64. def verify(env: ScriptEnv, exp: ErgoTree, context: CTX, proof: Array[Byte], message: Array[Byte]): Try[VerificationResult]

    Checks that given exp evaluates to true.

    Checks that given exp evaluates to true.

    env

    - environment to use during expression evaluation

    exp

    - expression to check

    context

    - expression evaluation context

    proof

    - cryptographic proof

    message

    - message

    Definition Classes
    ErgoInterpreter → Interpreter
  65. def verify(ergoTree: ErgoTree, context: CTX, proof: ErgoProvingInterpreter.ProofT, message: Array[Byte]): Try[VerificationResult]
    Definition Classes
    Interpreter
  66. def verify(env: ScriptEnv, ergoTree: ErgoTree, context: CTX, proverResult: ProverResult, message: Array[Byte]): Try[VerificationResult]
    Definition Classes
    Interpreter
  67. def verify(ergoTree: ErgoTree, context: CTX, proverResult: ProverResult, message: Array[Byte]): Try[VerificationResult]
    Definition Classes
    Interpreter
  68. def verifySignature(sigmaTree: SigmaBoolean, message: Array[Byte], signature: Array[Byte])(implicit E: CErgoTreeEvaluator): Boolean
    Definition Classes
    Interpreter
  69. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  70. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  71. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  72. def withNewExtendedSecret(secret: ExtendedSecretKey): ErgoProvingInterpreter

    Produces updated instance of ErgoProvingInterpreter with a new secret included

    Produces updated instance of ErgoProvingInterpreter with a new secret included

    secret

    - new secret to add

    returns

    modified prover

  73. def withNewParameters(newParams: BlockchainParameters): ErgoProvingInterpreter

    Produces updated instance of ErgoProvingInterpreter with updated parameters

    Produces updated instance of ErgoProvingInterpreter with updated parameters

    newParams

    - updated parameters

    returns

    modified prover

Inherited from ProverInterpreter

Inherited from ProverUtils

Inherited from ErgoInterpreter

Inherited from ScorexLogging

Inherited from StrictLogging

Inherited from ErgoLikeInterpreter

Inherited from Interpreter

Inherited from AnyRef

Inherited from Any

Ungrouped