Class/Object

org.ergoplatform.wallet.interpreter

ErgoProvingInterpreter

Related Docs: object ErgoProvingInterpreter | package interpreter

Permalink

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. All

Instance Constructors

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

    Permalink

    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

    Permalink
    Definition Classes
    ErgoInterpreter → ErgoLikeInterpreter → Interpreter
  2. type ProofT = UncheckedTree

    Permalink
    Definition Classes
    ProverInterpreter → Interpreter

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. val CostPerByteDeserialized: Int

    Permalink
    Definition Classes
    Interpreter
  5. val CostPerTreeByte: Int

    Permalink
    Definition Classes
    Interpreter
  6. val activatedScriptVersion: Byte

    Permalink

    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

    Permalink
    Attributes
    protected
    Definition Classes
    Interpreter
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def bagForMultisig(context: CTX, sigmaTree: SigmaBoolean, proof: Array[Byte], realSecretsToExtract: Seq[SigmaBoolean], simulatedSecretsToExtract: Seq[SigmaBoolean]): HintsBag

    Permalink
    Definition Classes
    ProverUtils
  10. def bagForMultisig(context: CTX, ergoTree: ErgoTree, proof: Array[Byte], realSecretsToExtract: Seq[SigmaBoolean], simulatedSecretsToExtract: Seq[SigmaBoolean]): HintsBag

    Permalink
    Definition Classes
    ProverUtils
  11. def bagForTransaction(tx: ErgoLikeTransaction, boxesToSpend: IndexedSeq[ErgoBox], dataBoxes: IndexedSeq[ErgoBox], stateContext: BlockchainStateContext, realSecretsToExtract: Seq[SigmaBoolean], simulatedSecretsToExtract: Seq[SigmaBoolean]): TransactionHintsBag

    Permalink

    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]]

    Permalink

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

  13. def checkExpiredBox(box: ErgoBox, output: ErgoBoxCandidate, currentHeight: ErgoLikeContext.Height): Boolean

    Permalink

    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]

    Permalink
    Attributes
    protected
    Definition Classes
    Interpreter
  15. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. def convertToUnchecked(proofTree: ProofTree): UncheckedSigmaTree

    Permalink
    Definition Classes
    ProverInterpreter
  17. def convertToUnproven(sigmaTree: SigmaBoolean): UnprovenTree

    Permalink
    Definition Classes
    ProverInterpreter
  18. def deserializeMeasured(context: CTX, scriptBytes: Array[Byte]): (CTX, Value[SType])

    Permalink
    Attributes
    protected
    Definition Classes
    Interpreter
  19. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  21. def evalSettings: EvalSettings

    Permalink
    Attributes
    protected
    Definition Classes
    Interpreter
  22. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. def fullReduction(ergoTree: ErgoTree, ctx: CTX): ReductionResult

    Permalink
    Definition Classes
    Interpreter
  24. def fullReduction(ergoTree: ErgoTree, ctx: CTX, env: ScriptEnv): ReductionResult

    Permalink
    Definition Classes
    Interpreter
  25. def generateCommitments(sigmaTree: SigmaBoolean): HintsBag

    Permalink
    Definition Classes
    ProverInterpreter
  26. def generateCommitments(ergoTree: ErgoTree, ctx: CTX): HintsBag

    Permalink
    Definition Classes
    ProverInterpreter
  27. def generateCommitmentsFor(unsignedTx: UnsignedErgoLikeTransaction, boxesToSpend: IndexedSeq[ErgoBox], dataBoxes: IndexedSeq[ErgoBox], stateContext: BlockchainStateContext): Try[TransactionHintsBag]

    Permalink

    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

  28. def generateCommitmentsFor(sigmaTree: SigmaBoolean, generateFor: Seq[SigmaBoolean]): HintsBag

    Permalink
    Definition Classes
    ProverUtils
  29. def generateCommitmentsFor(ergoTree: ErgoTree, context: CTX, generateFor: Seq[SigmaBoolean]): HintsBag

    Permalink
    Definition Classes
    ProverUtils
  30. def generateProof(sb: SigmaBoolean, message: Array[Byte], hintsBag: HintsBag): Array[Byte]

    Permalink
    Definition Classes
    ProverInterpreter
  31. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  32. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  33. val hdKeys: IndexedSeq[ExtendedSecretKey]

    Permalink

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

  34. val hdPubKeys: IndexedSeq[ExtendedPublicKey]

    Permalink

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

  35. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  36. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    ScorexLogging
    Annotations
    @inline()
  37. def logMessage(msg: String, t: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    ErgoInterpreter → Interpreter
  38. def logMessage(msg: String): Unit

    Permalink

    Override default logging for all Ergo interpreters.

    Override default logging for all Ergo interpreters.

    Attributes
    protected
    Definition Classes
    ErgoInterpreter → Interpreter
  39. val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    StrictLogging
  40. def markReal(hintsBag: HintsBag): Strategy

    Permalink
    Definition Classes
    ProverInterpreter
  41. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  42. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  43. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  44. val polishSimulated: Strategy

    Permalink
    Definition Classes
    ProverInterpreter
  45. def propositionFromErgoTree(ergoTree: ErgoTree, context: CTX): SigmaPropValue

    Permalink
    Attributes
    protected
    Definition Classes
    Interpreter
  46. def prove(env: ScriptEnv, ergoTree: ErgoTree, context: CTX, message: Array[Byte], hintsBag: HintsBag): Try[CostedProverResult]

    Permalink
    Definition Classes
    ProverInterpreter
  47. def prove(ergoTree: ErgoTree, context: CTX, message: Array[Byte]): Try[CostedProverResult]

    Permalink
    Definition Classes
    ProverInterpreter
  48. def prove(ergoTree: ErgoTree, context: CTX, message: Array[Byte], hintsBag: HintsBag): Try[CostedProverResult]

    Permalink
    Definition Classes
    ProverInterpreter
  49. def prove(unprovenTree: UnprovenTree, message: Array[Byte], hintsBag: HintsBag): ProofT

    Permalink
    Attributes
    protected
    Definition Classes
    ProverInterpreter
  50. def proving(hintsBag: HintsBag): Strategy

    Permalink
    Definition Classes
    ProverInterpreter
  51. def publicKeys: Seq[SigmaBoolean]

    Permalink
    Definition Classes
    ProverInterpreter
  52. def reduceToCryptoJITC(context: CTX, env: ScriptEnv, exp: SigmaPropValue): Try[ReductionResult]

    Permalink
    Attributes
    protected
    Definition Classes
    Interpreter
  53. val secretKeys: IndexedSeq[SecretKey]

    Permalink

    - secrets used by the prover

  54. val secrets: IndexedSeq[SigmaProtocolPrivateInput[_]]

    Permalink

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

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

    Definition Classes
    ErgoProvingInterpreter → ProverInterpreter
  55. def setPositions(uc: UnprovenConjecture): UnprovenConjecture

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

    Permalink

    Note

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

  57. def signInputs(unsignedTx: UnsignedErgoLikeTransaction, boxesToSpend: IndexedSeq[ErgoBox], dataBoxes: IndexedSeq[ErgoBox], stateContext: BlockchainStateContext, txHints: TransactionHintsBag): Try[(IndexedSeq[Input], Long)]

    Permalink
  58. def signMessage(sigmaTree: SigmaBoolean, message: Array[Byte], hintsBag: HintsBag): Try[Array[Byte]]

    Permalink
    Definition Classes
    ProverInterpreter
  59. def simulateAndCommit(hintsBag: HintsBag): Strategy

    Permalink
    Definition Classes
    ProverInterpreter
  60. def substDeserialize(context: CTX, updateContext: (CTX) ⇒ Unit, node: SValue): Option[SValue]

    Permalink
    Definition Classes
    ErgoLikeInterpreter → Interpreter
  61. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  62. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  63. def verify(env: ScriptEnv, exp: ErgoTree, context: CTX, proof: Array[Byte], message: Array[Byte]): Try[VerificationResult]

    Permalink

    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
  64. def verify(ergoTree: ErgoTree, context: CTX, proof: ErgoProvingInterpreter.ProofT, message: Array[Byte]): Try[VerificationResult]

    Permalink
    Definition Classes
    Interpreter
  65. def verify(env: ScriptEnv, ergoTree: ErgoTree, context: CTX, proverResult: ProverResult, message: Array[Byte]): Try[VerificationResult]

    Permalink
    Definition Classes
    Interpreter
  66. def verify(ergoTree: ErgoTree, context: CTX, proverResult: ProverResult, message: Array[Byte]): Try[VerificationResult]

    Permalink
    Definition Classes
    Interpreter
  67. def verifySignature(sigmaTree: SigmaBoolean, message: Array[Byte], signature: Array[Byte])(implicit E: ErgoTreeEvaluator): Boolean

    Permalink
    Definition Classes
    Interpreter
  68. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  69. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  70. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  71. def withNewExtendedSecret(secret: ExtendedSecretKey): ErgoProvingInterpreter

    Permalink

    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

  72. def withNewParameters(newParams: BlockchainParameters): ErgoProvingInterpreter

    Permalink

    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