mirror of https://github.com/bitcoin/bitcoin.git synced 2024-11-19 09:53:47 +01:00

History

merge-script 9c5cdf07f3 Merge bitcoin/bitcoin#30287 : macOS: rewrite some docs & swap `mmacosx-version-min` for `mmacos-version-min` `7c298fe0df` doc: rewrite some of the macdeploy docs (fanquake) `d042230f7a` depends: swap mmacosx-version-min for mmacos-version-min (fanquake) Pull request description: Whilst `-mmacosx-version-min` and `-mmacos-version-min` remain aliases for each other, the later is preferred, and I assume the former will be removed at some point in the future; see: https://github.com/llvm/llvm-project/pull/95374. Somewhat of a followup to #21778. Rewrite some of the mac deploy docs. ACKs for top commit: theuni: utACK `7c298fe0df` TheCharlatan: ACK `7c298fe0df` hebasto: ACK `7c298fe0df`. Tree-SHA512: 6493f087fde93e0eec319af0e105d163b3f047d8a03f7d4b0d6cd7c64b58d0a978b7d67c6b8dba5c6ccf8b10e188aab5dc98eec400b0546dc9ee801a689b4332		2024-06-18 10:55:46 +01:00
..
detached-sig-create.sh	Use hardened runtime on macOS release builds.	2023-12-20 16:24:37 -08:00
gen-sdk	Revert "contrib: macdeploy: monkey-patch gen-sdk to be deterministic"	2024-06-13 13:48:26 +01:00
LICENSE	Added a copy of the GPLv3 to macdeployqtplus	2011-11-02 19:26:32 +01:00
macdeployqtplus	build: swap otool for (llvm-)objdump	2024-05-08 16:36:41 +08:00
README.md	doc: rewrite some of the macdeploy docs	2024-06-14 09:43:36 +01:00

README.md

MacOS Deployment

The macdeployqtplus script should not be run manually. Instead, after building as usual:

make deploy

When complete, it will have produced Bitcoin-Core.zip.

SDK Extraction

Step 1: Obtaining `Xcode.app`

A free Apple Developer Account is required to proceed.

Our macOS SDK can be extracted from Xcode_15.xip.

Alternatively, after logging in to your account go to 'Downloads', then 'More' and search for Xcode 15.

An Apple ID and cookies enabled for the hostname are needed to download this.

The sha256sum of the downloaded XIP archive should be 4daaed2ef2253c9661779fa40bfff50655dc7ec45801aba5a39653e7bcdde48e.

To extract the .xip on Linux:

# Install/clone tools needed for extracting Xcode.app
apt install cpio
git clone https://github.com/bitcoin-core/apple-sdk-tools.git

# Unpack the .xip and place the resulting Xcode.app in your current
# working directory
python3 apple-sdk-tools/extract_xcode.py -f Xcode_15.xip | cpio -d -i

On macOS:

xip -x Xcode_15.xip

Step 2: Generating the SDK tarball from `Xcode.app`

To generate the SDK, run the script gen-sdk with the path to Xcode.app (extracted in the previous stage) as the first argument.

./contrib/macdeploy/gen-sdk '/path/to/Xcode.app'

The generated archive should be: Xcode-15.0-15A240d-extracted-SDK-with-libcxx-headers.tar.gz. The sha256sum should be c0c2e7bb92c1fee0c4e9f3a485e4530786732d6c6dd9e9f418c282aa6892f55d.

Deterministic macOS App Notes

macOS Applications are created on Linux using a recent LLVM.

All builds must target an Apple SDK. These SDKs are free to download, but not redistributable. See the SDK Extraction notes above for how to obtain it.

The Guix build process has been designed to avoid including the SDK's files in Guix's outputs. All interim tarballs are fully deterministic and may be freely redistributed.

Using an Apple-blessed key to sign binaries is a requirement to produce (distributable) macOS binaries. Because this private key cannot be shared, we'll have to be a bit creative in order for the build process to remain somewhat deterministic. Here's how it works:

Builders use Guix to create an unsigned release. This outputs an unsigned ZIP which users may choose to bless, self-codesign, and run. It also outputs an unsigned app structure in the form of a tarball.
The Apple keyholder uses this unsigned app to create a detached signature, using the included script. Detached signatures are available from this repository.
Builders feed the unsigned app + detached signature back into Guix, which combines the pieces into a deterministic ZIP.