core-lightning/doc/schemas/lightning-setpsbtversion.json

{
  "$schema": "../rpc-schema-draft.json",
  "type": "object",
  "additionalProperties": false,
  "rpc": "setpsbtversion",
  "title": "Command for setting PSBT version",
  "description": [
    "The **setpsbtversion** RPC command converts the provided PSBT to the given version, and returns the base64 result of the conversion. Returns an error if version is invalid."
  ],
  "request": {
    "required": [
      "psbt",
      "version"
    ],
    "properties": {
      "psbt": {
        "type": "string",
        "description": [
          "The PSBT to change versions."
        ]
      },
      "version": {
        "type": "u32",
        "description": [
          "The version to set."
        ]
      }
    }
  },
  "response": {
    "required": [
      "psbt"
    ],
    "properties": {
      "psbt": {
        "type": "string",
        "description": [
          "A converted PSBT of the requested version."
        ]
      }
    }
  },
  "errors": [
    "The following error codes may occur:",
    "",
    "- -32602: Parameter missed or malformed."
  ],
  "author": [
    "Gregory Sanders <<gsanders87@gmail.com>> is mainly responsible."
  ],
  "see_also": [
    "lightning-fundpsbt(7)",
    "lightning-utxopsbt(7)",
    "lightning-signpsbt(7)"
  ],
  "resources": [
    "Main web site: <https://github.com/ElementsProject/lightning>"
  ],
  "examples": [
    {
      "request": {
        "id": "example:setpsbtversion#1",
        "method": "setpsbtversion",
        "params": {
          "psbt": "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQABBQEBAQYBAwH7BAIAAAAAAQMIQEIPAAAAAAABBCJRIO7yw3zIUblRUcdhCLSjdFxJsYHu2s0Y29bT0bGAGdcbAA==",
          "version": 0
        }
      },
      "response": {
        "psbt": "cHNidP8BADUCAAAAAAFAQg8AAAAAACJRIO7yw3zIUblRUcdhCLSjdFxJsYHu2s0Y29bT0bGAGdcbbwAAAAAA"
      }
    },
    {
      "request": {
        "id": "example:setpsbtversion#2",
        "method": "setpsbtversion",
        "params": [
          "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQABBQEDAQYBAwH7BAIAAAAAAQMIQEIPAAAAAAABBCJRIO7yw3zIUblRUcdhCLSjdFxJsYHu2s0Y29bT0bGAGdcbAAEDCNXcMgAAAAAAAQQiUSA2cYCeVGcxdSZII2urHpalr5osmF2lPbYRaw1nKyPcmQABAwjV3DIAAAAAAAEEIlEgoqAceWUonu5Wtc/N25hWxw+kdsJk0h9xHGppr3dq5AMA",
          2
        ]
      },
      "response": {
        "psbt": "cHNidP8BAgQCAAAAAQMEbwAAAAEEAQABBQEDAQYBAwH7BAIAAAAAAQMIQEIPAAAAAAABBCJRIO7yw3zIUblRUcdhCLSjdFxJsYHu2s0Y29bT0bGAGdcbAAEDCNXcMgAAAAAAAQQiUSA2cYCeVGcxdSZII2urHpalr5osmF2lPbYRaw1nKyPcmQABAwjV3DIAAAAAAAEEIlEgoqAceWUonu5Wtc/N25hWxw+kdsJk0h9xHGppr3dq5AMA"
      }
    }
  ]
}