Node Provisioning API

Dynamically provision nodes and receive staking transactions to sign.

What is the Node Provisioning API?

The Node Provisioning API allows partners to programmatically spin-up nodes for staking. Partners specify the number of nodes needed and receive a transaction to sign that stakes with those node/s.

ETH2

Provision validators with an API request and submit the deposits through a single ETH1 transaction.

Integration Environments

Staked supports integration testing on ETH2, as defined below.

Post ETH2 Provisioning Request

POST https://mainnet.staked.cloud/api/provisioning_requests/eth2

Provision ETH2 validators in our secure cloud environments. The response contains a unique identifier for the provisioning request.

Query Parameters

Request Body

{
    "id": "163",
    "uuid": "693c10d8-70e5-4a5d-aeb0-6c53ea625433",
    "created": "2020-11-14T19:51:14",
    "status": "CREATED",
    "chain": "ETH2",
    "user_id": null,
    "partner_id": "18",
    "attributes": {
        "validators": [
            {
                "cloud": "amazon",
                "count": 1
            }
        ],
        "withdrawalKey": "b211ebaaa4d28539aec2e323fef6ea205a2c02c3197b1698c3a2252d5eb41b997079a533181a9367b4d2294c758bf472"
    }
}

ETH2 Attributes Object

Validator Config Object

// example post request body
{
    "attributes": {
        "eth1Address": "0xYourWithdrawalAddressHere",
        "payoutAddress": "0xYourPayoutAddressHere",
        "feeRecipientGroupKey": "0xYourFeeRecipientHere",
        "validators": [
            {
                "provider": "decentralized",
                "count": 5
            }
        ]
    }
}

Provisioning Response Object

Get ETH2 Delegation Objects

GET https://mainnet.staked.cloud/api/delegations/eth2

After POSTing a provisioning request, use the unique identifier to GET the delegation objects for each validator. Delegation objects contain the information required to submit deposits on ETH1.

Query Parameters

{
    "results": [
        {
            "id": 4308,
            "address": "82fcdaa3d3f1429dea23b02eeae00bfff41ec9c1d0281a1b4d58d782111eef691d972af56799fda43a6a46fdac49bd65",
            "chain": "ETH2",
            "attributes": {
                "cloud": "amazon",
                "count": 1,
                "index": 1,
                "depositInput": "22895118000000000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000000000000000000000000000e0000000000000000000000000000000000000000000000000000000000000012020e35863f9077de93ac5f59bbb8adea7cfd0a4cc02795a0d43ce87cd82b9f1b9000000000000000000000000000000000000000000000000000000000000003082fcdaa3d3f1429dea23b02eeae00bfff41ec9c1d0281a1b4d58d782111eef691d972af56799fda43a6a46fdac49bd650000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000200027662cfd6fa4cfe93b5d34c233756e2b972c7b0a0e11f2e4500d1f131e604d0000000000000000000000000000000000000000000000000000000000000060863fc2373413eac068f088acad56c7f5125c852fc45ba531cccfa50db1c375892c56d9d8d6610e9d2954c9232e0ac97009faaa67ae24dacb853002a37baa257651f0bc3ec915b3014c916c18c28fdc92c71b5b3a251c859410ed9651225e9fd5",
                "validatorKey": "82fcdaa3d3f1429dea23b02eeae00bfff41ec9c1d0281a1b4d58d782111eef691d972af56799fda43a6a46fdac49bd65"
            },
            "amount": "0",
            "created": "2020-11-14T19:51:14",
            "status": "CREATED",
            "user_id": null,
            "partner_id": "18",
            "provisioning_request_uuid": "693c10d8-70e5-4a5d-aeb0-6c53ea625433",
            "provisioning_request_id": "163"
        },
        ...
    ],
    "page": 1,
    "pages": 9,
    "per_page": 10,
    "total": 86
}

Validators are provisioned asynchronously, meaning the GET request will fill-in over time as our infrastructure fulfills the associated provisioning request. Use the "total" field in the response object to track the number of validators provisioned at any given time.

Paginated Response Object

ETH2 Delegation Object

ETH2 Delegation Attributes Object

ETH2 Delegation Status Enum

Submit Deposits through the Batching Contract

The canonical ETH2 deposit contract, used to convert ETH1 to ETH2, only supports one deposit transaction at a time. Since 32 ETH is required for each validator, depositors with large amounts of ETH would have to broadcast many deposit transactions.

To simplify submitting deposits, we have created a batching contract which takes up to 185 deposits at once and submits each to the deposit contract. Integrators can therefore stake up to 5920 ETH in one Ethereum transaction, and leave behind the hassle of tracking many individually broadcasted transactions.

Batching Contract Deployments

The batching contract contains an external payable function, batchDeposits, which loops over each validator's deposit and sends them to the deposit contract. The function arguments are passed as a 2-d array where the array at [i] represents the deposit arguments for validator i.

For release notifications of the ETH2 API and developer tools, click here.

Dash

Automate provisioning of Dash masternodes.

Integration Environments

Staked supports integration testing on Dash, as described below.

Email sam@staked.us for testnet Dash, or request it in the Dash Discord. Staked will support 2 masternodes per partner account in a testnet environment.

Getting Started

Each masternode requires an unspent transaction output (UTXO) of exactly 1,000 DASH. The address that owns this UTXO is the collateral address.

Instructions below assume use of the dash command line tool or debug console in the GUI wallet. If using the debug console, please remove dash-cli from the beginning of each command.

Create a new address to hold your masternode collateral.

dash-cli getnewaddress <address-alias>

Example

dash-cli getnewaddress masternode_collateral_1

Next, send exactly 1,000 Dash to your collateral address.

dash-cli sendtoaddress <address> <amount>

Example

dash-cli sendtoaddress yTrtvsNuVgezcGmcVyv2n8D2dFeJEHCYhg 1000

Get the transaction id and output index of the transaction you just created (you may need to wait up to 2 minutes until your transaction is added to a block).

dash-cli masternode outputs

masternode outputs

schema 
{
  "tx id": "collateral index"
}

example
{
  "3483e20a675d7585f0d3a07579f52551e59854ee6ad88af80492418c75a5d4a2": "1",
  ...
}

A payout address is also needed and can be generated using the getnewaddress command. A single payout address can be shared across masternodes.

Step 1: Post Masternode Provisioning Request

POST https://mainnet.staked.cloud/api/delegations/DASH/delegator/:collateralAddress

Provision a new masternode after sending 1,000 DASH to a collateral address.

Path Parameters

Query Parameters

Headers

Request Body

{
    "id": 2691,
    "address": "yTrtvsNuVgezcGmcVyv2n8D2dFeJEHCYhg",
    "chain": "DASH",
    "attributes": {
        "payoutAddress": "yQAt7kYbwZAiWVz9LCVzaox7mxrVBZYNAp",
        "collateralHash": "3483e20a675d7585f0d3a07579f52551e59854ee6ad88af80492418c75a5d4a2",
        "collateralIndex": 1
    },
    "created": "2020-06-04T21:23:32",
    "status": "CREATED"
}

Step 2: Poll Masternode Status

GET https://mainnet.staked.cloud/api/delegations/DASH/delegator/:collateralAddress

Poll the masternode status. The status is initially set as CREATED. Once the masternode registration message is created through Staked's provisioning infrastructure the response will pass the message for signing along with a status of WaitingForSigning.

Path Parameters

Query Parameters

Status is "CREATED"
{
    "results": [
        "id": 2691,
        "address": "yTrtvsNuVgezcGmcVyv2n8D2dFeJEHCYhg",
        "chain": "DASH",
        "attributes": {
            "payoutAddress": "yQAt7kYbwZAiWVz9LCVzaox7mxrVBZYNAp",
            "collateralHash": "3483e20a675d7585f0d3a07579f52551e59854ee6ad88af80492418c75a5d4a2",
            "collateralIndex": 1
        },
        "created": "2020-06-04T21:23:32",
        "status": "CREATED"
    ],
    "page": 1,
    "pages": 1,
    "per_page": 10,
    "total": 1
}

Status is "WaitingForSigning"
{
    "results": [
        {
            "id": 2691,
            "address": "yTrtvsNuVgezcGmcVyv2n8D2dFeJEHCYhg",
            "chain": "DASH",
            "attributes": {
                "ipAndPort": "52.10.215.49:19999",
                "signMessage": "yQAt7kYbwZAiWVz9LCVzaox7mxrVBZYNAp|1000|yQFVUWVMP5kVM9Rp8oXLScEAsPMB974rPd|yQFVUWVMP5kVM9Rp8oXLScEAsPMB974rPd|d85fcd73cdb916b1dce77e993cbb915b58381d29067d18757550f9a5dfec5de9",
                "internalPort": 32419,
                "ownerKeyAddr": "yQFVUWVMP5kVM9Rp8oXLScEAsPMB974rPd",
                "registerTxId": "03000100012730d8726ddae3434dfec7e66923b01134a1124982e9e71e1a5f79e2575de2a50000000000feffffff0142b19a3b000000001976a914641138d9d61f2b7d8cccd6c29959349549ba5e8388ac00000000d1010000000000a2d4a5758c419204f88ad86aee5498e55125f57975a0d3f085755d670ae283340100000000000000000000000000ffff340ad7314e1f2b210805a79c2e5e453b20ef85d29633c151076c85c86cdb8d2ebf444fbc40c739b190e56a4c2f8ae9d26567bf2b0d3152ff7c435df652866f572af774d11454fe92a6d12b210805a79c2e5e453b20ef85d29633c151076ce8031976a9142a41da2a5517ae71484594d2187c7f99ed20e91e88ac34dec225612f265fb337240197d8f30ba22a6d5ca12547e50a91ff2aec7bedaa00",
                "payoutAddress": "yQAt7kYbwZAiWVz9LCVzaox7mxrVBZYNAp",
                "collateralHash": "3483e20a675d7585f0d3a07579f52551e59854ee6ad88af80492418c75a5d4a2",
                "operatorPubKey": "85c86cdb8d2ebf444fbc40c739b190e56a4c2f8ae9d26567bf2b0d3152ff7c435df652866f572af774d11454fe92a6d1",
                "collateralIndex": 1
            },
            "amount": null,
            "created": "2020-06-04T21:23:32",
            "status": "WaitingForSigning"
        }
    ],
    "page": 1,
    "pages": 1,
    "per_page": 10,
    "total": 1
}

Step 3: Sign Delegation Message

This must be run on the wallet or device that holds collateral key, and can be done completely offline if required. signMessage is returned in the response of the previous step.

signmessage collateralAddress signMessage

Example Output:

H3ub9BATtvuV+zDGdkUQNoUGpaYFr/O1FypmrSmH5WJ0KFRi8T10FSew0EJO/+Ij+OLv4r0rt+HS9pQFsZgc2dE=

Step 4: Send Us the Signed Delegation Message

PUT https://mainnet.staked.cloud/api/delegations/DASH/delegator/:collateralAddress

Finally, send Staked the signed transaction and we will broadcast it to the Dash blockchain!

Path Parameters

Query Parameters

Request Body

The status of the delegation object is now WaitingToSubmit. When the Masternode is synched, the signedTx will be submitted and the status will be Ready.

Boom! You've programmatically set up a Masternode. Check out the Reporting API to monitor your position.

Last updated 6 months ago