Initialize ZHTLC Coin Activation

To enable Z coins you also need to install some Zcash Params

Arguments

Structure	Type	Description
ticker	string	Ticker of coin to activate
activation_params	object	A standard ActivationRpcData object.

Response

Structure	Type	Description
task_id	integer	An identifying number which is used to query task status.

📌 Examples

Enable Z coin without any optional parameters

Initialize ZHTLC Coin Activation

POST

task::enable_z_coin::init

{
  "userpass": "testpsw",
  "method": "task::enable_z_coin::init",
  "mmrpc": "2.0",
  "params": {
    "ticker": "ZOMBIE",
    "activation_params": {
      "mode": {
        "rpc": "Light",
        "rpc_data": {
          "electrum_servers": [
            {
              "url": "zombie.dragonhound.info:10033"
            }
          ],
          "light_wallet_d_servers": [
            "http://zombie.dragonhound.info:443"
          ]
        }
      },
      "zcash_params_path": "/home/username/path_to/.zcash-params",
      "scan_blocks_per_iteration": 100,
      "scan_interval_ms": 200
    }
  }
}

Sync from block 2528700, with custom `.zcash-params` path and scan params

Initialize ZHTLC Coin Activation

POST

task::enable_z_coin::init

{
  "userpass": "testpsw",
  "method": "task::enable_z_coin::init",
  "mmrpc": "2.0",
  "params": {
    "ticker": "ZOMBIE",
    "activation_params": {
      "mode": {
        "rpc": "Light",
        "rpc_data": {
          "electrum_servers": [
            {
              "url": "zombie.dragonhound.info:10033"
            }
          ],
          "light_wallet_d_servers": [
            "http://zombie.dragonhound.info:443"
          ],
          "sync_params": {
            "height": 2528700
          }
        }
      },
      "zcash_params_path": "/home/username/path_to/.zcash-params",
      "scan_blocks_per_iteration": 100,
      "scan_interval_ms": 200
    }
  }
}

Sync from sapling activation height (earliest)

The Z coin lightwallet client only supports blocks that are post-sapling. The sapling activation height for Z coins can be found in the coins file

Initialize ZHTLC Coin Activation

POST

task::enable_z_coin::init

{
  "userpass": "testpsw",
  "method": "task::enable_z_coin::init",
  "mmrpc": "2.0",
  "params": {
    "ticker": "ZOMBIE",
    "activation_params": {
      "mode": {
        "rpc": "Light",
        "rpc_data": {
          "electrum_servers": [
            {
              "url": "zombie.dragonhound.info:10033"
            }
          ],
          "light_wallet_d_servers": [
            "http://zombie.dragonhound.info:443"
          ],
          "sync_params": "earliest"
        }
      },
      "zcash_params_path": "/home/username/path_to/.zcash-params",
      "scan_blocks_per_iteration": 100,
      "scan_interval_ms": 200
    }
  }
}

Using websockets to sync from Proof of Keys Day, 2023.

Initialize ZHTLC Coin Activation

POST

task::enable_z_coin::init

{
  "userpass": "testpsw",
  "method": "task::enable_z_coin::init",
  "mmrpc": "2.0",
  "params": {
    "ticker": "ZOMBIE",
    "activation_params": {
      "mode": {
        "rpc": "Light",
        "rpc_data": {
          "electrum_servers": [
            {
              "protocol": "SSL",
              "url": "zombie.dragonhound.info:20133",
              "ws_url": "zombie.dragonhound.info:30059"
            }
          ],
          "light_wallet_d_servers": [
            "http://zombie.dragonhound.info:443"
          ],
          "sync_params": {
            "date": 1672704000
          }
        }
      }
    }
  }
}

API-v2task::enable_z_coin::status

Activation Status

Z coins need to build sync a local block cache and wallet database before they can be used. Using task_id as an input, this method will return the current status of the activation process.

Arguments

Parameter	Type	Description
task_id	integer	The identifying number returned when initiating the initialisation process.
forget_if_finished	boolean	If `false`, will return final response for completed tasks. Optional, defaults to `true`

Response

Structure	Type	Description
status	string	A short indication of how the enabling is progressing.
details	object	Depending on the state of enabling progress, this will contain different information as shown in the responses below.

📌 Examples

Status of Z coin activation

Activation Status

POST

task::enable_z_coin::status

{
  "userpass": "testpsw",
  "method": "task::enable_z_coin::status",
  "mmrpc": "2.0",
  "params": {
    "task_id": 0,
    "forget_if_finished": false
  }
}

API-v2task::enable_z_coin::cancel

Cancel Activation

If you want to cancel the enabling process before it has completed, you can use this method.

Arguments

Structure	Type	Description
task_id	integer	The identifying number returned when initiating the enabling process.

Response

Structure	Type	Description
result	string	Indicates task cancellation was succesful.
error	string	An error message to explain what went wrong.
error_path	string	An indicator of the class or function which reurned the error.
error_trace	string	An indicator of where in the source code the error was thrown.
error_type	string	An enumerated value for the returned error.
error_data	string	The input task ID which resulted in the error.

📌 Examples

Command

Cancel Activation

POST

task::enable_z_coin::cancel

{
  "userpass": "testpsw",
  "method": "task::enable_z_coin::cancel",
  "mmrpc": "2.0",
  "params": {
    "task_id": 3
  }
}