Prepare Spark transfer

Construct sender-side encrypted operator packages for a Spark BTC transfer. Does not perform FROST signing.

type · enum<string> · required

Enum options: ACTIVITY_TYPE_SPARK_PREPARE_TRANSFER

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.transfer · object · required

transfer field

Show details

parameters.transfer.leaves · array · required

Leaves being transferred.

Show item details

parameters.transfer.leaves.oldLeafDerivation · object · required

oldLeafDerivation field

Show details

parameters.transfer.leaves.oldLeafDerivation.signingLeaf · object

signingLeaf field

Show details

parameters.transfer.leaves.oldLeafDerivation.staticDeposit · object

staticDeposit field

Show details

parameters.transfer.leaves.newLeafDerivation · object · required

newLeafDerivation field

Show details

parameters.transfer.leaves.newLeafDerivation.signingLeaf · object

signingLeaf field

Show details

parameters.transfer.leaves.newLeafDerivation.staticDeposit · object

staticDeposit field

Show details

parameters.transfer.operatorRecipients · array · required

Operators that will receive Feldman shares of the per-leaf tweak. 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_transfer \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_SPARK_PREPARE_TRANSFER",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "signWith": "<string>",
        "transfer": {
            "transferId": "<string>",
            "leaves": [
                {
                    "leafId": "<string>",
                    "oldLeafDerivation": {
                        "identity": "<object>",
                        "signingLeaf": {
                            "leafId": "<string>"
                        },
                        "deposit": "<object>",
                        "staticDeposit": {
                            "index": "<number>"
                        },
                        "htlcPreimage": "<object>"
                    },
                    "newLeafDerivation": {
                        "identity": "<object>",
                        "signingLeaf": {
                            "leafId": "<string>"
                        },
                        "deposit": "<object>",
                        "staticDeposit": {
                            "index": "<number>"
                        },
                        "htlcPreimage": "<object>"
                    },
                    "refundSignature": "<string>",
                    "directRefundSignature": "<string>",
                    "directFromCpfpRefundSignature": "<string>"
                }
            ],
            "threshold": "<number>",
            "operatorRecipients": [
                {
                    "operatorId": "<string>",
                    "encryptionPublicKey": "<string>"
                }
            ],
            "receiverPublicKey": "<string>"
        }
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_SPARK_PREPARE_TRANSFER",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "sparkPrepareTransferIntent": {
            "signWith": "<string>",
            "transfer": {
              "transferId": "<string>",
              "leaves": [
                {
                  "leafId": "<string>",
                  "oldLeafDerivation": {
                    "identity": "<object>",
                    "signingLeaf": {
                      "leafId": "<string>"
                    },
                    "deposit": "<object>",
                    "staticDeposit": {
                      "index": "<number>"
                    },
                    "htlcPreimage": "<object>"
                  },
                  "newLeafDerivation": {
                    "identity": "<object>",
                    "signingLeaf": {
                      "leafId": "<string>"
                    },
                    "deposit": "<object>",
                    "staticDeposit": {
                      "index": "<number>"
                    },
                    "htlcPreimage": "<object>"
                  },
                  "refundSignature": "<string>",
                  "directRefundSignature": "<string>",
                  "directFromCpfpRefundSignature": "<string>"
                }
              ],
              "threshold": "<number>",
              "operatorRecipients": [
                {
                  "operatorId": "<string>",
                  "encryptionPublicKey": "<string>"
                }
              ],
              "receiverPublicKey": "<string>"
            }
          }
        },
        "result": {
          "sparkPrepareTransferResult": {
            "operatorPackages": [
              {
                "operatorId": "<string>",
                "encryptedPackage": "<string>"
              }
            ],
            "transferUserSignature": "<string>",
            "newLeafPublicKeys": [
              {
                "leafId": "<string>",
                "publicKey": "<string>"
              }
            ]
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}