Integrate Rails Yield

Deploy and activate in the dashboard

At rails.amboss.tech: sign up, set an account password, deploy the node (Fully Managed or Third Party Hosted), fund it on-chain, and complete the Stripe activation. See Deploy a Node for the full flow and Setup Options to choose between deployment types.

You can stop the dashboard session as soon as the node reads ACTIVE. Everything that follows runs from your backend.

Authenticate

Pass the dashboard token as a Bearer:

Authorization: Bearer $AMBOSS_DASHBOARD_TOKEN

A simple sanity check:

query Me {
  user { id }
  node {
    deployed_nodes { id state type pubkey alias }
  }
}

curl -X POST https://rails.amboss.tech/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $AMBOSS_DASHBOARD_TOKEN" \
  -d '{"query":"{ user { id } node { deployed_nodes { id state pubkey } } }"}'

import { GraphQLClient } from "graphql-request";

const client = new GraphQLClient("https://rails.amboss.tech/graphql", {
  headers: { authorization: `Bearer ${process.env.AMBOSS_DASHBOARD_TOKEN}` },
});

const { node } = await client.request(`
  { node { deployed_nodes { id state pubkey } } }
`);
const myNodeId = node.deployed_nodes.find((n) => n.state === "ACTIVE").id;

Cache the node_id of the active node - subsequent queries scope to it via LiquidityProviderInput.node_id.

Monitor earnings

Once ACTIVE, set up a polling loop or a periodic ETL on the funds + revenue queries:

query Monitor($input: LiquidityProviderInput) {
  user {
    liquidity_provider(input: $input) {
      funds {
        total     { sats usd }
        available { sats usd }
        reserved  { sats usd }
        earnings  { sats usd }
      }
      revenue {
        routing   { sats usd }
        liquidity { sats usd }
      }
    }
  }
}

For dashboards, also query charts.balance and charts.revenue. See Monitor for a complete example.

Withdraw

Raise the withdrawal target:

mutation WithdrawTarget($input: IncreaseWithdrawalInput!) {
  node {
    withdrawal {
      increase_withdrawal_target(input: $input) {
        amount
      }
    }
  }
}

{
  "input": {
    "node_id": "<NODE_ID>",
    "amount_sats": "10000000",
    "password_hash": "<argon2id hash>"
  }
}

Poll liquidity_provider.funds.available.sats and deployed_node.funds_available_at until the target is on-chain, then move it to your wallet with the LND macaroon. See Withdraw for the password hash and full flow.