Skip to content

Commit ff390ae

Browse files
committed
Docs update
1 parent 3fb5f74 commit ff390ae

File tree

2,777 files changed

+2357
-2325
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2,777 files changed

+2357
-2325
lines changed

static/docc/base/data/documentation/bitcoinbase.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"topicSections":[{"anchor":"Extended-Structures","identifiers":["doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/PublicKey","doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/SecretKey","doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/Signature"],"title":"Extended Structures","generated":true}],"sections":[],"metadata":{"symbolKind":"extension","externalID":"s:m:s:e:s:13BitcoinCrypto9PublicKeyV0A4BaseE8tapTweak10merkleRoot10Foundation4DataVAI_tF","role":"collection","modules":[{"name":"Bitcoin Base"}],"title":"BitcoinCrypto","roleHeading":"Extended Module"},"hierarchy":{"paths":[["doc:\/\/BitcoinBase\/documentation\/BitcoinBase"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto"},"variants":[{"paths":["\/documentation\/bitcoinbase\/bitcoincrypto"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","references":{"doc://BitcoinBase/documentation/BitcoinBase/BitcoinCrypto/PublicKey":{"role":"symbol","url":"\/documentation\/bitcoinbase\/bitcoincrypto\/publickey","navigatorTitle":[{"text":"PublicKey","kind":"identifier"}],"kind":"symbol","type":"topic","abstract":[{"text":"Extensions for BIP341 taproot.","type":"text"}],"title":"PublicKey","fragments":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"kind":"identifier","preciseIdentifier":"s:13BitcoinCrypto9PublicKeyV","text":"PublicKey"}],"identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/PublicKey"},"doc://BitcoinBase/documentation/BitcoinBase/BitcoinCrypto/Signature":{"title":"Signature","navigatorTitle":[{"text":"Signature","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"text":"Signature","kind":"identifier","preciseIdentifier":"s:13BitcoinCrypto9SignatureV"}],"kind":"symbol","abstract":[],"type":"topic","url":"\/documentation\/bitcoinbase\/bitcoincrypto\/signature","role":"symbol","identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/Signature"},"doc://BitcoinBase/documentation/BitcoinBase/BitcoinCrypto":{"type":"topic","abstract":[],"title":"BitcoinCrypto","identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto","role":"collection","url":"\/documentation\/bitcoinbase\/bitcoincrypto","kind":"symbol"},"doc://BitcoinBase/documentation/BitcoinBase/BitcoinCrypto/SecretKey":{"kind":"symbol","url":"\/documentation\/bitcoinbase\/bitcoincrypto\/secretkey","identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/SecretKey","type":"topic","navigatorTitle":[{"kind":"identifier","text":"SecretKey"}],"abstract":[{"text":"Extensions for BIP341 taproot.","type":"text"}],"fragments":[{"text":"extension","kind":"keyword"},{"kind":"text","text":" "},{"preciseIdentifier":"s:13BitcoinCrypto9SecretKeyV","text":"SecretKey","kind":"identifier"}],"title":"SecretKey","role":"symbol"},"doc://BitcoinBase/documentation/BitcoinBase":{"title":"Bitcoin Base","url":"\/documentation\/bitcoinbase","role":"collection","kind":"symbol","abstract":[{"text":"Basic elements of the Bitcoin protocol, namely transactions and scripts.","type":"text"}],"identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase","type":"topic"}}}
1+
{"topicSections":[{"title":"Extended Structures","identifiers":["doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/AnySig","doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/PubKey","doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/SecretKey"],"anchor":"Extended-Structures","generated":true}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/bitcoinbase\/bitcoincrypto"]}],"hierarchy":{"paths":[["doc:\/\/BitcoinBase\/documentation\/BitcoinBase"]]},"metadata":{"title":"BitcoinCrypto","modules":[{"name":"Bitcoin Base"}],"role":"collection","roleHeading":"Extended Module","externalID":"s:m:s:e:s:13BitcoinCrypto6AnySigV0A4BaseE30schnorrSignatureExtendedLengthSivpZ","symbolKind":"extension"},"identifier":{"url":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://BitcoinBase/documentation/BitcoinBase/BitcoinCrypto/PubKey":{"abstract":[{"type":"text","text":"Extensions for BIP341 taproot."}],"identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/PubKey","fragments":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"text":"PubKey","kind":"identifier","preciseIdentifier":"s:13BitcoinCrypto6PubKeyV"}],"title":"PubKey","kind":"symbol","url":"\/documentation\/bitcoinbase\/bitcoincrypto\/pubkey","navigatorTitle":[{"text":"PubKey","kind":"identifier"}],"role":"symbol","type":"topic"},"doc://BitcoinBase/documentation/BitcoinBase":{"abstract":[{"type":"text","text":"Basic elements of the Bitcoin protocol, namely transactions and scripts."}],"title":"Bitcoin Base","url":"\/documentation\/bitcoinbase","kind":"symbol","type":"topic","role":"collection","identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase"},"doc://BitcoinBase/documentation/BitcoinBase/BitcoinCrypto/AnySig":{"type":"topic","title":"AnySig","kind":"symbol","identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/AnySig","role":"symbol","abstract":[],"navigatorTitle":[{"kind":"identifier","text":"AnySig"}],"url":"\/documentation\/bitcoinbase\/bitcoincrypto\/anysig","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:13BitcoinCrypto6AnySigV","text":"AnySig"}]},"doc://BitcoinBase/documentation/BitcoinBase/BitcoinCrypto":{"role":"collection","kind":"symbol","title":"BitcoinCrypto","url":"\/documentation\/bitcoinbase\/bitcoincrypto","abstract":[],"type":"topic","identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto"},"doc://BitcoinBase/documentation/BitcoinBase/BitcoinCrypto/SecretKey":{"kind":"symbol","type":"topic","role":"symbol","title":"SecretKey","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"preciseIdentifier":"s:13BitcoinCrypto9SecretKeyV","text":"SecretKey","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"SecretKey"}],"identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/SecretKey","abstract":[{"type":"text","text":"Extensions for BIP341 taproot."}],"url":"\/documentation\/bitcoinbase\/bitcoincrypto\/secretkey"}}}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"sections":[],"metadata":{"extendedModule":"BitcoinCrypto","title":"AnySig","modules":[{"name":"Bitcoin Base","relatedModules":["BitcoinCrypto"]}],"externalID":"s:e:s:13BitcoinCrypto6AnySigV0A4BaseE30schnorrSignatureExtendedLengthSivpZ","role":"symbol","symbolKind":"extension","navigatorTitle":[{"text":"AnySig","kind":"identifier"}],"roleHeading":"Extended Structure","fragments":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AnySig","kind":"identifier","preciseIdentifier":"s:13BitcoinCrypto6AnySigV"}]},"kind":"symbol","topicSections":[{"identifiers":["doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/AnySig\/schnorrSignatureExtendedLength"],"title":"Type Properties","generated":true,"anchor":"Type-Properties"}],"hierarchy":{"paths":[["doc:\/\/BitcoinBase\/documentation\/BitcoinBase","doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto"]]},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"preciseIdentifier":"s:13BitcoinCrypto6AnySigV","kind":"typeIdentifier","text":"AnySig"}]}],"kind":"declarations"}],"identifier":{"url":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/AnySig","interfaceLanguage":"swift"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/bitcoinbase\/bitcoincrypto\/anysig"]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"references":{"doc://BitcoinBase/documentation/BitcoinBase":{"abstract":[{"type":"text","text":"Basic elements of the Bitcoin protocol, namely transactions and scripts."}],"title":"Bitcoin Base","url":"\/documentation\/bitcoinbase","kind":"symbol","type":"topic","role":"collection","identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase"},"doc://BitcoinBase/documentation/BitcoinBase/BitcoinCrypto/AnySig/schnorrSignatureExtendedLength":{"role":"symbol","title":"schnorrSignatureExtendedLength","kind":"symbol","abstract":[{"text":"Standard Schnorr signature extended with the sighash type byte.","type":"text"}],"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"schnorrSignatureExtendedLength"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"type":"topic","identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/AnySig\/schnorrSignatureExtendedLength","url":"\/documentation\/bitcoinbase\/bitcoincrypto\/anysig\/schnorrsignatureextendedlength"},"doc://BitcoinBase/documentation/BitcoinBase/BitcoinCrypto":{"role":"collection","kind":"symbol","title":"BitcoinCrypto","url":"\/documentation\/bitcoinbase\/bitcoincrypto","abstract":[],"type":"topic","identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto"},"doc://BitcoinBase/documentation/BitcoinBase/BitcoinCrypto/AnySig":{"type":"topic","title":"AnySig","kind":"symbol","identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/AnySig","role":"symbol","abstract":[],"navigatorTitle":[{"kind":"identifier","text":"AnySig"}],"url":"\/documentation\/bitcoinbase\/bitcoincrypto\/anysig","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:13BitcoinCrypto6AnySigV","text":"AnySig"}]}}}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"schemaVersion":{"major":0,"minor":3,"patch":0},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"schnorrSignatureExtendedLength"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}],"languages":["swift"]}],"kind":"declarations"}],"kind":"symbol","metadata":{"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"kind":"text","text":" "},{"text":"schnorrSignatureExtendedLength","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"title":"schnorrSignatureExtendedLength","symbolKind":"property","extendedModule":"BitcoinCrypto","remoteSource":{"fileName":"BitcoinCrypto+.swift","url":"https:\/\/github.com\/swift-bitcoin\/swift-bitcoin\/blob\/develop\/src\/bitcoin-base\/support\/BitcoinCrypto+.swift#L69"},"roleHeading":"Type Property","role":"symbol","externalID":"s:13BitcoinCrypto6AnySigV0A4BaseE30schnorrSignatureExtendedLengthSivpZ","modules":[{"name":"Bitcoin Base","relatedModules":["BitcoinCrypto"]}]},"hierarchy":{"paths":[["doc:\/\/BitcoinBase\/documentation\/BitcoinBase","doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto","doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/AnySig"]]},"variants":[{"paths":["\/documentation\/bitcoinbase\/bitcoincrypto\/anysig\/schnorrsignatureextendedlength"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/AnySig\/schnorrSignatureExtendedLength"},"sections":[],"abstract":[{"text":"Standard Schnorr signature extended with the sighash type byte.","type":"text"}],"references":{"doc://BitcoinBase/documentation/BitcoinBase/BitcoinCrypto/AnySig/schnorrSignatureExtendedLength":{"role":"symbol","title":"schnorrSignatureExtendedLength","kind":"symbol","abstract":[{"text":"Standard Schnorr signature extended with the sighash type byte.","type":"text"}],"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"schnorrSignatureExtendedLength"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"}],"type":"topic","identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/AnySig\/schnorrSignatureExtendedLength","url":"\/documentation\/bitcoinbase\/bitcoincrypto\/anysig\/schnorrsignatureextendedlength"},"doc://BitcoinBase/documentation/BitcoinBase/BitcoinCrypto":{"role":"collection","kind":"symbol","title":"BitcoinCrypto","url":"\/documentation\/bitcoinbase\/bitcoincrypto","abstract":[],"type":"topic","identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto"},"doc://BitcoinBase/documentation/BitcoinBase":{"abstract":[{"type":"text","text":"Basic elements of the Bitcoin protocol, namely transactions and scripts."}],"title":"Bitcoin Base","url":"\/documentation\/bitcoinbase","kind":"symbol","type":"topic","role":"collection","identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase"},"doc://BitcoinBase/documentation/BitcoinBase/BitcoinCrypto/AnySig":{"type":"topic","title":"AnySig","kind":"symbol","identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/AnySig","role":"symbol","abstract":[],"navigatorTitle":[{"kind":"identifier","text":"AnySig"}],"url":"\/documentation\/bitcoinbase\/bitcoincrypto\/anysig","fragments":[{"kind":"keyword","text":"extension"},{"kind":"text","text":" "},{"kind":"identifier","preciseIdentifier":"s:13BitcoinCrypto6AnySigV","text":"AnySig"}]}}}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/bitcoinbase\/bitcoincrypto\/pubkey"]}],"hierarchy":{"paths":[["doc:\/\/BitcoinBase\/documentation\/BitcoinBase","doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto"]]},"abstract":[{"type":"text","text":"Extensions for BIP341 taproot."}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"extension","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PubKey","preciseIdentifier":"s:13BitcoinCrypto6PubKeyV","kind":"typeIdentifier"}],"platforms":["macOS"]}]}],"metadata":{"modules":[{"name":"Bitcoin Base","relatedModules":["BitcoinCrypto"]}],"roleHeading":"Extended Structure","symbolKind":"extension","role":"symbol","navigatorTitle":[{"text":"PubKey","kind":"identifier"}],"extendedModule":"BitcoinCrypto","externalID":"s:e:s:13BitcoinCrypto6PubKeyV0A4BaseE8tapTweak10merkleRoot10Foundation4DataVAI_tF","title":"PubKey","fragments":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"text":"PubKey","kind":"identifier","preciseIdentifier":"s:13BitcoinCrypto6PubKeyV"}]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/PubKey"},"schemaVersion":{"patch":0,"major":0,"minor":3},"topicSections":[{"title":"Instance Methods","identifiers":["doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/PubKey\/computeControlBlocks(_:)"],"generated":true,"anchor":"Instance-Methods"}],"sections":[],"references":{"doc://BitcoinBase/documentation/BitcoinBase":{"abstract":[{"type":"text","text":"Basic elements of the Bitcoin protocol, namely transactions and scripts."}],"title":"Bitcoin Base","url":"\/documentation\/bitcoinbase","kind":"symbol","type":"topic","role":"collection","identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase"},"doc://BitcoinBase/documentation/BitcoinBase/BitcoinCrypto/PubKey":{"abstract":[{"type":"text","text":"Extensions for BIP341 taproot."}],"identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/PubKey","fragments":[{"kind":"keyword","text":"extension"},{"text":" ","kind":"text"},{"text":"PubKey","kind":"identifier","preciseIdentifier":"s:13BitcoinCrypto6PubKeyV"}],"title":"PubKey","kind":"symbol","url":"\/documentation\/bitcoinbase\/bitcoincrypto\/pubkey","navigatorTitle":[{"text":"PubKey","kind":"identifier"}],"role":"symbol","type":"topic"},"doc://BitcoinBase/documentation/BitcoinBase/BitcoinCrypto":{"role":"collection","kind":"symbol","title":"BitcoinCrypto","url":"\/documentation\/bitcoinbase\/bitcoincrypto","abstract":[],"type":"topic","identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto"},"doc://BitcoinBase/documentation/BitcoinBase/BitcoinCrypto/PubKey/computeControlBlocks(_:)":{"abstract":[{"type":"text","text":"Used exclusively in "},{"code":"BIP341Tests","type":"codeVoice"},{"text":".","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"Self is an x-only public key."}],"role":"symbol","type":"topic","kind":"symbol","title":"computeControlBlocks(_:)","url":"\/documentation\/bitcoinbase\/bitcoincrypto\/pubkey\/computecontrolblocks(_:)","identifier":"doc:\/\/BitcoinBase\/documentation\/BitcoinBase\/BitcoinCrypto\/PubKey\/computeControlBlocks(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"computeControlBlocks"},{"text":"(","kind":"text"},{"text":"ScriptTree","preciseIdentifier":"s:11BitcoinBase10ScriptTreeO","kind":"typeIdentifier"},{"text":"?) -> (merkleRoot","kind":"text"},{"text":": ","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"kind":"text","text":", leafHashes"},{"kind":"text","text":": ["},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"], controlBlocks","kind":"text"},{"text":": [","kind":"text"},{"text":"Data","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DataV"},{"text":"])","kind":"text"}]}}}

0 commit comments

Comments
 (0)