t

org.ergoplatform.appkit.ergotool

RunWithErgoClient

trait RunWithErgoClient extends Cmd

This trait can be used to implement commands which need to communicate with Ergo blockchain. The default Cmd.run method is implemented and the new method with additional ErgoClient parameter is declared, which is called from the default implementation. To implement new command mix-in this train and implement RunWithErgoClient.runWithClient method.

Linear Supertypes
Cmd, AnyRef, Any
Known Subclasses
ListAddressBoxesCmd, SendCmd
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RunWithErgoClient
  2. Cmd
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def name: String

    Returns the name of this command (Example: send, mnemonic etc.)

    Returns the name of this command (Example: send, mnemonic etc.)

    Definition Classes
    Cmd
  2. abstract def runWithClient(ergoClient: ErgoClient, ctx: AppContext): Unit

    Called from run method with ErgoClient instance ready for Ergo blockchain communication.

  3. abstract def toolConf: ErgoToolConfig

    Returns current tool configuration parameters

    Returns current tool configuration parameters

    Definition Classes
    Cmd

Concrete 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. def apiKey: String

    ApiKey which is used for Ergo node API authentication.

    ApiKey which is used for Ergo node API authentication. This is a secret key whose hash was used in Ergo node config. This is only necessary to communicate to the protected parts of node API.

    Definition Classes
    Cmd
  5. def apiUrl: String

    Returns the url of the Ergo blockchain node used to communicate with the network.

    Returns the url of the Ergo blockchain node used to communicate with the network.

    Definition Classes
    Cmd
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def error(msg: String): Nothing

    Helper method to throw a new CmdException from this command.

    Helper method to throw a new CmdException from this command.

    Definition Classes
    Cmd
  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def networkType: NetworkType

    Returns the network type (MAINNET or TESTNET) ErgoTool is expected to communicate.

    Returns the network type (MAINNET or TESTNET) ErgoTool is expected to communicate. This parameter should correspond to the real network type of the node pointed to by apiUrl.

    Definition Classes
    Cmd
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. def run(ctx: AppContext): Unit

    Runs this command using given AppContext.

    Runs this command using given AppContext.

    ctx

    context information of this command execution collected from command line, configuration file etc.

    Definition Classes
    RunWithErgoClient → Cmd
    Exceptions thrown

    CmdException when command execution fails

  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Cmd

Inherited from AnyRef

Inherited from Any

Ungrouped