Spark prepare Lightning receive

Generate a Lightning preimage and distribute Feldman shares to operators for a Spark Lightning receive. Does not perform FROST signing.

type · enum<string> · required

Enum options: ACTIVITY_TYPE_SPARK_PREPARE_LIGHTNING_RECEIVE

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

The parameters object containing the specific intent data for this activity.

Show details

parameters.lightningReceive · object · required

lightningReceive field

Show details

parameters.lightningReceive.operatorRecipients · array · required

Operators that will receive Feldman shares of the preimage. Order must match the operators’ numeric IDs in the Spark operator config - share index is the 1-based position in this list.

Show item details

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/spark_prepare_lightning_receive \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_SPARK_PREPARE_LIGHTNING_RECEIVE",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "signWith": "<string>",
        "lightningReceive": {
            "threshold": "<number>",
            "operatorRecipients": [
                {
                    "operatorId": "<string>",
                    "encryptionPublicKey": "<string>"
                }
            ]
        }
    }
}'

import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().sparkPrepareLightningReceive({
  signWith: "<string> (A Spark wallet account address identifying the wallet.)",
  lightningReceive: { // lightningReceive field,
    threshold: 0 // Feldman VSS threshold for reconstructing the preimage.,
    operatorRecipients: [{ // Operators that will receive Feldman shares of the preimage. Order must match the operators' numeric IDs in the Spark operator config - share index is the 1-based position in this list.,
      operatorId: "<string> (Spark operator identifier (UUID).)",
      encryptionPublicKey: "<string> (Operator's ECIES encryption pubkey (hex-encoded compressed secp256k1 point).)",
    }],
  }
});

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_SPARK_PREPARE_LIGHTNING_RECEIVE",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "sparkPrepareLightningReceiveIntent": {
            "signWith": "<string>",
            "lightningReceive": {
              "threshold": "<number>",
              "operatorRecipients": [
                {
                  "operatorId": "<string>",
                  "encryptionPublicKey": "<string>"
                }
              ]
            }
          }
        },
        "result": {
          "sparkPrepareLightningReceiveResult": {
            "operatorPackages": [
              {
                "operatorId": "<string>",
                "encryptedPackage": "<string>"
              }
            ],
            "paymentHash": "<string>"
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}