Update comments for the nullability annotation.

arik-so · arik-so · commit 8141bdd8d6f2 · 2023-10-02T20:07:38.000-10:00
diff --git a/out/structs/AcceptChannel.swift b/out/structs/AcceptChannel.swift
@@ -898,6 +898,8 @@ extension Bindings {
 		}
 
 		/// Constructs a new AcceptChannel given each field
+		///
+		/// Note that channel_type_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
 		public init(
 			temporaryChannelIdArg: [UInt8], dustLimitSatoshisArg: UInt64, maxHtlcValueInFlightMsatArg: UInt64,
 			channelReserveSatoshisArg: UInt64, htlcMinimumMsatArg: UInt64, minimumDepthArg: UInt32,
diff --git a/out/structs/AcceptChannelV2.swift b/out/structs/AcceptChannelV2.swift
@@ -1022,6 +1022,8 @@ extension Bindings {
 		}
 
 		/// Constructs a new AcceptChannelV2 given each field
+		///
+		/// Note that channel_type_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
 		@available(
 			*, deprecated,
 			message:
diff --git a/out/structs/ChannelCounterparty.swift b/out/structs/ChannelCounterparty.swift
@@ -425,6 +425,8 @@ extension Bindings {
 		}
 
 		/// Constructs a new ChannelCounterparty given each field
+		///
+		/// Note that forwarding_info_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
 		public init(
 			nodeIdArg: [UInt8], featuresArg: InitFeatures, unspendablePunishmentReserveArg: UInt64,
 			forwardingInfoArg: CounterpartyForwardingInfo, outboundHtlcMinimumMsatArg: UInt64?,
diff --git a/out/structs/ChannelDetails.swift b/out/structs/ChannelDetails.swift
@@ -1652,6 +1652,10 @@ extension Bindings {
 		}
 
 		/// Constructs a new ChannelDetails given each field
+		///
+		/// Note that funding_txo_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
+		/// Note that channel_type_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
+		/// Note that config_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
 		public init(
 			channelIdArg: [UInt8], counterpartyArg: ChannelCounterparty, fundingTxoArg: OutPoint,
 			channelTypeArg: ChannelTypeFeatures, shortChannelIdArg: UInt64?, outboundScidAliasArg: UInt64?,
diff --git a/out/structs/ChannelTransactionParameters.swift b/out/structs/ChannelTransactionParameters.swift
@@ -417,6 +417,9 @@ extension Bindings {
 		}
 
 		/// Constructs a new ChannelTransactionParameters given each field
+		///
+		/// Note that counterparty_parameters_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
+		/// Note that funding_outpoint_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
 		public init(
 			holderPubkeysArg: ChannelPublicKeys, holderSelectedContestDelayArg: UInt16, isOutboundFromHolderArg: Bool,
 			counterpartyParametersArg: CounterpartyChannelTransactionParameters, fundingOutpointArg: OutPoint,
diff --git a/out/structs/ChannelUpdateInfo.swift b/out/structs/ChannelUpdateInfo.swift
@@ -426,6 +426,8 @@ extension Bindings {
 		}
 
 		/// Constructs a new ChannelUpdateInfo given each field
+		///
+		/// Note that last_update_message_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
 		public init(
 			lastUpdateArg: UInt32, enabledArg: Bool, cltvExpiryDeltaArg: UInt16, htlcMinimumMsatArg: UInt64,
 			htlcMaximumMsatArg: UInt64, feesArg: RoutingFees, lastUpdateMessageArg: ChannelUpdate
diff --git a/out/structs/ClosingSigned.swift b/out/structs/ClosingSigned.swift
@@ -301,6 +301,8 @@ extension Bindings {
 		}
 
 		/// Constructs a new ClosingSigned given each field
+		///
+		/// Note that fee_range_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
 		public init(
 			channelIdArg: [UInt8], feeSatoshisArg: UInt64, signatureArg: [UInt8], feeRangeArg: ClosingSignedFeeRange
 		) {
diff --git a/out/structs/CommitmentUpdate.swift b/out/structs/CommitmentUpdate.swift
@@ -419,6 +419,8 @@ extension Bindings {
 		}
 
 		/// Constructs a new CommitmentUpdate given each field
+		///
+		/// Note that update_fee_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
 		public init(
 			updateAddHtlcsArg: [UpdateAddHTLC], updateFulfillHtlcsArg: [UpdateFulfillHTLC],
 			updateFailHtlcsArg: [UpdateFailHTLC], updateFailMalformedHtlcsArg: [UpdateFailMalformedHTLC],
diff --git a/out/structs/InvoiceError.swift b/out/structs/InvoiceError.swift
@@ -201,6 +201,8 @@ extension Bindings {
 		}
 
 		/// Constructs a new InvoiceError given each field
+		///
+		/// Note that erroneous_field_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
 		public init(erroneousFieldArg: ErroneousField, messageArg: UntrustedString) {
 			// native call variable prep
 
diff --git a/out/structs/NodeAnnouncementInfo.swift b/out/structs/NodeAnnouncementInfo.swift
@@ -355,6 +355,8 @@ extension Bindings {
 		}
 
 		/// Constructs a new NodeAnnouncementInfo given each field
+		///
+		/// Note that announcement_message_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
 		public init(
 			featuresArg: NodeFeatures, lastUpdateArg: UInt32, rgbArg: [UInt8], aliasArg: NodeAlias,
 			announcementMessageArg: NodeAnnouncement
diff --git a/out/structs/NodeInfo.swift b/out/structs/NodeInfo.swift
@@ -198,6 +198,8 @@ extension Bindings {
 		}
 
 		/// Constructs a new NodeInfo given each field
+		///
+		/// Note that announcement_info_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
 		public init(channelsArg: [UInt64], announcementInfoArg: NodeAnnouncementInfo) {
 			// native call variable prep
 
diff --git a/out/structs/OpenChannel.swift b/out/structs/OpenChannel.swift
@@ -1078,6 +1078,8 @@ extension Bindings {
 		}
 
 		/// Constructs a new OpenChannel given each field
+		///
+		/// Note that channel_type_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
 		public init(
 			chainHashArg: [UInt8], temporaryChannelIdArg: [UInt8], fundingSatoshisArg: UInt64, pushMsatArg: UInt64,
 			dustLimitSatoshisArg: UInt64, maxHtlcValueInFlightMsatArg: UInt64, channelReserveSatoshisArg: UInt64,
diff --git a/out/structs/OpenChannelV2.swift b/out/structs/OpenChannelV2.swift
@@ -1186,6 +1186,8 @@ extension Bindings {
 		}
 
 		/// Constructs a new OpenChannelV2 given each field
+		///
+		/// Note that channel_type_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
 		@available(
 			*, deprecated,
 			message:
diff --git a/out/structs/Path.swift b/out/structs/Path.swift
@@ -194,6 +194,8 @@ extension Bindings {
 		}
 
 		/// Constructs a new Path given each field
+		///
+		/// Note that blinded_tail_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
 		public init(hopsArg: [RouteHop], blindedTailArg: BlindedTail) {
 			// native call variable prep
 
diff --git a/out/structs/Route.swift b/out/structs/Route.swift
@@ -205,6 +205,8 @@ extension Bindings {
 		}
 
 		/// Constructs a new Route given each field
+		///
+		/// Note that route_params_arg (or a relevant inner pointer) may be NULL or all-0s to represent None
 		public init(pathsArg: [Path], routeParamsArg: RouteParameters) {
 			// native call variable prep
 

Original file line number	Diff line number	Diff line change
`@@ -898,6 +898,8 @@ extension Bindings {`
`898`	`898`	`}`
`899`	`899`
`900`	`900`	`/// Constructs a new AcceptChannel given each field`
	`901`	`+ ///`
	`902`	`+ /// Note that channel_type_arg (or a relevant inner pointer) may be NULL or all-0s to represent None`
`901`	`903`	`public init(`
`902`	`904`	`temporaryChannelIdArg: [UInt8], dustLimitSatoshisArg: UInt64, maxHtlcValueInFlightMsatArg: UInt64,`
`903`	`905`	`channelReserveSatoshisArg: UInt64, htlcMinimumMsatArg: UInt64, minimumDepthArg: UInt32,`
Original file line number	Diff line number	Diff line change
`@@ -1022,6 +1022,8 @@ extension Bindings {`
`1022`	`1022`	`}`
`1023`	`1023`
`1024`	`1024`	`/// Constructs a new AcceptChannelV2 given each field`
	`1025`	`+ ///`
	`1026`	`+ /// Note that channel_type_arg (or a relevant inner pointer) may be NULL or all-0s to represent None`
`1025`	`1027`	`@available(`
`1026`	`1028`	`*, deprecated,`
`1027`	`1029`	`message:`
Original file line number	Diff line number	Diff line change
`@@ -425,6 +425,8 @@ extension Bindings {`
`425`	`425`	`}`
`426`	`426`
`427`	`427`	`/// Constructs a new ChannelCounterparty given each field`
	`428`	`+ ///`
	`429`	`+ /// Note that forwarding_info_arg (or a relevant inner pointer) may be NULL or all-0s to represent None`
`428`	`430`	`public init(`
`429`	`431`	`nodeIdArg: [UInt8], featuresArg: InitFeatures, unspendablePunishmentReserveArg: UInt64,`
`430`	`432`	`forwardingInfoArg: CounterpartyForwardingInfo, outboundHtlcMinimumMsatArg: UInt64?,`
Original file line number	Diff line number	Diff line change
`@@ -417,6 +417,9 @@ extension Bindings {`
`417`	`417`	`}`
`418`	`418`
`419`	`419`	`/// Constructs a new ChannelTransactionParameters given each field`
	`420`	`+ ///`
	`421`	`+ /// Note that counterparty_parameters_arg (or a relevant inner pointer) may be NULL or all-0s to represent None`
	`422`	`+ /// Note that funding_outpoint_arg (or a relevant inner pointer) may be NULL or all-0s to represent None`
`420`	`423`	`public init(`
`421`	`424`	`holderPubkeysArg: ChannelPublicKeys, holderSelectedContestDelayArg: UInt16, isOutboundFromHolderArg: Bool,`
`422`	`425`	`counterpartyParametersArg: CounterpartyChannelTransactionParameters, fundingOutpointArg: OutPoint,`
Original file line number	Diff line number	Diff line change
`@@ -426,6 +426,8 @@ extension Bindings {`
`426`	`426`	`}`
`427`	`427`
`428`	`428`	`/// Constructs a new ChannelUpdateInfo given each field`
	`429`	`+ ///`
	`430`	`+ /// Note that last_update_message_arg (or a relevant inner pointer) may be NULL or all-0s to represent None`
`429`	`431`	`public init(`
`430`	`432`	`lastUpdateArg: UInt32, enabledArg: Bool, cltvExpiryDeltaArg: UInt16, htlcMinimumMsatArg: UInt64,`
`431`	`433`	`htlcMaximumMsatArg: UInt64, feesArg: RoutingFees, lastUpdateMessageArg: ChannelUpdate`
Original file line number	Diff line number	Diff line change
`@@ -301,6 +301,8 @@ extension Bindings {`
`301`	`301`	`}`
`302`	`302`
`303`	`303`	`/// Constructs a new ClosingSigned given each field`
	`304`	`+ ///`
	`305`	`+ /// Note that fee_range_arg (or a relevant inner pointer) may be NULL or all-0s to represent None`
`304`	`306`	`public init(`
`305`	`307`	`channelIdArg: [UInt8], feeSatoshisArg: UInt64, signatureArg: [UInt8], feeRangeArg: ClosingSignedFeeRange`
`306`	`308`	`) {`
Original file line number	Diff line number	Diff line change
`@@ -419,6 +419,8 @@ extension Bindings {`
`419`	`419`	`}`
`420`	`420`
`421`	`421`	`/// Constructs a new CommitmentUpdate given each field`
	`422`	`+ ///`
	`423`	`+ /// Note that update_fee_arg (or a relevant inner pointer) may be NULL or all-0s to represent None`
`422`	`424`	`public init(`
`423`	`425`	`updateAddHtlcsArg: [UpdateAddHTLC], updateFulfillHtlcsArg: [UpdateFulfillHTLC],`
`424`	`426`	`updateFailHtlcsArg: [UpdateFailHTLC], updateFailMalformedHtlcsArg: [UpdateFailMalformedHTLC],`
Original file line number	Diff line number	Diff line change
`@@ -201,6 +201,8 @@ extension Bindings {`
`201`	`201`	`}`
`202`	`202`
`203`	`203`	`/// Constructs a new InvoiceError given each field`
	`204`	`+ ///`
	`205`	`+ /// Note that erroneous_field_arg (or a relevant inner pointer) may be NULL or all-0s to represent None`
`204`	`206`	`public init(erroneousFieldArg: ErroneousField, messageArg: UntrustedString) {`
`205`	`207`	`// native call variable prep`
`206`	`208`
Original file line number	Diff line number	Diff line change
`@@ -355,6 +355,8 @@ extension Bindings {`
`355`	`355`	`}`
`356`	`356`
`357`	`357`	`/// Constructs a new NodeAnnouncementInfo given each field`
	`358`	`+ ///`
	`359`	`+ /// Note that announcement_message_arg (or a relevant inner pointer) may be NULL or all-0s to represent None`
`358`	`360`	`public init(`
`359`	`361`	`featuresArg: NodeFeatures, lastUpdateArg: UInt32, rgbArg: [UInt8], aliasArg: NodeAlias,`
`360`	`362`	`announcementMessageArg: NodeAnnouncement`