├── .github └── workflows │ └── deploy.yml ├── .gitignore ├── README.md ├── babel.config.js ├── btc-docs ├── advanced │ ├── _category_.json │ └── how-to-debug-scriptcontext.md ├── bitcoin-basics │ ├── _category_.json │ ├── bitcoin-basics.md │ └── bitcoinjs-lib.md ├── how-to-debug-a-contract.md ├── how-to-deploy-and-call-a-contract │ ├── _category_.json │ ├── call-deployed.md │ ├── deploy-cli.md │ ├── faucet.md │ └── how-to-deploy-and-call-a-contract.md ├── how-to-integrate-a-frontend │ └── how-to-integrate-a-frontend.md ├── how-to-test-a-contract.md ├── how-to-write-a-contract │ ├── _category_.json │ ├── basics.md │ ├── built-ins.md │ ├── scriptcontext.md │ └── stateful-contract.md ├── installation.md ├── overview.md ├── references │ ├── _category_.json │ ├── bitcoinjs-lib │ │ ├── README.md │ │ ├── _category_.json │ │ ├── classes │ │ │ ├── Block.md │ │ │ ├── BufferReader.md │ │ │ ├── BufferWriter.md │ │ │ ├── Interpreter.md │ │ │ ├── Psbt.md │ │ │ └── Transaction.md │ │ ├── functions │ │ │ ├── bn2Buf.md │ │ │ ├── buf2BN.md │ │ │ ├── cloneBuffer.md │ │ │ ├── getEccLib.md │ │ │ ├── initEccLib.md │ │ │ ├── isFinal.md │ │ │ ├── isFinalized.md │ │ │ ├── isNullInput.md │ │ │ ├── isOpSuccess.md │ │ │ ├── readOutput.md │ │ │ ├── reverseBuffer.md │ │ │ ├── tapTreeFromList.md │ │ │ ├── tapTreeToList.md │ │ │ ├── toXOnly.md │ │ │ ├── varSliceSize.md │ │ │ └── vectorSize.md │ │ ├── interfaces │ │ │ ├── HDSigner.md │ │ │ ├── HDSignerAsync.md │ │ │ ├── PsbtOptsOptional.md │ │ │ ├── PsbtTxInput.md │ │ │ ├── PsbtTxOutput.md │ │ │ ├── Signer.md │ │ │ ├── SignerAsync.md │ │ │ ├── TransactionInput.md │ │ │ ├── TxInput.md │ │ │ └── TxOutput.md │ │ ├── namespaces │ │ │ ├── address │ │ │ │ ├── README.md │ │ │ │ ├── functions │ │ │ │ │ ├── fromBase58Check.md │ │ │ │ │ ├── fromBech32.md │ │ │ │ │ ├── fromOutputScript.md │ │ │ │ │ ├── toBase58Check.md │ │ │ │ │ ├── toBech32.md │ │ │ │ │ └── toOutputScript.md │ │ │ │ └── interfaces │ │ │ │ │ ├── Base58CheckResult.md │ │ │ │ │ └── Bech32Result.md │ │ │ ├── bip341 │ │ │ │ └── README.md │ │ │ ├── bip371 │ │ │ │ ├── README.md │ │ │ │ └── functions │ │ │ │ │ ├── checkTaprootInputFields.md │ │ │ │ │ ├── checkTaprootInputForSigs.md │ │ │ │ │ ├── checkTaprootOutputFields.md │ │ │ │ │ ├── decodeSchnorrSignature.md │ │ │ │ │ ├── isTaprootInput.md │ │ │ │ │ ├── isTaprootOutput.md │ │ │ │ │ ├── serializeTaprootSignature.md │ │ │ │ │ ├── tapScriptFinalizer.md │ │ │ │ │ └── tweakInternalPubKey.md │ │ │ ├── bn │ │ │ │ └── README.md │ │ │ ├── bufferutils │ │ │ │ ├── README.md │ │ │ │ └── namespaces │ │ │ │ │ └── varuint │ │ │ │ │ ├── README.md │ │ │ │ │ └── functions │ │ │ │ │ ├── decode.md │ │ │ │ │ ├── encode.md │ │ │ │ │ └── encodingLength.md │ │ │ ├── crypto │ │ │ │ ├── README.md │ │ │ │ ├── functions │ │ │ │ │ ├── hash160.md │ │ │ │ │ ├── hash256.md │ │ │ │ │ └── taggedHash.md │ │ │ │ ├── type-aliases │ │ │ │ │ └── TaggedHashPrefix.md │ │ │ │ └── variables │ │ │ │ │ ├── TAGGED_HASH_PREFIXES.md │ │ │ │ │ └── TAGS.md │ │ │ ├── interpreter │ │ │ │ ├── README.md │ │ │ │ └── enumerations │ │ │ │ │ └── InterpreterErr.md │ │ │ ├── networks │ │ │ │ ├── README.md │ │ │ │ ├── interfaces │ │ │ │ │ └── Network.md │ │ │ │ └── variables │ │ │ │ │ ├── bitcoin.md │ │ │ │ │ ├── regtest.md │ │ │ │ │ └── testnet.md │ │ │ ├── payments │ │ │ │ ├── README.md │ │ │ │ ├── functions │ │ │ │ │ ├── embed.md │ │ │ │ │ ├── findScriptPath.md │ │ │ │ │ ├── p2ms.md │ │ │ │ │ ├── p2pk.md │ │ │ │ │ ├── p2pkh.md │ │ │ │ │ ├── p2sh.md │ │ │ │ │ ├── p2tr.md │ │ │ │ │ ├── p2wpkh.md │ │ │ │ │ ├── p2wsh.md │ │ │ │ │ ├── rootHashFromPath.md │ │ │ │ │ ├── tapTweakHash.md │ │ │ │ │ ├── tapleafHash.md │ │ │ │ │ ├── toHashTree.md │ │ │ │ │ └── tweakKey.md │ │ │ │ ├── interfaces │ │ │ │ │ ├── Payment.md │ │ │ │ │ └── PaymentOpts.md │ │ │ │ ├── type-aliases │ │ │ │ │ ├── HashTree.md │ │ │ │ │ ├── PaymentCreator.md │ │ │ │ │ ├── PaymentFunction.md │ │ │ │ │ ├── Stack.md │ │ │ │ │ ├── StackElement.md │ │ │ │ │ └── StackFunction.md │ │ │ │ └── variables │ │ │ │ │ ├── LEAF_VERSION_TAPSCRIPT.md │ │ │ │ │ └── MAX_TAPTREE_DEPTH.md │ │ │ ├── psbt │ │ │ │ ├── README.md │ │ │ │ ├── interfaces │ │ │ │ │ ├── PsbtInputExtended.md │ │ │ │ │ ├── PsbtOpts.md │ │ │ │ │ ├── PsbtOutputExtendedAddress.md │ │ │ │ │ ├── PsbtOutputExtendedScript.md │ │ │ │ │ └── TransactionOutput.md │ │ │ │ └── type-aliases │ │ │ │ │ ├── PsbtOutputExtended.md │ │ │ │ │ └── ValidateSigFunction.md │ │ │ ├── psbtutils │ │ │ │ ├── README.md │ │ │ │ └── functions │ │ │ │ │ ├── checkInputForSig.md │ │ │ │ │ ├── isP2MS.md │ │ │ │ │ ├── isP2PK.md │ │ │ │ │ ├── isP2PKH.md │ │ │ │ │ ├── isP2SHScript.md │ │ │ │ │ ├── isP2TR.md │ │ │ │ │ ├── isP2WPKH.md │ │ │ │ │ ├── isP2WSHScript.md │ │ │ │ │ ├── pubkeyInScript.md │ │ │ │ │ ├── pubkeyPositionInScript.md │ │ │ │ │ ├── signatureBlocksAction.md │ │ │ │ │ └── witnessStackToScriptWitness.md │ │ │ ├── script │ │ │ │ ├── README.md │ │ │ │ ├── functions │ │ │ │ │ ├── asMinimalOP.md │ │ │ │ │ ├── checkMinimalPush.md │ │ │ │ │ ├── compile.md │ │ │ │ │ ├── countNonPushOnlyOPs.md │ │ │ │ │ ├── createWitnessProgram.md │ │ │ │ │ ├── decompile.md │ │ │ │ │ ├── findAndDelete.md │ │ │ │ │ ├── fromASM.md │ │ │ │ │ ├── isCanonicalPubKey.md │ │ │ │ │ ├── isCanonicalScriptSignature.md │ │ │ │ │ ├── isDefinedHashType.md │ │ │ │ │ ├── isMinimalPush.md │ │ │ │ │ ├── isPushOnly.md │ │ │ │ │ ├── isScriptHashOut.md │ │ │ │ │ ├── isUncompressedPubkey.md │ │ │ │ │ ├── toASM.md │ │ │ │ │ └── toStack.md │ │ │ │ └── variables │ │ │ │ │ ├── OPS.md │ │ │ │ │ ├── number.md │ │ │ │ │ └── signature.md │ │ │ ├── scriptNumber │ │ │ │ ├── README.md │ │ │ │ └── functions │ │ │ │ │ ├── decode.md │ │ │ │ │ └── encode.md │ │ │ └── types │ │ │ │ ├── README.md │ │ │ │ ├── functions │ │ │ │ ├── NBufferSchemaFactory.md │ │ │ │ ├── NullablePartial.md │ │ │ │ ├── isPoint.md │ │ │ │ ├── isTapleaf.md │ │ │ │ ├── isTaptree.md │ │ │ │ └── stacksEqual.md │ │ │ │ ├── interfaces │ │ │ │ ├── Tapleaf.md │ │ │ │ ├── TinySecp256k1Interface.md │ │ │ │ └── XOnlyPointAddTweakResult.md │ │ │ │ └── variables │ │ │ │ ├── Buffer256bitSchema.md │ │ │ │ ├── BufferSchema.md │ │ │ │ ├── Hash160bitSchema.md │ │ │ │ ├── Hash256bitSchema.md │ │ │ │ ├── HexSchema.md │ │ │ │ ├── SatoshiSchema.md │ │ │ │ ├── TAPLEAF_VERSION_MASK.md │ │ │ │ ├── UInt32Schema.md │ │ │ │ ├── UInt8Schema.md │ │ │ │ └── x0HexSchema.md │ │ ├── type-aliases │ │ │ └── Taptree.md │ │ └── variables │ │ │ └── reverse_opcodes.md │ └── sdk │ │ ├── README.md │ │ ├── _category_.json │ │ ├── classes │ │ ├── Backtrace.md │ │ ├── ContextUtils.md │ │ ├── Covenant.md │ │ ├── DefaultSigner.md │ │ ├── DummyProvider.md │ │ ├── ExtPsbt.md │ │ ├── MempoolProvider.md │ │ ├── OpCode.md │ │ ├── RPCProvider.md │ │ ├── SmartContract.md │ │ ├── SmartContractLib.md │ │ ├── StateLib.md │ │ ├── StateUtils.md │ │ ├── StatefulCovenant.md │ │ ├── StdUtils.md │ │ ├── TxProof.md │ │ ├── TxUtils.md │ │ └── UnisatSigner.md │ │ ├── enumerations │ │ └── SigHashType.md │ │ ├── functions │ │ ├── Addr.md │ │ ├── OpCodeType.md │ │ ├── PrivKey.md │ │ ├── PubKey.md │ │ ├── PubKeyHash.md │ │ ├── Ripemd160-1.md │ │ ├── Sha1-1.md │ │ ├── Sha256-1.md │ │ ├── Sig.md │ │ ├── XOnlyPubKey.md │ │ ├── abs.md │ │ ├── assert.md │ │ ├── bvmVerify.md │ │ ├── byteStringToInt32.md │ │ ├── call.md │ │ ├── deploy.md │ │ ├── equals.md │ │ ├── fill.md │ │ ├── fillFixedArray.md │ │ ├── getBackTraceInfo.md │ │ ├── hash160.md │ │ ├── hash256.md │ │ ├── hexToUint8Array.md │ │ ├── int32ToByteString.md │ │ ├── len.md │ │ ├── max.md │ │ ├── method.md │ │ ├── min.md │ │ ├── prop.md │ │ ├── pubKey2Addr.md │ │ ├── ripemd160.md │ │ ├── sha1.md │ │ ├── sha256.md │ │ ├── textToHex.md │ │ ├── toBitcoinNetwork.md │ │ ├── toByteString.md │ │ ├── toXOnly.md │ │ ├── uint8ArrayToHex.md │ │ └── within.md │ │ ├── interfaces │ │ ├── ABI.md │ │ ├── ABIEntity.md │ │ ├── Artifact.md │ │ ├── ChainProvider.md │ │ ├── IExtPsbt.md │ │ ├── MethodDecoratorOptions.md │ │ ├── SignOptions.md │ │ ├── Signer.md │ │ ├── ToSignInput.md │ │ ├── UnisatAPI.md │ │ ├── UtxoProvider.md │ │ └── UtxoQueryOptions.md │ │ └── type-aliases │ │ ├── Addr.md │ │ ├── BacktraceInfo.md │ │ ├── Bool.md │ │ ├── ByteString.md │ │ ├── ChainTxVerifyResponse.md │ │ ├── CompactTxHashPreimage.md │ │ ├── FixedArray.md │ │ ├── HashRootTxHashPreimage.md │ │ ├── InputStateProof.md │ │ ├── InputStateProofs.md │ │ ├── Int32.md │ │ ├── OpCodeType.md │ │ ├── Outpoint.md │ │ ├── Prevouts.md │ │ ├── PrivKey.md │ │ ├── PubKey.md │ │ ├── PubKeyHash.md │ │ ├── Ripemd160.md │ │ ├── SHPreimage.md │ │ ├── Sha1.md │ │ ├── Sha256.md │ │ ├── Sig.md │ │ ├── SpentAmounts.md │ │ ├── SpentScripts.md │ │ ├── StateHashes.md │ │ ├── StatefulCovenantUtxo.md │ │ ├── SupportedNetwork.md │ │ ├── TxHashPreimage.md │ │ ├── TxIn.md │ │ ├── TxOut.md │ │ └── XOnlyPubKey.md ├── sidebars.js └── tutorials │ ├── _category_.json │ ├── auction.md │ └── hello-world.md ├── docs ├── advanced │ ├── How to only sign p2pkh inputs.md │ ├── _category_.json │ ├── codeseparator.md │ ├── how-to-add-a-provider.md │ ├── how-to-add-a-signer.md │ ├── how-to-build-an-oracle-service.md │ ├── how-to-call-multiple-contracts.md │ ├── how-to-debug-scriptcontext.md │ ├── how-to-integrate-scrypt-service.md │ ├── how-to-replay-instance.md │ ├── inline-asm.md │ ├── sighash-type.md │ └── timeLock.md ├── bitcoin-basics │ ├── _category_.json │ ├── bitcoin-basics.md │ └── bsv.md ├── ethereum-devs.md ├── faq.md ├── how-to-debug-a-contract.md ├── how-to-deploy-and-call-a-contract │ ├── _category_.json │ ├── call-deployed.md │ ├── deploy-cli.md │ ├── faucet.md │ ├── how-to-customize-a-contract-tx.md │ └── how-to-deploy-and-call-a-contract.md ├── how-to-integrate-a-frontend │ ├── how-to-integrate-a-frontend.md │ └── how-to-integrate-dotwallet.md ├── how-to-publish-a-contract.md ├── how-to-test-a-contract.md ├── how-to-verify-a-contract.md ├── how-to-write-a-contract │ ├── _category_.json │ ├── basics.md │ ├── built-ins.md │ ├── scriptcontext.md │ └── stateful-contract.md ├── installation.md ├── overview.md ├── reference │ ├── .nojekyll │ ├── README.md │ ├── _category_.json │ ├── classes │ │ ├── ActionError.md │ │ ├── BsvApi.md │ │ ├── Constants.md │ │ ├── ContractApi.md │ │ ├── DefaultProvider.md │ │ ├── DotwalletSigner.md │ │ ├── DummyProvider.md │ │ ├── FunctionCall.md │ │ ├── GorillapoolProvider.md │ │ ├── HashedMap.md │ │ ├── HashedSet.md │ │ ├── OpCode.md │ │ ├── Provider.md │ │ ├── ScryptProvider.md │ │ ├── SensibleProvider.md │ │ ├── SensiletSigner.md │ │ ├── SigHash.md │ │ ├── Signer.md │ │ ├── SmartContract.md │ │ ├── SmartContractLib.md │ │ ├── TAALSigner.md │ │ ├── TaalProvider.md │ │ ├── TestWallet.md │ │ ├── Utils.md │ │ ├── VarIntReader.md │ │ ├── VarIntWriter.md │ │ ├── WhatsonchainProvider.md │ │ ├── bsv.Address.md │ │ ├── bsv.Block.md │ │ ├── bsv.BlockHeader.md │ │ ├── bsv.ECIES.md │ │ ├── bsv.HDPrivateKey.md │ │ ├── bsv.HDPublicKey.md │ │ ├── bsv.MerkleBlock.md │ │ ├── bsv.Message.md │ │ ├── bsv.Mnemonic.md │ │ ├── bsv.Opcode.md │ │ ├── bsv.PrivateKey.md │ │ ├── bsv.PublicKey.md │ │ ├── bsv.Script-1.md │ │ ├── bsv.Script.Interpreter-1.md │ │ ├── bsv.Transaction-1.md │ │ ├── bsv.Transaction.Input-1.md │ │ ├── bsv.Transaction.Input.PublicKeyHash.md │ │ ├── bsv.Transaction.Output.md │ │ ├── bsv.Transaction.Signature.md │ │ ├── bsv.Transaction.UnspentOutput.md │ │ ├── bsv.Unit.md │ │ ├── bsv.crypto.BN.md │ │ ├── bsv.crypto.Point.md │ │ ├── bsv.crypto.Signature.md │ │ ├── bsv.encoding.Base58.md │ │ ├── bsv.encoding.Base58Check.md │ │ ├── bsv.encoding.BufferReader.md │ │ ├── bsv.encoding.BufferWriter.md │ │ └── bsv.encoding.Varint.md │ ├── enums │ │ ├── ProviderEvent.md │ │ └── SignatureHashType.md │ ├── interfaces │ │ ├── Artifact.md │ │ ├── ContractCalledEvent.md │ │ ├── ContractTransaction.md │ │ ├── DefaultProviderOption.md │ │ ├── LogConfig.md │ │ ├── MethodCallOptions.md │ │ ├── MethodCallTxBuilder.md │ │ ├── MultiContractCallOptions.md │ │ ├── MultiContractTransaction.md │ │ ├── Outpoint.md │ │ ├── RequestConfig.md │ │ ├── ScriptContext.md │ │ ├── ScryptConfig.md │ │ ├── SignTransactionOptions.md │ │ ├── SignatureRequest.md │ │ ├── SignatureResponse.md │ │ ├── StatefulNext.md │ │ ├── SubScription.md │ │ ├── SubscribeOptions.md │ │ ├── TransactionResponse.md │ │ ├── TxContext.md │ │ ├── TxInputRef.md │ │ ├── TxOutputRef.md │ │ ├── UtxoQueryOptions.md │ │ ├── VerifyResult.md │ │ ├── bsv.Networks.Network.md │ │ ├── bsv.Script.IOpChunk.md │ │ ├── bsv.Script.Interpreter.InterpretState.md │ │ ├── bsv.Transaction.IUnspentOutput.md │ │ ├── bsv.Util.md │ │ └── bsv.crypto.IOpts.md │ └── modules │ │ ├── bsv.Networks.md │ │ ├── bsv.Script.Interpreter.md │ │ ├── bsv.Script.md │ │ ├── bsv.Transaction.Input.md │ │ ├── bsv.Transaction.Sighash.md │ │ ├── bsv.Transaction.md │ │ ├── bsv.crypto.ECDSA.md │ │ ├── bsv.crypto.Hash.md │ │ ├── bsv.crypto.Random.md │ │ ├── bsv.crypto.md │ │ ├── bsv.encoding.md │ │ └── bsv.md ├── sidebars.js ├── tokens │ ├── _category_.json │ ├── ft │ │ ├── existing.md │ │ ├── ft.md │ │ ├── multiple.md │ │ └── woc-bsv20-plugin.md │ ├── nft │ │ ├── existing.md │ │ └── nft.md │ ├── tokens.md │ └── tutorials │ │ ├── _category_.json │ │ ├── inscribe-image.md │ │ ├── mint-bsv20-v1.md │ │ ├── mint-bsv20-v2.md │ │ ├── ordi-oracle.md │ │ └── ordinal-lock.md └── tutorials │ ├── _category_.json │ ├── auction.md │ ├── escrow.md │ ├── hello-world.md │ ├── oracle.md │ ├── ordinal-auction.md │ ├── tic-tac-toe.md │ ├── voting.md │ └── zkp.md ├── docusaurus.config.js ├── open-api ├── btc-blockchain.yaml ├── btc-blockchain │ ├── get-address-balance.api.mdx │ ├── get-address-transaction-history.api.mdx │ ├── get-address-utxo.api.mdx │ ├── get-transaction-summary.api.mdx │ ├── introduction.info.mdx │ └── sidebar.js ├── btc-token.yaml ├── btc-token │ ├── deploy-a-brc-20-token.api.mdx │ ├── etch-a-rune.api.mdx │ ├── get-address-brc-20-balance-list.api.mdx │ ├── get-address-brc-20-balance.api.mdx │ ├── get-address-runes-balance-list.api.mdx │ ├── get-address-runes-balance.api.mdx │ ├── get-address-runes-history.api.mdx │ ├── get-address-runes-utxo-list.api.mdx │ ├── get-address-runes-utxo.api.mdx │ ├── get-bitmap-info.api.mdx │ ├── get-bitmap-list-by-address.api.mdx │ ├── get-bitmap-list.api.mdx │ ├── get-brc-20-holders.api.mdx │ ├── get-brc-20-ticker-info.api.mdx │ ├── get-inscription-content.api.mdx │ ├── get-inscription-info-by-address.api.mdx │ ├── get-inscription-info-by-outpoint.api.mdx │ ├── get-inscription-info.api.mdx │ ├── get-order-info.api.mdx │ ├── get-outpoint-runes-balance-list.api.mdx │ ├── get-runes-holders.api.mdx │ ├── get-runes-info.api.mdx │ ├── get-sns-name-info.api.mdx │ ├── get-sns-name-list-by-address.api.mdx │ ├── get-sns-name-list-by-namespace.api.mdx │ ├── get-sns-name-list.api.mdx │ ├── get-transferable-brc-20-inscriptions.api.mdx │ ├── inscribe-inscriptions.api.mdx │ ├── introduction.info.mdx │ ├── mint-a-brc-20-token.api.mdx │ ├── mint-a-rune.api.mdx │ ├── pay-brc-20-minting-order.api.mdx │ ├── pay-deploying-order.api.mdx │ ├── pay-etching-order.api.mdx │ ├── pay-inscribing-order.api.mdx │ ├── pay-minting-order.api.mdx │ ├── pay-transfering-order.api.mdx │ ├── sidebar.js │ └── transfer-a-brc-20-token.api.mdx ├── overview.md └── sidebars.js ├── package.json ├── scripts └── render_open_api_docs.py ├── src ├── components │ ├── Faucet.jsx │ ├── HomepageFeatures │ │ ├── index.js │ │ └── styles.module.css │ └── faucet.css ├── css │ └── custom.css └── pages │ └── overview.js ├── static ├── .nojekyll ├── CNAME ├── img │ ├── advanced-counter-call.png │ ├── api-keys.png │ ├── asm.png │ ├── bsv20-plugin_1.png │ ├── bsv20-plugin_2.png │ ├── call.png │ ├── checksig-failed.png │ ├── close.jpg │ ├── contract-artifacts.png │ ├── contract_tx.svg │ ├── copy-contract-source.png │ ├── counter-call.png │ ├── create-angular-app.png │ ├── create-next-app.png │ ├── create-svelte-app.png │ ├── create-vue2-vite-app.png │ ├── create-vue3-vite-app.png │ ├── create-webhook.png │ ├── debug.jpg │ ├── debugging1.gif │ ├── debugging2.gif │ ├── decoded-inscribed-image.png │ ├── deploy-output.png │ ├── diffoutputs-btc.png │ ├── diffoutputs.png │ ├── discord.png │ ├── docusaurus.png │ ├── dotwallet-auth.png │ ├── dotwallet-create-dapp.png │ ├── dotwallet-mail.png │ ├── dotwallet-uris.png │ ├── email.png │ ├── extract-sensilet-private-key.gif │ ├── faucet.gif │ ├── favicon.png │ ├── frontend-dependency.png │ ├── gh-pages.png │ ├── github.png │ ├── hello-world-contract-call-tx-btc.png │ ├── hello-world-contract-call-tx.png │ ├── hello-world-contract-deploy-tx-btc.png │ ├── hello-world-contract-deploy-tx.png │ ├── hello-world-deploy-and-call-output-btc.png │ ├── hello-world-deploy-and-call-output.png │ ├── homepage.png │ ├── inscribe-image.png │ ├── inscribed-tx.png │ ├── insufficient-balance.png │ ├── mandatory-script-verify-flag-failed.png │ ├── medium.png │ ├── mint-bsv20-mint-tx.png │ ├── mint-bsv20-transfer-tx.png │ ├── mint-bsv20.png │ ├── mint-bsv20v2-mint-tx.png │ ├── mint-bsv20v2-transfer-tx.png │ ├── mint-bsv20v2.png │ ├── missing-inputs.png │ ├── no-private-key.png │ ├── oauth2.png │ ├── opcs.png │ ├── opcs_mul.jpg │ ├── open-api-auth.png │ ├── oracle-demo-bsv20-unlocking-tx.png │ ├── oracle.jpeg │ ├── oracle.png │ ├── ordinal-lock │ │ ├── buy1.png │ │ ├── buy2.png │ │ ├── buy3.png │ │ ├── buy4.png │ │ ├── load1.png │ │ ├── load2.png │ │ ├── panda-buy1.png │ │ ├── panda-buy2.png │ │ ├── panda-load1.png │ │ ├── panda-load2.png │ │ ├── panda-sell1.png │ │ ├── panda-sell2.png │ │ ├── sell1.png │ │ └── sell2.png │ ├── outpoint.webp │ ├── panda.gif │ ├── react-scaffold-btc.png │ ├── react-scaffold.png │ ├── reddit.png │ ├── scriptContext.jpg │ ├── scrypt-cli-compile.png │ ├── scrypt.png │ ├── sighashpreimage.png │ ├── sighashtypes.png │ ├── signing.png │ ├── signingTx.png │ ├── slack.png │ ├── state-btc.png │ ├── state.jpg │ ├── swap1.png │ ├── swap2.png │ ├── telegram.png │ ├── twitter.png │ ├── txn-mempool-conflict.png │ ├── undraw_docusaurus_mountain.svg │ ├── undraw_docusaurus_react.svg │ ├── undraw_docusaurus_tree.svg │ ├── utxo.jpg │ ├── verify-diagram.webp │ ├── verify-scripthash.png │ ├── verify-submit-filled.png │ ├── verify-submit.png │ ├── verify-tx-out.png │ ├── verify-verified-code.png │ ├── voting-homepage.png │ ├── voting-scripts.png │ ├── voting.gif │ ├── vue-cli-1.png │ ├── vue-cli-2.png │ ├── watch.gif │ ├── wechat-qrcode.jpg │ ├── wechat.png │ ├── yt.png │ └── zksnark-verifier.png ├── scripts │ ├── setup-circom.sh │ ├── setup-scryptc.sh │ └── setup-zokrates.sh └── setup └── yarn.lock /.gitignore: -------------------------------------------------------------------------------- 1 | # Dependencies 2 | /node_modules 3 | 4 | # Production 5 | /build 6 | 7 | # Generated files 8 | .docusaurus 9 | .cache-loader 10 | 11 | # Misc 12 | .DS_Store 13 | .env.local 14 | .env.development.local 15 | .env.test.local 16 | .env.production.local 17 | 18 | npm-debug.log* 19 | yarn-debug.log* 20 | yarn-error.log* 21 | -------------------------------------------------------------------------------- /babel.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | presets: [require.resolve('@docusaurus/core/lib/babel/preset')], 3 | }; 4 | -------------------------------------------------------------------------------- /btc-docs/advanced/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "position": 16, 3 | "label": "Advanced", 4 | "collapsible": true, 5 | "collapsed": true 6 | } -------------------------------------------------------------------------------- /btc-docs/bitcoin-basics/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "position": 3, 3 | "label": "Bitcoin Basics", 4 | "collapsible": true, 5 | "collapsed": true 6 | } -------------------------------------------------------------------------------- /btc-docs/bitcoin-basics/bitcoin-basics.md: -------------------------------------------------------------------------------- 1 | --- 2 | sidebar_position: 1 3 | --- 4 | # Bitcoin Basics 5 | 6 | If you are new to Bitcoin development, we recommend exploring the resources listed in this section. While not a required prerequisite, going over these guides will help you develop a better understanding of key concepts and make it easier to begin developing sCrypt smart contracts. 7 | 8 | If you are already familiar with Bitcoin, feel free to skip ahead to the [Basics](../how-to-write-a-contract/basics.md) section. 9 | 10 | ## Resources 11 | 12 | If you want to learn more about the fundamentals of Bitcoin, consider exploring these helpful resources: 13 | 14 | 15 | - [Learn me a Bitcoin](https://learnmeabitcoin.com/) 16 | - [sCrypt Academy](https://academy.scrypt.io/) 17 | - [BTC Wiki](https://en.bitcoin.it/wiki/Main_Page) 18 | -------------------------------------------------------------------------------- /btc-docs/how-to-deploy-and-call-a-contract/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "position": 4, 3 | "label": "How to Deploy & Call a Contract", 4 | "collapsible": true, 5 | "collapsed": true 6 | } -------------------------------------------------------------------------------- /btc-docs/how-to-write-a-contract/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "position": 3, 3 | "label": "How to Write a Contract", 4 | "collapsible": true, 5 | "collapsed": true 6 | } -------------------------------------------------------------------------------- /btc-docs/references/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "position": 20, 3 | "label": "References", 4 | "collapsible": true, 5 | "collapsed": true 6 | } -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "position": 1, 3 | "label": "bitcoinjs-lib", 4 | "collapsible": true, 5 | "collapsed": true 6 | } -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/functions/bn2Buf.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / bn2Buf 6 | 7 | # Function: bn2Buf() 8 | 9 | > **bn2Buf**(`bn`): `Uint8Array` 10 | 11 | Defined in: [ts\_src/bn.ts:48](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/bn.ts#L48) 12 | 13 | ## Parameters 14 | 15 | ### bn 16 | 17 | `bigint` 18 | 19 | ## Returns 20 | 21 | `Uint8Array` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/functions/buf2BN.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / buf2BN 6 | 7 | # Function: buf2BN() 8 | 9 | > **buf2BN**(`buf`, `fRequireMinimal`, `size`?): `bigint` 10 | 11 | Defined in: [ts\_src/bn.ts:52](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/bn.ts#L52) 12 | 13 | ## Parameters 14 | 15 | ### buf 16 | 17 | `Uint8Array` 18 | 19 | ### fRequireMinimal 20 | 21 | `boolean` 22 | 23 | ### size? 24 | 25 | `number` 26 | 27 | ## Returns 28 | 29 | `bigint` 30 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/functions/cloneBuffer.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / cloneBuffer 6 | 7 | # Function: cloneBuffer() 8 | 9 | > **cloneBuffer**(`buffer`): `Uint8Array` 10 | 11 | Defined in: [ts\_src/bufferutils.ts:39](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/bufferutils.ts#L39) 12 | 13 | ## Parameters 14 | 15 | ### buffer 16 | 17 | `Uint8Array` 18 | 19 | ## Returns 20 | 21 | `Uint8Array` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/functions/getEccLib.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / getEccLib 6 | 7 | # Function: getEccLib() 8 | 9 | > **getEccLib**(): [`TinySecp256k1Interface`](../namespaces/types/interfaces/TinySecp256k1Interface.md) 10 | 11 | Defined in: [ts\_src/ecc\_lib.ts:31](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/ecc_lib.ts#L31) 12 | 13 | Retrieves the ECC Library instance. 14 | Throws an error if the ECC Library is not provided. 15 | You must call initEccLib() with a valid TinySecp256k1Interface instance before calling this function. 16 | 17 | ## Returns 18 | 19 | [`TinySecp256k1Interface`](../namespaces/types/interfaces/TinySecp256k1Interface.md) 20 | 21 | The ECC Library instance. 22 | 23 | ## Throws 24 | 25 | Error if the ECC Library is not provided. 26 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/functions/initEccLib.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / initEccLib 6 | 7 | # Function: initEccLib() 8 | 9 | > **initEccLib**(`eccLib`): `void` 10 | 11 | Defined in: [ts\_src/ecc\_lib.ts:13](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/ecc_lib.ts#L13) 12 | 13 | Initializes the ECC library with the provided instance. 14 | If `eccLib` is `undefined`, the library will be cleared. 15 | If `eccLib` is a new instance, it will be verified before setting it as the active library. 16 | 17 | ## Parameters 18 | 19 | ### eccLib 20 | 21 | The instance of the ECC library to initialize. 22 | 23 | `undefined` | [`TinySecp256k1Interface`](../namespaces/types/interfaces/TinySecp256k1Interface.md) 24 | 25 | ## Returns 26 | 27 | `void` 28 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/functions/isFinal.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / isFinal 6 | 7 | # Function: isFinal() 8 | 9 | > **isFinal**(`sequenceNumber`): `boolean` 10 | 11 | Defined in: [ts\_src/transaction.ts:16](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/transaction.ts#L16) 12 | 13 | ## Parameters 14 | 15 | ### sequenceNumber 16 | 17 | `number` 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/functions/isFinalized.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / isFinalized 6 | 7 | # Function: isFinalized() 8 | 9 | > **isFinalized**(`input`): `boolean` 10 | 11 | Defined in: [ts\_src/psbt.ts:1348](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt.ts#L1348) 12 | 13 | ## Parameters 14 | 15 | ### input 16 | 17 | `PsbtInput` 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/functions/isNullInput.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / isNullInput 6 | 7 | # Function: isNullInput() 8 | 9 | > **isNullInput**(`input`): `boolean` 10 | 11 | Defined in: [ts\_src/transaction.ts:20](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/transaction.ts#L20) 12 | 13 | ## Parameters 14 | 15 | ### input 16 | 17 | [`TxInput`](../interfaces/TxInput.md) 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/functions/isOpSuccess.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / isOpSuccess 6 | 7 | # Function: isOpSuccess() 8 | 9 | > **isOpSuccess**(`opcode`): `boolean` 10 | 11 | Defined in: [ts\_src/ops.ts:149](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/ops.ts#L149) 12 | 13 | Returns true if given opcode is classified as a "success". 14 | This was taken from commit https://github.com/bitcoin/bitcoin/commit/72422ce396b8eba7b1a72c171c2f07dae691d1b5 15 | 16 | ## Parameters 17 | 18 | ### opcode 19 | 20 | `number` 21 | 22 | ## Returns 23 | 24 | `boolean` 25 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/functions/readOutput.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / readOutput 6 | 7 | # Function: readOutput() 8 | 9 | > **readOutput**(`buffer`): `object` 10 | 11 | Defined in: [ts\_src/transaction.ts:59](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/transaction.ts#L59) 12 | 13 | ## Parameters 14 | 15 | ### buffer 16 | 17 | `Uint8Array` 18 | 19 | ## Returns 20 | 21 | `object` 22 | 23 | ### script 24 | 25 | > **script**: `Uint8Array` 26 | 27 | ### value 28 | 29 | > **value**: `bigint` 30 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/functions/reverseBuffer.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / reverseBuffer 6 | 7 | # Function: reverseBuffer() 8 | 9 | > **reverseBuffer**(`buffer`): `Uint8Array` 10 | 11 | Defined in: [ts\_src/bufferutils.ts:26](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/bufferutils.ts#L26) 12 | 13 | Reverses the order of bytes in a buffer. 14 | 15 | ## Parameters 16 | 17 | ### buffer 18 | 19 | `Uint8Array` 20 | 21 | The buffer to reverse. 22 | 23 | ## Returns 24 | 25 | `Uint8Array` 26 | 27 | A new buffer with the bytes reversed. 28 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/functions/tapTreeToList.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / tapTreeToList 6 | 7 | # Function: tapTreeToList() 8 | 9 | > **tapTreeToList**(`tree`): `TapLeaf`[] 10 | 11 | Defined in: [ts\_src/psbt/bip371.ts:227](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/bip371.ts#L227) 12 | 13 | Convert a binary tree to a BIP371 type list. Each element of the list is (according to BIP371): 14 | One or more tuples representing the depth, leaf version, and script for a leaf in the Taproot tree, 15 | allowing the entire tree to be reconstructed. The tuples must be in depth first search order so that 16 | the tree is correctly reconstructed. 17 | 18 | ## Parameters 19 | 20 | ### tree 21 | 22 | [`Taptree`](../type-aliases/Taptree.md) 23 | 24 | the binary tap tree 25 | 26 | ## Returns 27 | 28 | `TapLeaf`[] 29 | 30 | a list of BIP 371 tapleaves 31 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/functions/toXOnly.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / toXOnly 6 | 7 | # Function: toXOnly() 8 | 9 | > **toXOnly**(`pubKey`): `Uint8Array` 10 | 11 | Defined in: [ts\_src/psbt/bip371.ts:35](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/bip371.ts#L35) 12 | 13 | Converts a public key to an X-only public key. 14 | 15 | ## Parameters 16 | 17 | ### pubKey 18 | 19 | `Uint8Array` 20 | 21 | The public key to convert. 22 | 23 | ## Returns 24 | 25 | `Uint8Array` 26 | 27 | The X-only public key. 28 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/functions/varSliceSize.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / varSliceSize 6 | 7 | # Function: varSliceSize() 8 | 9 | > **varSliceSize**(`someScript`): `number` 10 | 11 | Defined in: [ts\_src/transaction.ts:24](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/transaction.ts#L24) 12 | 13 | ## Parameters 14 | 15 | ### someScript 16 | 17 | `Uint8Array` 18 | 19 | ## Returns 20 | 21 | `number` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/functions/vectorSize.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / vectorSize 6 | 7 | # Function: vectorSize() 8 | 9 | > **vectorSize**(`someVector`): `number` 10 | 11 | Defined in: [ts\_src/transaction.ts:30](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/transaction.ts#L30) 12 | 13 | ## Parameters 14 | 15 | ### someVector 16 | 17 | `Uint8Array`[] 18 | 19 | ## Returns 20 | 21 | `number` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/interfaces/PsbtOptsOptional.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / PsbtOptsOptional 6 | 7 | # Interface: PsbtOptsOptional 8 | 9 | Defined in: [ts\_src/psbt.ts:1157](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt.ts#L1157) 10 | 11 | ## Properties 12 | 13 | ### maximumFeeRate? 14 | 15 | > `optional` **maximumFeeRate**: `number` 16 | 17 | Defined in: [ts\_src/psbt.ts:1159](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt.ts#L1159) 18 | 19 | *** 20 | 21 | ### network? 22 | 23 | > `optional` **network**: [`Network`](../namespaces/networks/interfaces/Network.md) 24 | 25 | Defined in: [ts\_src/psbt.ts:1158](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt.ts#L1158) 26 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/interfaces/TxOutput.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / TxOutput 6 | 7 | # Interface: TxOutput 8 | 9 | Defined in: [ts\_src/transaction.ts:67](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/transaction.ts#L67) 10 | 11 | ## Properties 12 | 13 | ### script 14 | 15 | > **script**: `Uint8Array` 16 | 17 | Defined in: [ts\_src/transaction.ts:68](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/transaction.ts#L68) 18 | 19 | *** 20 | 21 | ### value 22 | 23 | > **value**: `bigint` 24 | 25 | Defined in: [ts\_src/transaction.ts:69](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/transaction.ts#L69) 26 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/address/README.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../README.md) / address 6 | 7 | # address 8 | 9 | bitcoin address decode and encode tools, include base58、bech32 and output script 10 | 11 | networks support bitcoin、bitcoin testnet and bitcoin regtest 12 | 13 | addresses support P2PKH、P2SH、P2WPKH、P2WSH、P2TR and so on 14 | 15 | ## Interfaces 16 | 17 | - [Base58CheckResult](interfaces/Base58CheckResult.md) 18 | - [Bech32Result](interfaces/Bech32Result.md) 19 | 20 | ## Functions 21 | 22 | - [fromBase58Check](functions/fromBase58Check.md) 23 | - [fromBech32](functions/fromBech32.md) 24 | - [fromOutputScript](functions/fromOutputScript.md) 25 | - [toBase58Check](functions/toBase58Check.md) 26 | - [toBech32](functions/toBech32.md) 27 | - [toOutputScript](functions/toOutputScript.md) 28 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/address/functions/fromBase58Check.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [address](../README.md) / fromBase58Check 6 | 7 | # Function: fromBase58Check() 8 | 9 | > **fromBase58Check**(`address`): [`Base58CheckResult`](../interfaces/Base58CheckResult.md) 10 | 11 | Defined in: [ts\_src/address.ts:88](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/address.ts#L88) 12 | 13 | Decodes a base58check encoded Bitcoin address and returns the version and hash. 14 | 15 | ## Parameters 16 | 17 | ### address 18 | 19 | `string` 20 | 21 | The base58check encoded Bitcoin address to decode. 22 | 23 | ## Returns 24 | 25 | [`Base58CheckResult`](../interfaces/Base58CheckResult.md) 26 | 27 | An object containing the version and hash of the decoded address. 28 | 29 | ## Throws 30 | 31 | If the address is too short or too long. 32 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/address/functions/fromBech32.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [address](../README.md) / fromBech32 6 | 7 | # Function: fromBech32() 8 | 9 | > **fromBech32**(`address`): [`Bech32Result`](../interfaces/Bech32Result.md) 10 | 11 | Defined in: [ts\_src/address.ts:107](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/address.ts#L107) 12 | 13 | Converts a Bech32 or Bech32m encoded address to its corresponding data representation. 14 | 15 | ## Parameters 16 | 17 | ### address 18 | 19 | `string` 20 | 21 | The Bech32 or Bech32m encoded address. 22 | 23 | ## Returns 24 | 25 | [`Bech32Result`](../interfaces/Bech32Result.md) 26 | 27 | An object containing the version, prefix, and data of the address. 28 | 29 | ## Throws 30 | 31 | If the address uses the wrong encoding. 32 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/address/functions/fromOutputScript.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [address](../README.md) / fromOutputScript 6 | 7 | # Function: fromOutputScript() 8 | 9 | > **fromOutputScript**(`output`, `network`?): `string` 10 | 11 | Defined in: [ts\_src/address.ts:175](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/address.ts#L175) 12 | 13 | Converts an output script to a Bitcoin address. 14 | 15 | ## Parameters 16 | 17 | ### output 18 | 19 | `Uint8Array` 20 | 21 | The output script as a Buffer. 22 | 23 | ### network? 24 | 25 | [`Network`](../../networks/interfaces/Network.md) 26 | 27 | The Bitcoin network (optional). 28 | 29 | ## Returns 30 | 31 | `string` 32 | 33 | The Bitcoin address corresponding to the output script. 34 | 35 | ## Throws 36 | 37 | If the output script has no matching address. 38 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/address/functions/toBase58Check.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [address](../README.md) / toBase58Check 6 | 7 | # Function: toBase58Check() 8 | 9 | > **toBase58Check**(`hash`, `version`): `string` 10 | 11 | Defined in: [ts\_src/address.ts:138](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/address.ts#L138) 12 | 13 | Converts a hash to a Base58Check-encoded string. 14 | 15 | ## Parameters 16 | 17 | ### hash 18 | 19 | `Uint8Array` 20 | 21 | The hash to be encoded. 22 | 23 | ### version 24 | 25 | `number` 26 | 27 | The version byte to be prepended to the encoded string. 28 | 29 | ## Returns 30 | 31 | `string` 32 | 33 | The Base58Check-encoded string. 34 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/address/functions/toBech32.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [address](../README.md) / toBech32 6 | 7 | # Function: toBech32() 8 | 9 | > **toBech32**(`data`, `version`, `prefix`): `string` 10 | 11 | Defined in: [ts\_src/address.ts:155](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/address.ts#L155) 12 | 13 | Converts a buffer to a Bech32 or Bech32m encoded string. 14 | 15 | ## Parameters 16 | 17 | ### data 18 | 19 | `Uint8Array` 20 | 21 | The buffer to be encoded. 22 | 23 | ### version 24 | 25 | `number` 26 | 27 | The version number to be used in the encoding. 28 | 29 | ### prefix 30 | 31 | `string` 32 | 33 | The prefix string to be used in the encoding. 34 | 35 | ## Returns 36 | 37 | `string` 38 | 39 | The Bech32 or Bech32m encoded string. 40 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/address/functions/toOutputScript.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [address](../README.md) / toOutputScript 6 | 7 | # Function: toOutputScript() 8 | 9 | > **toOutputScript**(`address`, `network`?): `Uint8Array` 10 | 11 | Defined in: [ts\_src/address.ts:211](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/address.ts#L211) 12 | 13 | Converts a Bitcoin address to its corresponding output script. 14 | 15 | ## Parameters 16 | 17 | ### address 18 | 19 | `string` 20 | 21 | The Bitcoin address to convert. 22 | 23 | ### network? 24 | 25 | [`Network`](../../networks/interfaces/Network.md) 26 | 27 | The Bitcoin network to use. Defaults to the Bitcoin network. 28 | 29 | ## Returns 30 | 31 | `Uint8Array` 32 | 33 | The corresponding output script as a Buffer. 34 | 35 | ## Throws 36 | 37 | If the address has an invalid prefix or no matching script. 38 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/address/interfaces/Base58CheckResult.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [address](../README.md) / Base58CheckResult 6 | 7 | # Interface: Base58CheckResult 8 | 9 | Defined in: [ts\_src/address.ts:21](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/address.ts#L21) 10 | 11 | base58check decode result 12 | 13 | ## Properties 14 | 15 | ### hash 16 | 17 | > **hash**: `Uint8Array` 18 | 19 | Defined in: [ts\_src/address.ts:23](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/address.ts#L23) 20 | 21 | address hash 22 | 23 | *** 24 | 25 | ### version 26 | 27 | > **version**: `number` 28 | 29 | Defined in: [ts\_src/address.ts:25](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/address.ts#L25) 30 | 31 | address version: 0x00 for P2PKH, 0x05 for P2SH 32 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/bip371/functions/checkTaprootInputFields.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [bip371](../README.md) / checkTaprootInputFields 6 | 7 | # Function: checkTaprootInputFields() 8 | 9 | > **checkTaprootInputFields**(`inputData`, `newInputData`, `action`): `void` 10 | 11 | Defined in: [ts\_src/psbt/bip371.ts:132](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/bip371.ts#L132) 12 | 13 | Checks the taproot input fields for consistency. 14 | 15 | ## Parameters 16 | 17 | ### inputData 18 | 19 | `PsbtInput` 20 | 21 | The original input data. 22 | 23 | ### newInputData 24 | 25 | `PsbtInput` 26 | 27 | The new input data. 28 | 29 | ### action 30 | 31 | `string` 32 | 33 | The action being performed. 34 | 35 | ## Returns 36 | 37 | `void` 38 | 39 | ## Throws 40 | 41 | Throws an error if the input fields are inconsistent. 42 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/bip371/functions/checkTaprootInputForSigs.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [bip371](../README.md) / checkTaprootInputForSigs 6 | 7 | # Function: checkTaprootInputForSigs() 8 | 9 | > **checkTaprootInputForSigs**(`input`, `action`): `boolean` 10 | 11 | Defined in: [ts\_src/psbt/bip371.ts:259](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/bip371.ts#L259) 12 | 13 | Checks the taproot input for signatures. 14 | 15 | ## Parameters 16 | 17 | ### input 18 | 19 | `PsbtInput` 20 | 21 | The PSBT input to check. 22 | 23 | ### action 24 | 25 | `string` 26 | 27 | The action being performed. 28 | 29 | ## Returns 30 | 31 | `boolean` 32 | 33 | True if the input has taproot signatures, false otherwise. 34 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/bip371/functions/checkTaprootOutputFields.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [bip371](../README.md) / checkTaprootOutputFields 6 | 7 | # Function: checkTaprootOutputFields() 8 | 9 | > **checkTaprootOutputFields**(`outputData`, `newOutputData`, `action`): `void` 10 | 11 | Defined in: [ts\_src/psbt/bip371.ts:148](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/bip371.ts#L148) 12 | 13 | Checks the taproot output fields for consistency. 14 | 15 | ## Parameters 16 | 17 | ### outputData 18 | 19 | `PsbtOutput` 20 | 21 | The original output data. 22 | 23 | ### newOutputData 24 | 25 | `PsbtOutput` 26 | 27 | The new output data. 28 | 29 | ### action 30 | 31 | `string` 32 | 33 | The action being performed. 34 | 35 | ## Returns 36 | 37 | `void` 38 | 39 | ## Throws 40 | 41 | Throws an error if the output fields are inconsistent. 42 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/bip371/functions/decodeSchnorrSignature.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [bip371](../README.md) / decodeSchnorrSignature 6 | 7 | # Function: decodeSchnorrSignature() 8 | 9 | > **decodeSchnorrSignature**(`signature`): `object` 10 | 11 | Defined in: [ts\_src/psbt/bip371.ts:274](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/bip371.ts#L274) 12 | 13 | Decodes a Schnorr signature. 14 | 15 | ## Parameters 16 | 17 | ### signature 18 | 19 | `Uint8Array` 20 | 21 | The signature to decode. 22 | 23 | ## Returns 24 | 25 | `object` 26 | 27 | The decoded Schnorr signature. 28 | 29 | ### hashType 30 | 31 | > **hashType**: `number` 32 | 33 | ### signature 34 | 35 | > **signature**: `Uint8Array` 36 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/bip371/functions/isTaprootInput.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [bip371](../README.md) / isTaprootInput 6 | 7 | # Function: isTaprootInput() 8 | 9 | > **isTaprootInput**(`input`): `boolean` 10 | 11 | Defined in: [ts\_src/psbt/bip371.ts:91](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/bip371.ts#L91) 12 | 13 | Checks if a PSBT input is a taproot input. 14 | 15 | ## Parameters 16 | 17 | ### input 18 | 19 | `PsbtInput` 20 | 21 | The PSBT input to check. 22 | 23 | ## Returns 24 | 25 | `boolean` 26 | 27 | True if the input is a taproot input, false otherwise. 28 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/bip371/functions/isTaprootOutput.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [bip371](../README.md) / isTaprootOutput 6 | 7 | # Function: isTaprootOutput() 8 | 9 | > **isTaprootOutput**(`output`, `script`?): `boolean` 10 | 11 | Defined in: [ts\_src/psbt/bip371.ts:110](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/bip371.ts#L110) 12 | 13 | Checks if a PSBT output is a taproot output. 14 | 15 | ## Parameters 16 | 17 | ### output 18 | 19 | `PsbtOutput` 20 | 21 | The PSBT output to check. 22 | 23 | ### script? 24 | 25 | `Uint8Array` 26 | 27 | The script to check. Optional. 28 | 29 | ## Returns 30 | 31 | `boolean` 32 | 33 | True if the output is a taproot output, false otherwise. 34 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/bip371/functions/serializeTaprootSignature.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [bip371](../README.md) / serializeTaprootSignature 6 | 7 | # Function: serializeTaprootSignature() 8 | 9 | > **serializeTaprootSignature**(`sig`, `sighashType`?): `Uint8Array` 10 | 11 | Defined in: [ts\_src/psbt/bip371.ts:75](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/bip371.ts#L75) 12 | 13 | Serializes a taproot signature. 14 | 15 | ## Parameters 16 | 17 | ### sig 18 | 19 | `Uint8Array` 20 | 21 | The signature to serialize. 22 | 23 | ### sighashType? 24 | 25 | `number` 26 | 27 | The sighash type. Optional. 28 | 29 | ## Returns 30 | 31 | `Uint8Array` 32 | 33 | The serialized taproot signature. 34 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/bip371/functions/tweakInternalPubKey.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [bip371](../README.md) / tweakInternalPubKey 6 | 7 | # Function: tweakInternalPubKey() 8 | 9 | > **tweakInternalPubKey**(`inputIndex`, `input`): `Uint8Array` 10 | 11 | Defined in: [ts\_src/psbt/bip371.ts:201](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/bip371.ts#L201) 12 | 13 | Tweak the internal public key for a specific input. 14 | 15 | ## Parameters 16 | 17 | ### inputIndex 18 | 19 | `number` 20 | 21 | The index of the input. 22 | 23 | ### input 24 | 25 | `PsbtInput` 26 | 27 | The PsbtInput object representing the input. 28 | 29 | ## Returns 30 | 31 | `Uint8Array` 32 | 33 | The tweaked internal public key. 34 | 35 | ## Throws 36 | 37 | Error if the tap internal key cannot be tweaked. 38 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/bn/README.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../README.md) / bn 6 | 7 | # bn 8 | 9 | ## References 10 | 11 | ### bn2Buf 12 | 13 | Re-exports [bn2Buf](../../functions/bn2Buf.md) 14 | 15 | *** 16 | 17 | ### buf2BN 18 | 19 | Re-exports [buf2BN](../../functions/buf2BN.md) 20 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/bufferutils/README.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../README.md) / bufferutils 6 | 7 | # bufferutils 8 | 9 | ## Namespaces 10 | 11 | - [varuint](namespaces/varuint/README.md) 12 | 13 | ## References 14 | 15 | ### BufferReader 16 | 17 | Re-exports [BufferReader](../../classes/BufferReader.md) 18 | 19 | *** 20 | 21 | ### BufferWriter 22 | 23 | Re-exports [BufferWriter](../../classes/BufferWriter.md) 24 | 25 | *** 26 | 27 | ### cloneBuffer 28 | 29 | Re-exports [cloneBuffer](../../functions/cloneBuffer.md) 30 | 31 | *** 32 | 33 | ### reverseBuffer 34 | 35 | Re-exports [reverseBuffer](../../functions/reverseBuffer.md) 36 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/bufferutils/namespaces/varuint/README.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../../README.md) / [bufferutils](../../README.md) / varuint 6 | 7 | # varuint 8 | 9 | ## Functions 10 | 11 | - [decode](functions/decode.md) 12 | - [encode](functions/encode.md) 13 | - [encodingLength](functions/encodingLength.md) 14 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/bufferutils/namespaces/varuint/functions/decode.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../../../README.md) / [bufferutils](../../../README.md) / [varuint](../README.md) / decode 6 | 7 | # Function: decode() 8 | 9 | > **decode**(`buffer`, `offset`?): `object` 10 | 11 | Defined in: node\_modules/varuint-bitcoin/src/cjs/index.d.ts:5 12 | 13 | ## Parameters 14 | 15 | ### buffer 16 | 17 | `Uint8Array` 18 | 19 | ### offset? 20 | 21 | `number` 22 | 23 | ## Returns 24 | 25 | `object` 26 | 27 | ### bigintValue 28 | 29 | > **bigintValue**: `bigint` 30 | 31 | ### bytes 32 | 33 | > **bytes**: `number` 34 | 35 | ### numberValue 36 | 37 | > **numberValue**: `null` \| `number` 38 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/bufferutils/namespaces/varuint/functions/encode.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../../../README.md) / [bufferutils](../../../README.md) / [varuint](../README.md) / encode 6 | 7 | # Function: encode() 8 | 9 | > **encode**(`n`, `buffer`?, `offset`?): `object` 10 | 11 | Defined in: node\_modules/varuint-bitcoin/src/cjs/index.d.ts:1 12 | 13 | ## Parameters 14 | 15 | ### n 16 | 17 | `number` | `bigint` 18 | 19 | ### buffer? 20 | 21 | `Uint8Array` 22 | 23 | ### offset? 24 | 25 | `number` 26 | 27 | ## Returns 28 | 29 | `object` 30 | 31 | ### buffer 32 | 33 | > **buffer**: `Uint8Array` 34 | 35 | ### bytes 36 | 37 | > **bytes**: `number` 38 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/bufferutils/namespaces/varuint/functions/encodingLength.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../../../README.md) / [bufferutils](../../../README.md) / [varuint](../README.md) / encodingLength 6 | 7 | # Function: encodingLength() 8 | 9 | > **encodingLength**(`n`): `number` 10 | 11 | Defined in: node\_modules/varuint-bitcoin/src/cjs/index.d.ts:10 12 | 13 | ## Parameters 14 | 15 | ### n 16 | 17 | `number` | `bigint` 18 | 19 | ## Returns 20 | 21 | `number` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/crypto/README.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../README.md) / crypto 6 | 7 | # crypto 8 | 9 | A module for hashing functions. 10 | include ripemd160、sha1、sha256、hash160、hash256、taggedHash 11 | 12 | ## Type Aliases 13 | 14 | - [TaggedHashPrefix](type-aliases/TaggedHashPrefix.md) 15 | 16 | ## Variables 17 | 18 | - [TAGGED\_HASH\_PREFIXES](variables/TAGGED_HASH_PREFIXES.md) 19 | - [TAGS](variables/TAGS.md) 20 | 21 | ## Functions 22 | 23 | - [hash160](functions/hash160.md) 24 | - [hash256](functions/hash256.md) 25 | - [taggedHash](functions/taggedHash.md) 26 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/crypto/functions/hash160.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [crypto](../README.md) / hash160 6 | 7 | # Function: hash160() 8 | 9 | > **hash160**(`buffer`): `Uint8Array` 10 | 11 | Defined in: [ts\_src/crypto.ts:11](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/crypto.ts#L11) 12 | 13 | ## Parameters 14 | 15 | ### buffer 16 | 17 | `Uint8Array` 18 | 19 | ## Returns 20 | 21 | `Uint8Array` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/crypto/functions/hash256.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [crypto](../README.md) / hash256 6 | 7 | # Function: hash256() 8 | 9 | > **hash256**(`buffer`): `Uint8Array` 10 | 11 | Defined in: [ts\_src/crypto.ts:15](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/crypto.ts#L15) 12 | 13 | ## Parameters 14 | 15 | ### buffer 16 | 17 | `Uint8Array` 18 | 19 | ## Returns 20 | 21 | `Uint8Array` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/crypto/functions/taggedHash.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [crypto](../README.md) / taggedHash 6 | 7 | # Function: taggedHash() 8 | 9 | > **taggedHash**(`prefix`, `data`): `Uint8Array` 10 | 11 | Defined in: [ts\_src/crypto.ts:95](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/crypto.ts#L95) 12 | 13 | ## Parameters 14 | 15 | ### prefix 16 | 17 | `"BIP0340/challenge"` | `"BIP0340/aux"` | `"BIP0340/nonce"` | `"TapLeaf"` | `"TapBranch"` | `"TapSighash"` | `"TapTweak"` | `"KeyAgg list"` | `"KeyAgg coefficient"` 18 | 19 | ### data 20 | 21 | `Uint8Array` 22 | 23 | ## Returns 24 | 25 | `Uint8Array` 26 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/crypto/type-aliases/TaggedHashPrefix.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [crypto](../README.md) / TaggedHashPrefix 6 | 7 | # Type Alias: TaggedHashPrefix 8 | 9 | > **TaggedHashPrefix**: *typeof* [`TAGS`](../variables/TAGS.md)\[`number`\] 10 | 11 | Defined in: [ts\_src/crypto.ts:30](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/crypto.ts#L30) 12 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/crypto/variables/TAGGED_HASH_PREFIXES.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [crypto](../README.md) / TAGGED\_HASH\_PREFIXES 6 | 7 | # Variable: TAGGED\_HASH\_PREFIXES 8 | 9 | > `const` **TAGGED\_HASH\_PREFIXES**: `TaggedHashPrefixes` 10 | 11 | Defined in: [ts\_src/crypto.ts:38](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/crypto.ts#L38) 12 | 13 | Defines the tagged hash prefixes used in the crypto module. 14 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/crypto/variables/TAGS.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [crypto](../README.md) / TAGS 6 | 7 | # Variable: TAGS 8 | 9 | > `const` **TAGS**: readonly \[`"BIP0340/challenge"`, `"BIP0340/aux"`, `"BIP0340/nonce"`, `"TapLeaf"`, `"TapBranch"`, `"TapSighash"`, `"TapTweak"`, `"KeyAgg list"`, `"KeyAgg coefficient"`\] 10 | 11 | Defined in: [ts\_src/crypto.ts:19](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/crypto.ts#L19) 12 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/interpreter/README.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../README.md) / interpreter 6 | 7 | # interpreter 8 | 9 | ## Enumerations 10 | 11 | - [InterpreterErr](enumerations/InterpreterErr.md) 12 | 13 | ## References 14 | 15 | ### Interpreter 16 | 17 | Re-exports [Interpreter](../../classes/Interpreter.md) 18 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/networks/README.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../README.md) / networks 6 | 7 | # networks 8 | 9 | Represents a Bitcoin network configuration，including messagePrefix, bech32, bip32, pubKeyHash, scriptHash, wif. 10 | Support bitcoin、bitcoin testnet and bitcoin regtest. 11 | 12 | ## Interfaces 13 | 14 | - [Network](interfaces/Network.md) 15 | 16 | ## Variables 17 | 18 | - [bitcoin](variables/bitcoin.md) 19 | - [regtest](variables/regtest.md) 20 | - [testnet](variables/testnet.md) 21 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/networks/variables/bitcoin.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [networks](../README.md) / bitcoin 6 | 7 | # Variable: bitcoin 8 | 9 | > `const` **bitcoin**: [`Network`](../interfaces/Network.md) 10 | 11 | Defined in: [ts\_src/networks.ts:26](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/networks.ts#L26) 12 | 13 | Represents the Bitcoin network configuration. 14 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/networks/variables/regtest.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [networks](../README.md) / regtest 6 | 7 | # Variable: regtest 8 | 9 | > `const` **regtest**: [`Network`](../interfaces/Network.md) 10 | 11 | Defined in: [ts\_src/networks.ts:64](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/networks.ts#L64) 12 | 13 | Represents the regtest network configuration. 14 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/networks/variables/testnet.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [networks](../README.md) / testnet 6 | 7 | # Variable: testnet 8 | 9 | > `const` **testnet**: [`Network`](../interfaces/Network.md) 10 | 11 | Defined in: [ts\_src/networks.ts:78](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/networks.ts#L78) 12 | 13 | Represents the testnet network configuration. 14 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/functions/embed.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / embed 6 | 7 | # Function: embed() 8 | 9 | > **embed**(`a`, `opts`?): [`Payment`](../interfaces/Payment.md) 10 | 11 | Defined in: [ts\_src/payments/embed.ts:18](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/embed.ts#L18) 12 | 13 | Embeds data in a Bitcoin payment. 14 | 15 | ## Parameters 16 | 17 | ### a 18 | 19 | [`Payment`](../interfaces/Payment.md) 20 | 21 | The payment object. 22 | 23 | ### opts? 24 | 25 | [`PaymentOpts`](../interfaces/PaymentOpts.md) 26 | 27 | Optional payment options. 28 | 29 | ## Returns 30 | 31 | [`Payment`](../interfaces/Payment.md) 32 | 33 | The modified payment object. 34 | 35 | ## Throws 36 | 37 | If there is not enough data or if the output is invalid. 38 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/functions/findScriptPath.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / findScriptPath 6 | 7 | # Function: findScriptPath() 8 | 9 | > **findScriptPath**(`node`, `hash`): `undefined` \| `Uint8Array`[] 10 | 11 | Defined in: [ts\_src/payments/bip341.ts:94](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/bip341.ts#L94) 12 | 13 | Given a HashTree, finds the path from a particular hash to the root. 14 | 15 | ## Parameters 16 | 17 | ### node 18 | 19 | [`HashTree`](../type-aliases/HashTree.md) 20 | 21 | the root of the tree 22 | 23 | ### hash 24 | 25 | `Uint8Array` 26 | 27 | the hash to search for 28 | 29 | ## Returns 30 | 31 | `undefined` \| `Uint8Array`[] 32 | 33 | - array of sibling hashes, from leaf (inclusive) to root 34 | (exclusive) needed to prove inclusion of the specified hash. undefined if no 35 | path is found 36 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/functions/p2ms.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / p2ms 6 | 7 | # Function: p2ms() 8 | 9 | > **p2ms**(`a`, `opts`?): [`Payment`](../interfaces/Payment.md) 10 | 11 | Defined in: [ts\_src/payments/p2ms.ts:20](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/p2ms.ts#L20) 12 | 13 | Represents a function that creates a Pay-to-Multisig (P2MS) payment object. 14 | 15 | ## Parameters 16 | 17 | ### a 18 | 19 | [`Payment`](../interfaces/Payment.md) 20 | 21 | The payment object. 22 | 23 | ### opts? 24 | 25 | [`PaymentOpts`](../interfaces/PaymentOpts.md) 26 | 27 | Optional payment options. 28 | 29 | ## Returns 30 | 31 | [`Payment`](../interfaces/Payment.md) 32 | 33 | The created payment object. 34 | 35 | ## Throws 36 | 37 | If the provided data is not valid. 38 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/functions/p2pk.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / p2pk 6 | 7 | # Function: p2pk() 8 | 9 | > **p2pk**(`a`, `opts`?): [`Payment`](../interfaces/Payment.md) 10 | 11 | Defined in: [ts\_src/payments/p2pk.ts:20](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/p2pk.ts#L20) 12 | 13 | Creates a pay-to-public-key (P2PK) payment object. 14 | 15 | ## Parameters 16 | 17 | ### a 18 | 19 | [`Payment`](../interfaces/Payment.md) 20 | 21 | The payment object containing the necessary data. 22 | 23 | ### opts? 24 | 25 | [`PaymentOpts`](../interfaces/PaymentOpts.md) 26 | 27 | Optional payment options. 28 | 29 | ## Returns 30 | 31 | [`Payment`](../interfaces/Payment.md) 32 | 33 | The P2PK payment object. 34 | 35 | ## Throws 36 | 37 | If the required data is not provided or if the data is invalid. 38 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/functions/p2pkh.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / p2pkh 6 | 7 | # Function: p2pkh() 8 | 9 | > **p2pkh**(`a`, `opts`?): [`Payment`](../interfaces/Payment.md) 10 | 11 | Defined in: [ts\_src/payments/p2pkh.ts:28](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/p2pkh.ts#L28) 12 | 13 | Creates a Pay-to-Public-Key-Hash (P2PKH) payment object. 14 | 15 | ## Parameters 16 | 17 | ### a 18 | 19 | [`Payment`](../interfaces/Payment.md) 20 | 21 | The payment object containing the necessary data. 22 | 23 | ### opts? 24 | 25 | [`PaymentOpts`](../interfaces/PaymentOpts.md) 26 | 27 | Optional payment options. 28 | 29 | ## Returns 30 | 31 | [`Payment`](../interfaces/Payment.md) 32 | 33 | The P2PKH payment object. 34 | 35 | ## Throws 36 | 37 | If the required data is not provided or if the data is invalid. 38 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/functions/p2sh.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / p2sh 6 | 7 | # Function: p2sh() 8 | 9 | > **p2sh**(`a`, `opts`?): [`Payment`](../interfaces/Payment.md) 10 | 11 | Defined in: [ts\_src/payments/p2sh.ts:29](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/p2sh.ts#L29) 12 | 13 | Creates a Pay-to-Script-Hash (P2SH) payment object. 14 | 15 | ## Parameters 16 | 17 | ### a 18 | 19 | [`Payment`](../interfaces/Payment.md) 20 | 21 | The payment object containing the necessary data. 22 | 23 | ### opts? 24 | 25 | [`PaymentOpts`](../interfaces/PaymentOpts.md) 26 | 27 | Optional payment options. 28 | 29 | ## Returns 30 | 31 | [`Payment`](../interfaces/Payment.md) 32 | 33 | The P2SH payment object. 34 | 35 | ## Throws 36 | 37 | If the required data is not provided or if the data is invalid. 38 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/functions/p2tr.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / p2tr 6 | 7 | # Function: p2tr() 8 | 9 | > **p2tr**(`a`, `opts`?): [`Payment`](../interfaces/Payment.md) 10 | 11 | Defined in: [ts\_src/payments/p2tr.ts:38](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/p2tr.ts#L38) 12 | 13 | Creates a Pay-to-Taproot (P2TR) payment object. 14 | 15 | ## Parameters 16 | 17 | ### a 18 | 19 | [`Payment`](../interfaces/Payment.md) 20 | 21 | The payment object containing the necessary data for P2TR. 22 | 23 | ### opts? 24 | 25 | [`PaymentOpts`](../interfaces/PaymentOpts.md) 26 | 27 | Optional payment options. 28 | 29 | ## Returns 30 | 31 | [`Payment`](../interfaces/Payment.md) 32 | 33 | The P2TR payment object. 34 | 35 | ## Throws 36 | 37 | If the provided data is invalid or insufficient. 38 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/functions/p2wpkh.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / p2wpkh 6 | 7 | # Function: p2wpkh() 8 | 9 | > **p2wpkh**(`a`, `opts`?): [`Payment`](../interfaces/Payment.md) 10 | 11 | Defined in: [ts\_src/payments/p2wpkh.ts:26](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/p2wpkh.ts#L26) 12 | 13 | Creates a pay-to-witness-public-key-hash (p2wpkh) payment object. 14 | 15 | ## Parameters 16 | 17 | ### a 18 | 19 | [`Payment`](../interfaces/Payment.md) 20 | 21 | The payment object containing the necessary data. 22 | 23 | ### opts? 24 | 25 | [`PaymentOpts`](../interfaces/PaymentOpts.md) 26 | 27 | Optional payment options. 28 | 29 | ## Returns 30 | 31 | [`Payment`](../interfaces/Payment.md) 32 | 33 | The p2wpkh payment object. 34 | 35 | ## Throws 36 | 37 | If the required data is missing or invalid. 38 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/functions/p2wsh.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / p2wsh 6 | 7 | # Function: p2wsh() 8 | 9 | > **p2wsh**(`a`, `opts`?): [`Payment`](../interfaces/Payment.md) 10 | 11 | Defined in: [ts\_src/payments/p2wsh.ts:46](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/p2wsh.ts#L46) 12 | 13 | Creates a Pay-to-Witness-Script-Hash (P2WSH) payment object. 14 | 15 | ## Parameters 16 | 17 | ### a 18 | 19 | [`Payment`](../interfaces/Payment.md) 20 | 21 | The payment object containing the necessary data. 22 | 23 | ### opts? 24 | 25 | [`PaymentOpts`](../interfaces/PaymentOpts.md) 26 | 27 | Optional payment options. 28 | 29 | ## Returns 30 | 31 | [`Payment`](../interfaces/Payment.md) 32 | 33 | The P2WSH payment object. 34 | 35 | ## Throws 36 | 37 | If the required data is missing or invalid. 38 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/functions/rootHashFromPath.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / rootHashFromPath 6 | 7 | # Function: rootHashFromPath() 8 | 9 | > **rootHashFromPath**(`controlBlock`, `leafHash`): `Uint8Array` 10 | 11 | Defined in: [ts\_src/payments/bip341.ts:44](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/bip341.ts#L44) 12 | 13 | Calculates the root hash from a given control block and leaf hash. 14 | 15 | ## Parameters 16 | 17 | ### controlBlock 18 | 19 | `Uint8Array` 20 | 21 | The control block buffer. 22 | 23 | ### leafHash 24 | 25 | `Uint8Array` 26 | 27 | The leaf hash buffer. 28 | 29 | ## Returns 30 | 31 | `Uint8Array` 32 | 33 | The root hash buffer. 34 | 35 | ## Throws 36 | 37 | If the control block length is less than 33. 38 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/functions/tapTweakHash.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / tapTweakHash 6 | 7 | # Function: tapTweakHash() 8 | 9 | > **tapTweakHash**(`pubKey`, `h`): `Uint8Array` 10 | 11 | Defined in: [ts\_src/payments/bip341.ts:133](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/bip341.ts#L133) 12 | 13 | Computes the taproot tweak hash for a given public key and optional hash. 14 | If a hash is provided, the public key and hash are concatenated before computing the hash. 15 | If no hash is provided, only the public key is used to compute the hash. 16 | 17 | ## Parameters 18 | 19 | ### pubKey 20 | 21 | `Uint8Array` 22 | 23 | The public key buffer. 24 | 25 | ### h 26 | 27 | The optional hash buffer. 28 | 29 | `undefined` | `Uint8Array` 30 | 31 | ## Returns 32 | 33 | `Uint8Array` 34 | 35 | The taproot tweak hash. 36 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/functions/tapleafHash.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / tapleafHash 6 | 7 | # Function: tapleafHash() 8 | 9 | > **tapleafHash**(`leaf`): `Uint8Array` 10 | 11 | Defined in: [ts\_src/payments/bip341.ts:115](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/bip341.ts#L115) 12 | 13 | Calculates the tapleaf hash for a given Tapleaf object. 14 | 15 | ## Parameters 16 | 17 | ### leaf 18 | 19 | [`Tapleaf`](../../types/interfaces/Tapleaf.md) 20 | 21 | The Tapleaf object to calculate the hash for. 22 | 23 | ## Returns 24 | 25 | `Uint8Array` 26 | 27 | The tapleaf hash as a Buffer. 28 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/functions/toHashTree.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / toHashTree 6 | 7 | # Function: toHashTree() 8 | 9 | > **toHashTree**(`scriptTree`): [`HashTree`](../type-aliases/HashTree.md) 10 | 11 | Defined in: [ts\_src/payments/bip341.ts:71](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/bip341.ts#L71) 12 | 13 | Build a hash tree of merkle nodes from the scripts binary tree. 14 | 15 | ## Parameters 16 | 17 | ### scriptTree 18 | 19 | [`Taptree`](../../../type-aliases/Taptree.md) 20 | 21 | the tree of scripts to pairwise hash. 22 | 23 | ## Returns 24 | 25 | [`HashTree`](../type-aliases/HashTree.md) 26 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/functions/tweakKey.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / tweakKey 6 | 7 | # Function: tweakKey() 8 | 9 | > **tweakKey**(`pubKey`, `h`): `null` \| `TweakedPublicKey` 10 | 11 | Defined in: [ts\_src/payments/bip341.ts:149](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/bip341.ts#L149) 12 | 13 | Tweak a public key with a given tweak hash. 14 | 15 | ## Parameters 16 | 17 | ### pubKey 18 | 19 | `Uint8Array` 20 | 21 | The public key to be tweaked. 22 | 23 | ### h 24 | 25 | The tweak hash. 26 | 27 | `undefined` | `Uint8Array` 28 | 29 | ## Returns 30 | 31 | `null` \| `TweakedPublicKey` 32 | 33 | The tweaked public key or null if the input is invalid. 34 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/interfaces/PaymentOpts.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / PaymentOpts 6 | 7 | # Interface: PaymentOpts 8 | 9 | Defined in: [ts\_src/payments/index.ts:44](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/index.ts#L44) 10 | 11 | ## Properties 12 | 13 | ### allowIncomplete? 14 | 15 | > `optional` **allowIncomplete**: `boolean` 16 | 17 | Defined in: [ts\_src/payments/index.ts:46](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/index.ts#L46) 18 | 19 | *** 20 | 21 | ### validate? 22 | 23 | > `optional` **validate**: `boolean` 24 | 25 | Defined in: [ts\_src/payments/index.ts:45](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/index.ts#L45) 26 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/type-aliases/HashTree.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / HashTree 6 | 7 | # Type Alias: HashTree 8 | 9 | > **HashTree**: `HashLeaf` \| `HashBranch` 10 | 11 | Defined in: [ts\_src/payments/bip341.ts:35](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/bip341.ts#L35) 12 | 13 | Binary tree representing leaf, branch, and root node hashes of a Taptree. 14 | Each node contains a hash, and potentially left and right branch hashes. 15 | This tree is used for 2 purposes: Providing the root hash for tweaking, 16 | and calculating merkle inclusion proofs when constructing a control block. 17 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/type-aliases/PaymentCreator.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / PaymentCreator 6 | 7 | # Type Alias: PaymentCreator() 8 | 9 | > **PaymentCreator**: (`a`, `opts`?) => [`Payment`](../interfaces/Payment.md) 10 | 11 | Defined in: [ts\_src/payments/index.ts:40](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/index.ts#L40) 12 | 13 | ## Parameters 14 | 15 | ### a 16 | 17 | [`Payment`](../interfaces/Payment.md) 18 | 19 | ### opts? 20 | 21 | [`PaymentOpts`](../interfaces/PaymentOpts.md) 22 | 23 | ## Returns 24 | 25 | [`Payment`](../interfaces/Payment.md) 26 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/type-aliases/PaymentFunction.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / PaymentFunction 6 | 7 | # Type Alias: PaymentFunction() 8 | 9 | > **PaymentFunction**: () => [`Payment`](../interfaces/Payment.md) 10 | 11 | Defined in: [ts\_src/payments/index.ts:42](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/index.ts#L42) 12 | 13 | ## Returns 14 | 15 | [`Payment`](../interfaces/Payment.md) 16 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/type-aliases/Stack.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / Stack 6 | 7 | # Type Alias: Stack 8 | 9 | > **Stack**: [`StackElement`](StackElement.md)[] 10 | 11 | Defined in: [ts\_src/payments/index.ts:50](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/index.ts#L50) 12 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/type-aliases/StackElement.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / StackElement 6 | 7 | # Type Alias: StackElement 8 | 9 | > **StackElement**: `Uint8Array` \| `number` 10 | 11 | Defined in: [ts\_src/payments/index.ts:49](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/index.ts#L49) 12 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/type-aliases/StackFunction.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / StackFunction 6 | 7 | # Type Alias: StackFunction() 8 | 9 | > **StackFunction**: () => [`Stack`](Stack.md) 10 | 11 | Defined in: [ts\_src/payments/index.ts:51](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/index.ts#L51) 12 | 13 | ## Returns 14 | 15 | [`Stack`](Stack.md) 16 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/variables/LEAF_VERSION_TAPSCRIPT.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / LEAF\_VERSION\_TAPSCRIPT 6 | 7 | # Variable: LEAF\_VERSION\_TAPSCRIPT 8 | 9 | > `const` **LEAF\_VERSION\_TAPSCRIPT**: `192` = `0xc0` 10 | 11 | Defined in: [ts\_src/payments/bip341.ts:8](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/bip341.ts#L8) 12 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/payments/variables/MAX_TAPTREE_DEPTH.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [payments](../README.md) / MAX\_TAPTREE\_DEPTH 6 | 7 | # Variable: MAX\_TAPTREE\_DEPTH 8 | 9 | > `const` **MAX\_TAPTREE\_DEPTH**: `128` = `128` 10 | 11 | Defined in: [ts\_src/payments/bip341.ts:9](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/payments/bip341.ts#L9) 12 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/psbt/interfaces/PsbtOpts.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [psbt](../README.md) / PsbtOpts 6 | 7 | # Interface: PsbtOpts 8 | 9 | Defined in: [ts\_src/psbt.ts:1162](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt.ts#L1162) 10 | 11 | ## Properties 12 | 13 | ### maximumFeeRate 14 | 15 | > **maximumFeeRate**: `number` 16 | 17 | Defined in: [ts\_src/psbt.ts:1164](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt.ts#L1164) 18 | 19 | *** 20 | 21 | ### network 22 | 23 | > **network**: [`Network`](../../networks/interfaces/Network.md) 24 | 25 | Defined in: [ts\_src/psbt.ts:1163](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt.ts#L1163) 26 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/psbt/interfaces/TransactionOutput.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [psbt](../README.md) / TransactionOutput 6 | 7 | # Interface: TransactionOutput 8 | 9 | Defined in: [ts\_src/psbt.ts:61](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt.ts#L61) 10 | 11 | ## Extended by 12 | 13 | - [`PsbtTxOutput`](../../../interfaces/PsbtTxOutput.md) 14 | 15 | ## Properties 16 | 17 | ### script 18 | 19 | > **script**: `Uint8Array` 20 | 21 | Defined in: [ts\_src/psbt.ts:62](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt.ts#L62) 22 | 23 | *** 24 | 25 | ### value 26 | 27 | > **value**: `bigint` 28 | 29 | Defined in: [ts\_src/psbt.ts:63](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt.ts#L63) 30 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/psbt/type-aliases/PsbtOutputExtended.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [psbt](../README.md) / PsbtOutputExtended 6 | 7 | # Type Alias: PsbtOutputExtended 8 | 9 | > **PsbtOutputExtended**: [`PsbtOutputExtendedAddress`](../interfaces/PsbtOutputExtendedAddress.md) \| [`PsbtOutputExtendedScript`](../interfaces/PsbtOutputExtendedScript.md) 10 | 11 | Defined in: [ts\_src/psbt.ts:1169](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt.ts#L1169) 12 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/psbt/type-aliases/ValidateSigFunction.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [psbt](../README.md) / ValidateSigFunction 6 | 7 | # Type Alias: ValidateSigFunction() 8 | 9 | > **ValidateSigFunction**: (`pubkey`, `msghash`, `signature`) => `boolean` 10 | 11 | Defined in: [ts\_src/psbt.ts:71](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt.ts#L71) 12 | 13 | ## Parameters 14 | 15 | ### pubkey 16 | 17 | `Uint8Array` 18 | 19 | ### msghash 20 | 21 | `Uint8Array` 22 | 23 | ### signature 24 | 25 | `Uint8Array` 26 | 27 | ## Returns 28 | 29 | `boolean` 30 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/psbtutils/README.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../README.md) / psbtutils 6 | 7 | # psbtutils 8 | 9 | ## Functions 10 | 11 | - [checkInputForSig](functions/checkInputForSig.md) 12 | - [isP2MS](functions/isP2MS.md) 13 | - [isP2PK](functions/isP2PK.md) 14 | - [isP2PKH](functions/isP2PKH.md) 15 | - [isP2SHScript](functions/isP2SHScript.md) 16 | - [isP2TR](functions/isP2TR.md) 17 | - [isP2WPKH](functions/isP2WPKH.md) 18 | - [isP2WSHScript](functions/isP2WSHScript.md) 19 | - [pubkeyInScript](functions/pubkeyInScript.md) 20 | - [pubkeyPositionInScript](functions/pubkeyPositionInScript.md) 21 | - [signatureBlocksAction](functions/signatureBlocksAction.md) 22 | - [witnessStackToScriptWitness](functions/witnessStackToScriptWitness.md) 23 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/psbtutils/functions/checkInputForSig.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [psbtutils](../README.md) / checkInputForSig 6 | 7 | # Function: checkInputForSig() 8 | 9 | > **checkInputForSig**(`input`, `action`): `boolean` 10 | 11 | Defined in: [ts\_src/psbt/psbtutils.ts:114](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/psbtutils.ts#L114) 12 | 13 | Checks if an input contains a signature for a specific action. 14 | 15 | ## Parameters 16 | 17 | ### input 18 | 19 | `PsbtInput` 20 | 21 | The input to check. 22 | 23 | ### action 24 | 25 | `string` 26 | 27 | The action to check for. 28 | 29 | ## Returns 30 | 31 | `boolean` 32 | 33 | A boolean indicating whether the input contains a signature for the specified action. 34 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/psbtutils/functions/isP2MS.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [psbtutils](../README.md) / isP2MS 6 | 7 | # Function: isP2MS() 8 | 9 | > **isP2MS**(`script`): `boolean` 10 | 11 | Defined in: [ts\_src/psbt/psbtutils.ts:25](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/psbtutils.ts#L25) 12 | 13 | ## Parameters 14 | 15 | ### script 16 | 17 | `Uint8Array` 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/psbtutils/functions/isP2PK.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [psbtutils](../README.md) / isP2PK 6 | 7 | # Function: isP2PK() 8 | 9 | > **isP2PK**(`script`): `boolean` 10 | 11 | Defined in: [ts\_src/psbt/psbtutils.ts:26](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/psbtutils.ts#L26) 12 | 13 | ## Parameters 14 | 15 | ### script 16 | 17 | `Uint8Array` 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/psbtutils/functions/isP2PKH.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [psbtutils](../README.md) / isP2PKH 6 | 7 | # Function: isP2PKH() 8 | 9 | > **isP2PKH**(`script`): `boolean` 10 | 11 | Defined in: [ts\_src/psbt/psbtutils.ts:27](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/psbtutils.ts#L27) 12 | 13 | ## Parameters 14 | 15 | ### script 16 | 17 | `Uint8Array` 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/psbtutils/functions/isP2SHScript.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [psbtutils](../README.md) / isP2SHScript 6 | 7 | # Function: isP2SHScript() 8 | 9 | > **isP2SHScript**(`script`): `boolean` 10 | 11 | Defined in: [ts\_src/psbt/psbtutils.ts:30](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/psbtutils.ts#L30) 12 | 13 | ## Parameters 14 | 15 | ### script 16 | 17 | `Uint8Array` 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/psbtutils/functions/isP2TR.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [psbtutils](../README.md) / isP2TR 6 | 7 | # Function: isP2TR() 8 | 9 | > **isP2TR**(`script`): `boolean` 10 | 11 | Defined in: [ts\_src/psbt/psbtutils.ts:31](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/psbtutils.ts#L31) 12 | 13 | ## Parameters 14 | 15 | ### script 16 | 17 | `Uint8Array` 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/psbtutils/functions/isP2WPKH.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [psbtutils](../README.md) / isP2WPKH 6 | 7 | # Function: isP2WPKH() 8 | 9 | > **isP2WPKH**(`script`): `boolean` 10 | 11 | Defined in: [ts\_src/psbt/psbtutils.ts:28](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/psbtutils.ts#L28) 12 | 13 | ## Parameters 14 | 15 | ### script 16 | 17 | `Uint8Array` 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/psbtutils/functions/isP2WSHScript.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [psbtutils](../README.md) / isP2WSHScript 6 | 7 | # Function: isP2WSHScript() 8 | 9 | > **isP2WSHScript**(`script`): `boolean` 10 | 11 | Defined in: [ts\_src/psbt/psbtutils.ts:29](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/psbtutils.ts#L29) 12 | 13 | ## Parameters 14 | 15 | ### script 16 | 17 | `Uint8Array` 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/psbtutils/functions/pubkeyInScript.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [psbtutils](../README.md) / pubkeyInScript 6 | 7 | # Function: pubkeyInScript() 8 | 9 | > **pubkeyInScript**(`pubkey`, `script`): `boolean` 10 | 11 | Defined in: [ts\_src/psbt/psbtutils.ts:101](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/psbtutils.ts#L101) 12 | 13 | Checks if a public key is present in a script. 14 | 15 | ## Parameters 16 | 17 | ### pubkey 18 | 19 | `Uint8Array` 20 | 21 | The public key to check. 22 | 23 | ### script 24 | 25 | `Uint8Array` 26 | 27 | The script to search in. 28 | 29 | ## Returns 30 | 31 | `boolean` 32 | 33 | A boolean indicating whether the public key is present in the script. 34 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/psbtutils/functions/pubkeyPositionInScript.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [psbtutils](../README.md) / pubkeyPositionInScript 6 | 7 | # Function: pubkeyPositionInScript() 8 | 9 | > **pubkeyPositionInScript**(`pubkey`, `script`): `number` 10 | 11 | Defined in: [ts\_src/psbt/psbtutils.ts:75](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/psbtutils.ts#L75) 12 | 13 | Finds the position of a public key in a script. 14 | 15 | ## Parameters 16 | 17 | ### pubkey 18 | 19 | `Uint8Array` 20 | 21 | The public key to search for. 22 | 23 | ### script 24 | 25 | `Uint8Array` 26 | 27 | The script to search in. 28 | 29 | ## Returns 30 | 31 | `number` 32 | 33 | The index of the public key in the script, or -1 if not found. 34 | 35 | ## Throws 36 | 37 | If there is an unknown script error. 38 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/psbtutils/functions/signatureBlocksAction.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [psbtutils](../README.md) / signatureBlocksAction 6 | 7 | # Function: signatureBlocksAction() 8 | 9 | > **signatureBlocksAction**(`signature`, `signatureDecodeFn`, `action`): `boolean` 10 | 11 | Defined in: [ts\_src/psbt/psbtutils.ts:133](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/psbtutils.ts#L133) 12 | 13 | Determines if a given action is allowed for a signature block. 14 | 15 | ## Parameters 16 | 17 | ### signature 18 | 19 | `Uint8Array` 20 | 21 | The signature block. 22 | 23 | ### signatureDecodeFn 24 | 25 | `SignatureDecodeFunc` 26 | 27 | The function used to decode the signature. 28 | 29 | ### action 30 | 31 | `string` 32 | 33 | The action to be checked. 34 | 35 | ## Returns 36 | 37 | `boolean` 38 | 39 | True if the action is allowed, false otherwise. 40 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/psbtutils/functions/witnessStackToScriptWitness.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [psbtutils](../README.md) / witnessStackToScriptWitness 6 | 7 | # Function: witnessStackToScriptWitness() 8 | 9 | > **witnessStackToScriptWitness**(`witness`): `Uint8Array` 10 | 11 | Defined in: [ts\_src/psbt/psbtutils.ts:38](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/psbt/psbtutils.ts#L38) 12 | 13 | Converts a witness stack to a script witness. 14 | 15 | ## Parameters 16 | 17 | ### witness 18 | 19 | `Uint8Array`[] 20 | 21 | The witness stack to convert. 22 | 23 | ## Returns 24 | 25 | `Uint8Array` 26 | 27 | The script witness as a Buffer. 28 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/script/functions/asMinimalOP.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [script](../README.md) / asMinimalOP 6 | 7 | # Function: asMinimalOP() 8 | 9 | > **asMinimalOP**(`buffer`): `number` \| `void` 10 | 11 | Defined in: [ts\_src/script.ts:60](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/script.ts#L60) 12 | 13 | ## Parameters 14 | 15 | ### buffer 16 | 17 | `Uint8Array` 18 | 19 | ## Returns 20 | 21 | `number` \| `void` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/script/functions/checkMinimalPush.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [script](../README.md) / checkMinimalPush 6 | 7 | # Function: checkMinimalPush() 8 | 9 | > **checkMinimalPush**(`opcodenum`, `buf`): `boolean` 10 | 11 | Defined in: [ts\_src/script.ts:197](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/script.ts#L197) 12 | 13 | Comes from bitcoind's script interpreter CheckMinimalPush function 14 | 15 | ## Parameters 16 | 17 | ### opcodenum 18 | 19 | `number` 20 | 21 | ### buf 22 | 23 | `Uint8Array` 24 | 25 | ## Returns 26 | 27 | `boolean` 28 | 29 | if the chunk {i} is the smallest way to push that particular data. 30 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/script/functions/compile.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [script](../README.md) / compile 6 | 7 | # Function: compile() 8 | 9 | > **compile**(`chunks`): `Uint8Array` 10 | 11 | Defined in: [ts\_src/script.ts:86](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/script.ts#L86) 12 | 13 | Compiles an array of chunks into a Buffer. 14 | 15 | ## Parameters 16 | 17 | ### chunks 18 | 19 | The array of chunks to compile. 20 | 21 | `Uint8Array` | [`Stack`](../../payments/type-aliases/Stack.md) 22 | 23 | ## Returns 24 | 25 | `Uint8Array` 26 | 27 | The compiled Buffer. 28 | 29 | ## Throws 30 | 31 | Error if the compilation fails. 32 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/script/functions/countNonPushOnlyOPs.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [script](../README.md) / countNonPushOnlyOPs 6 | 7 | # Function: countNonPushOnlyOPs() 8 | 9 | > **countNonPushOnlyOPs**(`value`): `number` 10 | 11 | Defined in: [ts\_src/script.ts:56](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/script.ts#L56) 12 | 13 | ## Parameters 14 | 15 | ### value 16 | 17 | [`Stack`](../../payments/type-aliases/Stack.md) 18 | 19 | ## Returns 20 | 21 | `number` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/script/functions/createWitnessProgram.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [script](../README.md) / createWitnessProgram 6 | 7 | # Function: createWitnessProgram() 8 | 9 | > **createWitnessProgram**(`buf`): `false` \| \{ `program`: `Uint8Array`; `version`: `number`; \} 10 | 11 | Defined in: [ts\_src/script.ts:360](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/script.ts#L360) 12 | 13 | ## Parameters 14 | 15 | ### buf 16 | 17 | `Uint8Array` 18 | 19 | ## Returns 20 | 21 | `false` \| \{ `program`: `Uint8Array`; `version`: `number`; \} 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/script/functions/decompile.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [script](../README.md) / decompile 6 | 7 | # Function: decompile() 8 | 9 | > **decompile**(`buffer`, `fRequireMinimal`): `null` \| (`number` \| `Uint8Array`)[] 10 | 11 | Defined in: [ts\_src/script.ts:136](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/script.ts#L136) 12 | 13 | ## Parameters 14 | 15 | ### buffer 16 | 17 | `Uint8Array` | (`number` \| `Uint8Array`)[] 18 | 19 | ### fRequireMinimal 20 | 21 | `boolean` = `false` 22 | 23 | ## Returns 24 | 25 | `null` \| (`number` \| `Uint8Array`)[] 26 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/script/functions/fromASM.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [script](../README.md) / fromASM 6 | 7 | # Function: fromASM() 8 | 9 | > **fromASM**(`asm`): `Uint8Array` 10 | 11 | Defined in: [ts\_src/script.ts:253](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/script.ts#L253) 12 | 13 | Converts an ASM string to a Buffer. 14 | 15 | ## Parameters 16 | 17 | ### asm 18 | 19 | `string` 20 | 21 | The ASM string to convert. 22 | 23 | ## Returns 24 | 25 | `Uint8Array` 26 | 27 | The converted Buffer. 28 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/script/functions/isCanonicalPubKey.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [script](../README.md) / isCanonicalPubKey 6 | 7 | # Function: isCanonicalPubKey() 8 | 9 | > **isCanonicalPubKey**(`buffer`): `boolean` 10 | 11 | Defined in: [ts\_src/script.ts:300](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/script.ts#L300) 12 | 13 | ## Parameters 14 | 15 | ### buffer 16 | 17 | `Uint8Array` 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/script/functions/isCanonicalScriptSignature.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [script](../README.md) / isCanonicalScriptSignature 6 | 7 | # Function: isCanonicalScriptSignature() 8 | 9 | > **isCanonicalScriptSignature**(`buffer`): `boolean` 10 | 11 | Defined in: [ts\_src/script.ts:323](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/script.ts#L323) 12 | 13 | ## Parameters 14 | 15 | ### buffer 16 | 17 | `Uint8Array` 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/script/functions/isDefinedHashType.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [script](../README.md) / isDefinedHashType 6 | 7 | # Function: isDefinedHashType() 8 | 9 | > **isDefinedHashType**(`hashType`): `boolean` 10 | 11 | Defined in: [ts\_src/script.ts:317](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/script.ts#L317) 12 | 13 | ## Parameters 14 | 15 | ### hashType 16 | 17 | `number` 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/script/functions/isMinimalPush.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [script](../README.md) / isMinimalPush 6 | 7 | # Function: isMinimalPush() 8 | 9 | > **isMinimalPush**(`opcodenum`, `buf`): `boolean` 10 | 11 | Defined in: [ts\_src/script.ts:330](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/script.ts#L330) 12 | 13 | ## Parameters 14 | 15 | ### opcodenum 16 | 17 | `number` 18 | 19 | ### buf 20 | 21 | `Uint8Array` 22 | 23 | ## Returns 24 | 25 | `boolean` 26 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/script/functions/isPushOnly.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [script](../README.md) / isPushOnly 6 | 7 | # Function: isPushOnly() 8 | 9 | > **isPushOnly**(`value`): `boolean` 10 | 11 | Defined in: [ts\_src/script.ts:33](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/script.ts#L33) 12 | 13 | ## Parameters 14 | 15 | ### value 16 | 17 | `Uint8Array` | [`Stack`](../../payments/type-aliases/Stack.md) 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/script/functions/isScriptHashOut.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [script](../README.md) / isScriptHashOut 6 | 7 | # Function: isScriptHashOut() 8 | 9 | > **isScriptHashOut**(`value`): `boolean` 10 | 11 | Defined in: [ts\_src/script.ts:47](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/script.ts#L47) 12 | 13 | ## Parameters 14 | 15 | ### value 16 | 17 | `Uint8Array` 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/script/functions/isUncompressedPubkey.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [script](../README.md) / isUncompressedPubkey 6 | 7 | # Function: isUncompressedPubkey() 8 | 9 | > **isUncompressedPubkey**(`buffer`): `boolean` 10 | 11 | Defined in: [ts\_src/script.ts:304](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/script.ts#L304) 12 | 13 | ## Parameters 14 | 15 | ### buffer 16 | 17 | `Uint8Array` 18 | 19 | ## Returns 20 | 21 | `boolean` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/script/functions/toASM.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [script](../README.md) / toASM 6 | 7 | # Function: toASM() 8 | 9 | > **toASM**(`chunks`): `string` 10 | 11 | Defined in: [ts\_src/script.ts:226](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/script.ts#L226) 12 | 13 | Converts the given chunks into an ASM (Assembly) string representation. 14 | If the chunks parameter is a Buffer, it will be decompiled into a Stack before conversion. 15 | 16 | ## Parameters 17 | 18 | ### chunks 19 | 20 | The chunks to convert into ASM. 21 | 22 | `Uint8Array` | (`number` \| `Uint8Array`)[] 23 | 24 | ## Returns 25 | 26 | `string` 27 | 28 | The ASM string representation of the chunks. 29 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/script/functions/toStack.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [script](../README.md) / toStack 6 | 7 | # Function: toStack() 8 | 9 | > **toStack**(`chunks`): `Uint8Array`[] 10 | 11 | Defined in: [ts\_src/script.ts:286](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/script.ts#L286) 12 | 13 | Converts the given chunks into a stack of buffers. 14 | 15 | ## Parameters 16 | 17 | ### chunks 18 | 19 | The chunks to convert. 20 | 21 | `Uint8Array` | (`number` \| `Uint8Array`)[] 22 | 23 | ## Returns 24 | 25 | `Uint8Array`[] 26 | 27 | The stack of buffers. 28 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/script/variables/OPS.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [script](../README.md) / OPS 6 | 7 | # Variable: OPS 8 | 9 | > `const` **OPS**: `object` 10 | 11 | Defined in: [ts\_src/ops.ts:1](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/ops.ts#L1) 12 | 13 | ## Index Signature 14 | 15 | \[`key`: `string`\]: `number` 16 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/script/variables/number.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [script](../README.md) / number 6 | 7 | # Variable: number 8 | 9 | > `const` **number**: [`scriptNumber`](../../scriptNumber/README.md) = `scriptNumber` 10 | 11 | Defined in: [ts\_src/script.ts:412](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/script.ts#L412) 12 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/script/variables/signature.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [script](../README.md) / signature 6 | 7 | # Variable: signature 8 | 9 | > `const` **signature**: `__module` = `scriptSignature` 10 | 11 | Defined in: [ts\_src/script.ts:413](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/script.ts#L413) 12 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/scriptNumber/README.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../README.md) / scriptNumber 6 | 7 | # scriptNumber 8 | 9 | ## Functions 10 | 11 | - [decode](functions/decode.md) 12 | - [encode](functions/encode.md) 13 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/scriptNumber/functions/encode.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [scriptNumber](../README.md) / encode 6 | 7 | # Function: encode() 8 | 9 | > **encode**(`_number`): `Uint8Array` 10 | 11 | Defined in: [ts\_src/script\_number.ts:71](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/script_number.ts#L71) 12 | 13 | Encodes a number into a Uint8Array using a specific format. 14 | 15 | ## Parameters 16 | 17 | ### \_number 18 | 19 | `number` 20 | 21 | The number to encode. 22 | 23 | ## Returns 24 | 25 | `Uint8Array` 26 | 27 | The encoded number as a Uint8Array. 28 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/types/functions/NBufferSchemaFactory.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [types](../README.md) / NBufferSchemaFactory 6 | 7 | # Function: NBufferSchemaFactory() 8 | 9 | > **NBufferSchemaFactory**(`size`): `SchemaWithPipe`\<\[`InstanceSchema`\<`Uint8ArrayConstructor`, `undefined`\>, `LengthAction`\<`Uint8Array`, `number`, `undefined`\>\]\> 10 | 11 | Defined in: [ts\_src/types.ts:9](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L9) 12 | 13 | ## Parameters 14 | 15 | ### size 16 | 17 | `number` 18 | 19 | ## Returns 20 | 21 | `SchemaWithPipe`\<\[`InstanceSchema`\<`Uint8ArrayConstructor`, `undefined`\>, `LengthAction`\<`Uint8Array`, `number`, `undefined`\>\]\> 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/types/functions/NullablePartial.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [types](../README.md) / NullablePartial 6 | 7 | # Function: NullablePartial() 8 | 9 | > **NullablePartial**(`a`): `ObjectSchema`\<\{\}, `undefined`\> 10 | 11 | Defined in: [ts\_src/types.ts:125](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L125) 12 | 13 | ## Parameters 14 | 15 | ### a 16 | 17 | `Record`\<`string`, `any`\> 18 | 19 | ## Returns 20 | 21 | `ObjectSchema`\<\{\}, `undefined`\> 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/types/functions/isPoint.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [types](../README.md) / isPoint 6 | 7 | # Function: isPoint() 8 | 9 | > **isPoint**(`p`): `boolean` 10 | 11 | Defined in: [ts\_src/types.ts:31](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L31) 12 | 13 | Checks if the given value is a valid elliptic curve point. 14 | 15 | ## Parameters 16 | 17 | ### p 18 | 19 | The value to check. 20 | 21 | `undefined` | `null` | `number` | `Uint8Array` 22 | 23 | ## Returns 24 | 25 | `boolean` 26 | 27 | True if the value is a valid elliptic curve point, false otherwise. 28 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/types/functions/isTapleaf.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [types](../README.md) / isTapleaf 6 | 7 | # Function: isTapleaf() 8 | 9 | > **isTapleaf**(`o`): `o is Tapleaf` 10 | 11 | Defined in: [ts\_src/types.ts:61](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L61) 12 | 13 | ## Parameters 14 | 15 | ### o 16 | 17 | `any` 18 | 19 | ## Returns 20 | 21 | `o is Tapleaf` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/types/functions/isTaptree.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [types](../README.md) / isTaptree 6 | 7 | # Function: isTaptree() 8 | 9 | > **isTaptree**(`scriptTree`): `scriptTree is Taptree` 10 | 11 | Defined in: [ts\_src/types.ts:76](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L76) 12 | 13 | ## Parameters 14 | 15 | ### scriptTree 16 | 17 | `any` 18 | 19 | ## Returns 20 | 21 | `scriptTree is Taptree` 22 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/types/functions/stacksEqual.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [types](../README.md) / stacksEqual 6 | 7 | # Function: stacksEqual() 8 | 9 | > **stacksEqual**(`a`, `b`): `boolean` 10 | 11 | Defined in: [ts\_src/types.ts:18](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L18) 12 | 13 | Checks if two arrays of Buffers are equal. 14 | 15 | ## Parameters 16 | 17 | ### a 18 | 19 | `Uint8Array`[] 20 | 21 | The first array of Buffers. 22 | 23 | ### b 24 | 25 | `Uint8Array`[] 26 | 27 | The second array of Buffers. 28 | 29 | ## Returns 30 | 31 | `boolean` 32 | 33 | True if the arrays are equal, false otherwise. 34 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/types/interfaces/Tapleaf.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [types](../README.md) / Tapleaf 6 | 7 | # Interface: Tapleaf 8 | 9 | Defined in: [ts\_src/types.ts:55](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L55) 10 | 11 | ## Properties 12 | 13 | ### output 14 | 15 | > **output**: `Uint8Array` 16 | 17 | Defined in: [ts\_src/types.ts:56](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L56) 18 | 19 | *** 20 | 21 | ### version? 22 | 23 | > `optional` **version**: `number` 24 | 25 | Defined in: [ts\_src/types.ts:57](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L57) 26 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/types/interfaces/XOnlyPointAddTweakResult.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [types](../README.md) / XOnlyPointAddTweakResult 6 | 7 | # Interface: XOnlyPointAddTweakResult 8 | 9 | Defined in: [ts\_src/types.ts:50](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L50) 10 | 11 | ## Properties 12 | 13 | ### parity 14 | 15 | > **parity**: `0` \| `1` 16 | 17 | Defined in: [ts\_src/types.ts:51](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L51) 18 | 19 | *** 20 | 21 | ### xOnlyPubkey 22 | 23 | > **xOnlyPubkey**: `Uint8Array` 24 | 25 | Defined in: [ts\_src/types.ts:52](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L52) 26 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/types/variables/Buffer256bitSchema.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [types](../README.md) / Buffer256bitSchema 6 | 7 | # Variable: Buffer256bitSchema 8 | 9 | > `const` **Buffer256bitSchema**: `SchemaWithPipe`\<\[`InstanceSchema`\<`Uint8ArrayConstructor`, `undefined`\>, `LengthAction`\<`Uint8Array`, `number`, `undefined`\>\]\> 10 | 11 | Defined in: [ts\_src/types.ts:99](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L99) 12 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/types/variables/BufferSchema.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [types](../README.md) / BufferSchema 6 | 7 | # Variable: BufferSchema 8 | 9 | > `const` **BufferSchema**: `InstanceSchema`\<`Uint8ArrayConstructor`, `undefined`\> 10 | 11 | Defined in: [ts\_src/types.ts:102](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L102) 12 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/types/variables/Hash160bitSchema.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [types](../README.md) / Hash160bitSchema 6 | 7 | # Variable: Hash160bitSchema 8 | 9 | > `const` **Hash160bitSchema**: `SchemaWithPipe`\<\[`InstanceSchema`\<`Uint8ArrayConstructor`, `undefined`\>, `LengthAction`\<`Uint8Array`, `number`, `undefined`\>\]\> 10 | 11 | Defined in: [ts\_src/types.ts:100](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L100) 12 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/types/variables/Hash256bitSchema.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [types](../README.md) / Hash256bitSchema 6 | 7 | # Variable: Hash256bitSchema 8 | 9 | > `const` **Hash256bitSchema**: `SchemaWithPipe`\<\[`InstanceSchema`\<`Uint8ArrayConstructor`, `undefined`\>, `LengthAction`\<`Uint8Array`, `number`, `undefined`\>\]\> 10 | 11 | Defined in: [ts\_src/types.ts:101](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L101) 12 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/types/variables/HexSchema.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [types](../README.md) / HexSchema 6 | 7 | # Variable: HexSchema 8 | 9 | > `const` **HexSchema**: `SchemaWithPipe`\<\[`StringSchema`\<`undefined`\>, `RegexAction`\<`string`, `undefined`\>\]\> 10 | 11 | Defined in: [ts\_src/types.ts:103](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L103) 12 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/types/variables/SatoshiSchema.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [types](../README.md) / SatoshiSchema 6 | 7 | # Variable: SatoshiSchema 8 | 9 | > `const` **SatoshiSchema**: `SchemaWithPipe`\<\[`BigintSchema`\<`undefined`\>, `MinValueAction`\<`bigint`, `0n`, `undefined`\>, `MaxValueAction`\<`bigint`, `9223372036854775807n`, `undefined`\>\]\> 10 | 11 | Defined in: [ts\_src/types.ts:119](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L119) 12 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/types/variables/TAPLEAF_VERSION_MASK.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [types](../README.md) / TAPLEAF\_VERSION\_MASK 6 | 7 | # Variable: TAPLEAF\_VERSION\_MASK 8 | 9 | > `const` **TAPLEAF\_VERSION\_MASK**: `254` = `0xfe` 10 | 11 | Defined in: [ts\_src/types.ts:60](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L60) 12 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/types/variables/UInt32Schema.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [types](../README.md) / UInt32Schema 6 | 7 | # Variable: UInt32Schema 8 | 9 | > `const` **UInt32Schema**: `SchemaWithPipe`\<\[`NumberSchema`\<`undefined`\>, `IntegerAction`\<`number`, `undefined`\>, `MinValueAction`\<`number`, `0`, `undefined`\>, `MaxValueAction`\<`number`, `4294967295`, `undefined`\>\]\> 10 | 11 | Defined in: [ts\_src/types.ts:113](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L113) 12 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/types/variables/UInt8Schema.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [types](../README.md) / UInt8Schema 6 | 7 | # Variable: UInt8Schema 8 | 9 | > `const` **UInt8Schema**: `SchemaWithPipe`\<\[`NumberSchema`\<`undefined`\>, `IntegerAction`\<`number`, `undefined`\>, `MinValueAction`\<`number`, `0`, `undefined`\>, `MaxValueAction`\<`number`, `255`, `undefined`\>\]\> 10 | 11 | Defined in: [ts\_src/types.ts:107](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L107) 12 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/namespaces/types/variables/x0HexSchema.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../../../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../../../README.md) / [types](../README.md) / x0HexSchema 6 | 7 | # Variable: x0HexSchema 8 | 9 | > `const` **x0HexSchema**: `SchemaWithPipe`\<\[`StringSchema`\<`undefined`\>, `RegexAction`\<`string`, `undefined`\>\]\> 10 | 11 | Defined in: [ts\_src/types.ts:105](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L105) 12 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/type-aliases/Taptree.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / Taptree 6 | 7 | # Type Alias: Taptree 8 | 9 | > **Taptree**: \[[`Taptree`](Taptree.md) \| [`Tapleaf`](../namespaces/types/interfaces/Tapleaf.md), [`Taptree`](Taptree.md) \| [`Tapleaf`](../namespaces/types/interfaces/Tapleaf.md)\] \| [`Tapleaf`](../namespaces/types/interfaces/Tapleaf.md) 10 | 11 | Defined in: [ts\_src/types.ts:74](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/types.ts#L74) 12 | 13 | Binary tree repsenting script path spends for a Taproot input. 14 | Each node is either a single Tapleaf, or a pair of Tapleaf | Taptree. 15 | The tree has no balancing requirements. 16 | -------------------------------------------------------------------------------- /btc-docs/references/bitcoinjs-lib/variables/reverse_opcodes.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v1.0.7**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / reverse\_opcodes 6 | 7 | # Variable: reverse\_opcodes 8 | 9 | > `const` **reverse\_opcodes**: `object` = `{}` 10 | 11 | Defined in: [ts\_src/ops.ts:137](https://github.com/sCrypt-Inc/bitcoinjs-lib/blob/e3b2d1c4c35cd925f8b17063dc9eb0300cab46a2/ts_src/ops.ts#L137) 12 | 13 | ## Index Signature 14 | 15 | \[`key`: `number`\]: `string` 16 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "position": 0, 3 | "label": "scrypt-ts-btc", 4 | "collapsible": true, 5 | "collapsed": true 6 | } -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/Addr.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / Addr 6 | 7 | # Function: Addr() 8 | 9 | > **Addr**(`b`): [`Ripemd160`](../type-aliases/Ripemd160.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:147](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L147) 12 | 13 | Creates an `Addr` instance from a `ByteString`. 14 | 15 | ## Parameters 16 | 17 | ### b 18 | 19 | [`ByteString`](../type-aliases/ByteString.md) 20 | 21 | Input ByteString. 22 | 23 | ## Returns 24 | 25 | [`Ripemd160`](../type-aliases/Ripemd160.md) 26 | 27 | - A domain specific address representation. 28 | 29 | ## Onchain 30 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/OpCodeType.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / OpCodeType 6 | 7 | # Function: OpCodeType() 8 | 9 | > **OpCodeType**(`b`): [`OpCodeType`](../type-aliases/OpCodeType.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:233](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L233) 12 | 13 | Creates a `OpCodeType` from a `ByteString`. 14 | 15 | ## Parameters 16 | 17 | ### b 18 | 19 | [`ByteString`](../type-aliases/ByteString.md) 20 | 21 | Input ByteString. 22 | 23 | ## Returns 24 | 25 | [`OpCodeType`](../type-aliases/OpCodeType.md) 26 | 27 | - A domain specific OpCodeType representation. 28 | 29 | ## Onchain 30 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/PrivKey.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / PrivKey 6 | 7 | # Function: PrivKey() 8 | 9 | > **PrivKey**(`n`): [`PrivKey`](../type-aliases/PrivKey.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:39](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L39) 12 | 13 | Creates a `PrivKey` instance from a `Int32`. 14 | 15 | ## Parameters 16 | 17 | ### n 18 | 19 | [`Int32`](../type-aliases/Int32.md) 20 | 21 | ## Returns 22 | 23 | [`PrivKey`](../type-aliases/PrivKey.md) 24 | 25 | - A domain specific private key representation. 26 | 27 | ## Onchain 28 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/PubKey.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / PubKey 6 | 7 | # Function: PubKey() 8 | 9 | > **PubKey**(`b`): [`PubKey`](../type-aliases/PubKey.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:56](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L56) 12 | 13 | Creates a `PubKey` instance from a `ByteString`. 14 | 15 | ## Parameters 16 | 17 | ### b 18 | 19 | [`ByteString`](../type-aliases/ByteString.md) 20 | 21 | Input ByteString. 22 | 23 | ## Returns 24 | 25 | [`PubKey`](../type-aliases/PubKey.md) 26 | 27 | - A domain specific public key representation. 28 | 29 | ## Onchain 30 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/PubKeyHash.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / PubKeyHash 6 | 7 | # Function: PubKeyHash() 8 | 9 | > **PubKeyHash**(`b`): [`Ripemd160`](../type-aliases/Ripemd160.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:130](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L130) 12 | 13 | Creates a `PubKeyHash` instance from a `ByteString`. 14 | 15 | ## Parameters 16 | 17 | ### b 18 | 19 | [`ByteString`](../type-aliases/ByteString.md) 20 | 21 | Input ByteString. 22 | 23 | ## Returns 24 | 25 | [`Ripemd160`](../type-aliases/Ripemd160.md) 26 | 27 | - A domain specific address representation. 28 | 29 | ## Onchain 30 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/Ripemd160-1.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / Ripemd160 6 | 7 | # Function: Ripemd160() 8 | 9 | > **Ripemd160**(`b`): [`Ripemd160`](../type-aliases/Ripemd160.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:113](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L113) 12 | 13 | Creates a `Ripemd160` instance from a `ByteString`. 14 | 15 | ## Parameters 16 | 17 | ### b 18 | 19 | [`ByteString`](../type-aliases/ByteString.md) 20 | 21 | Input ByteString. 22 | 23 | ## Returns 24 | 25 | [`Ripemd160`](../type-aliases/Ripemd160.md) 26 | 27 | - A domain specific RIPEMD-160 hash representation. 28 | 29 | ## Onchain 30 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/Sha1-1.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / Sha1 6 | 7 | # Function: Sha1() 8 | 9 | > **Sha1**(`b`): [`Sha1`](../type-aliases/Sha1.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:164](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L164) 12 | 13 | Creates a `Sha1` instance from a `ByteString`. 14 | 15 | ## Parameters 16 | 17 | ### b 18 | 19 | [`ByteString`](../type-aliases/ByteString.md) 20 | 21 | Input ByteString. 22 | 23 | ## Returns 24 | 25 | [`Sha1`](../type-aliases/Sha1.md) 26 | 27 | - A domain specific SHA-1 hash representation. 28 | 29 | ## Onchain 30 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/Sha256-1.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / Sha256 6 | 7 | # Function: Sha256() 8 | 9 | > **Sha256**(`b`): [`Sha256`](../type-aliases/Sha256.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:182](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L182) 12 | 13 | Creates a `Sha256` instance from a `ByteString`. 14 | 15 | ## Parameters 16 | 17 | ### b 18 | 19 | [`ByteString`](../type-aliases/ByteString.md) 20 | 21 | Input ByteString. 22 | 23 | ## Returns 24 | 25 | [`Sha256`](../type-aliases/Sha256.md) 26 | 27 | - A domain specific SHA-256 hash representation. 28 | 29 | ## Onchain 30 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/Sig.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / Sig 6 | 7 | # Function: Sig() 8 | 9 | > **Sig**(`b`): [`Sig`](../type-aliases/Sig.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:96](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L96) 12 | 13 | Creates a `Sig` instance from a `ByteString`. 14 | 15 | ## Parameters 16 | 17 | ### b 18 | 19 | [`ByteString`](../type-aliases/ByteString.md) 20 | 21 | Input ByteString. 22 | 23 | ## Returns 24 | 25 | [`Sig`](../type-aliases/Sig.md) 26 | 27 | - A domain specific digital signature representation. 28 | 29 | ## Onchain 30 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/XOnlyPubKey.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / XOnlyPubKey 6 | 7 | # Function: XOnlyPubKey() 8 | 9 | > **XOnlyPubKey**(`b`): [`XOnlyPubKey`](../type-aliases/XOnlyPubKey.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:73](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L73) 12 | 13 | Creates an `Addr` instance from a `ByteString`. 14 | 15 | ## Parameters 16 | 17 | ### b 18 | 19 | [`ByteString`](../type-aliases/ByteString.md) 20 | 21 | Input ByteString. 22 | 23 | ## Returns 24 | 25 | [`XOnlyPubKey`](../type-aliases/XOnlyPubKey.md) 26 | 27 | - A domain specific address representation. 28 | 29 | ## Onchain 30 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/abs.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / abs 6 | 7 | # Function: abs() 8 | 9 | > **abs**(`value`): [`Int32`](../type-aliases/Int32.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/fns/math.ts:47](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/fns/math.ts#L47) 12 | 13 | Returns the absolute value of a Int32. 14 | 15 | ## Parameters 16 | 17 | ### value 18 | 19 | [`Int32`](../type-aliases/Int32.md) 20 | 21 | The Int32 value 22 | 23 | ## Returns 24 | 25 | [`Int32`](../type-aliases/Int32.md) 26 | 27 | The absolute value of the Int32. 28 | 29 | ## Onchain 30 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/assert.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / assert 6 | 7 | # Function: assert() 8 | 9 | > **assert**(`condition`, `msg`?): `asserts condition` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/fns/assert.ts:7](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/fns/assert.ts#L7) 12 | 13 | `assert(condition: boolean, errorMsg?: string)` 14 | Throw an Error with the optional error message if condition is false. Otherwise, nothing happens. 15 | 16 | ## Parameters 17 | 18 | ### condition 19 | 20 | `boolean` 21 | 22 | ### msg? 23 | 24 | `string` 25 | 26 | ## Returns 27 | 28 | `asserts condition` 29 | 30 | ## Onchain 31 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/bvmVerify.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / bvmVerify 6 | 7 | # Function: bvmVerify() 8 | 9 | > **bvmVerify**(`extPsbt`, `inputIndex`): `string` \| `true` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/utils/bvm.ts:39](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/utils/bvm.ts#L39) 12 | 13 | Verify that an input of `ExtPsbt` can be unlocked correctly. The extPsbt should be finalized. 14 | 15 | ## Parameters 16 | 17 | ### extPsbt 18 | 19 | [`ExtPsbt`](../classes/ExtPsbt.md) 20 | 21 | ### inputIndex 22 | 23 | `number` = `0` 24 | 25 | ## Returns 26 | 27 | `string` \| `true` 28 | 29 | true if success 30 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/byteStringToInt32.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / byteStringToInt32 6 | 7 | # Function: byteStringToInt32() 8 | 9 | > **byteStringToInt32**(`a`): [`Int32`](../type-aliases/Int32.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/fns/byteString.ts:51](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/fns/byteString.ts#L51) 12 | 13 | ByteString can be converted to bigint with byteString2Int. 14 | 15 | ## Parameters 16 | 17 | ### a 18 | 19 | [`ByteString`](../type-aliases/ByteString.md) 20 | 21 | a ByteString being converts 22 | 23 | ## Returns 24 | 25 | [`Int32`](../type-aliases/Int32.md) 26 | 27 | returns a number 28 | 29 | ## Onchain 30 | 31 | ## Throws 32 | 33 | throws an error if the number is out of range or 34 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/equals.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / equals 6 | 7 | # Function: equals() 8 | 9 | > **equals**\<`T`\>(`a`, `b`): `boolean` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/fns/equals.ts:7](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/fns/equals.ts#L7) 12 | 13 | Comparing two struct/FixedArray 14 | 15 | ## Type Parameters 16 | 17 | • **T** 18 | 19 | ## Parameters 20 | 21 | ### a 22 | 23 | `T` 24 | 25 | ### b 26 | 27 | `T` 28 | 29 | ## Returns 30 | 31 | `boolean` 32 | 33 | returns true if equal; otherwise returns false 34 | 35 | ## Onchain 36 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/fillFixedArray.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / fillFixedArray 6 | 7 | # Function: fillFixedArray() 8 | 9 | > **fillFixedArray**\<`T`, `Length`\>(`value`, `len`): [`FixedArray`](../type-aliases/FixedArray.md)\<`T`, `Length`\> 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/utils/common.ts:88](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/utils/common.ts#L88) 12 | 13 | create a FixedArray and fill it with initial value 14 | 15 | ## Type Parameters 16 | 17 | • **T** 18 | 19 | • **Length** *extends* `number` 20 | 21 | ## Parameters 22 | 23 | ### value 24 | 25 | `T` 26 | 27 | ### len 28 | 29 | `Length` 30 | 31 | ## Returns 32 | 33 | [`FixedArray`](../type-aliases/FixedArray.md)\<`T`, `Length`\> 34 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/hash160.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / hash160 6 | 7 | # Function: hash160() 8 | 9 | > **hash160**(`a`): [`Ripemd160`](../type-aliases/Ripemd160.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/fns/hashes.ts:20](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/fns/hashes.ts#L20) 12 | 13 | A RIPEMD160 hash of a SHA256 hash, which is always 160 bits or 20 bytes long. 14 | This value is commonly used inside Bitcoin, particularly for Bitcoin 15 | addresses. 16 | 17 | See: 18 | https://en.wikipedia.org/wiki/RIPEMD 19 | 20 | ## Parameters 21 | 22 | ### a 23 | 24 | [`ByteString`](../type-aliases/ByteString.md) 25 | 26 | ByteString Data, a.k.a. pre-image, which can be any size. 27 | 28 | ## Returns 29 | 30 | [`Ripemd160`](../type-aliases/Ripemd160.md) 31 | 32 | The hash in the form of a string. 33 | 34 | ## Onchain 35 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/hexToUint8Array.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / hexToUint8Array 6 | 7 | # Function: hexToUint8Array() 8 | 9 | > **hexToUint8Array**(`hex`): `Uint8Array` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/utils/common.ts:28](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/utils/common.ts#L28) 12 | 13 | Converts a hexadecimal string to a Uint8Array. 14 | 15 | ## Parameters 16 | 17 | ### hex 18 | 19 | `string` 20 | 21 | The hexadecimal string. 22 | 23 | ## Returns 24 | 25 | `Uint8Array` 26 | 27 | The resulting Uint8Array. 28 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/int32ToByteString.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / int32ToByteString 6 | 7 | # Function: int32ToByteString() 8 | 9 | > **int32ToByteString**(`n`): [`ByteString`](../type-aliases/ByteString.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/fns/byteString.ts:36](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/fns/byteString.ts#L36) 12 | 13 | Int32 can be converted to a byte string with int2ByteString. 14 | 15 | ## Parameters 16 | 17 | ### n 18 | 19 | [`Int32`](../type-aliases/Int32.md) 20 | 21 | a number being converts 22 | 23 | ## Returns 24 | 25 | [`ByteString`](../type-aliases/ByteString.md) 26 | 27 | returns a ByteString 28 | 29 | ## Onchain 30 | 31 | ## Throws 32 | 33 | throws an error if the number is out of range 34 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/len.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / len 6 | 7 | # Function: len() 8 | 9 | > **len**(`a`): [`Int32`](../type-aliases/Int32.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/fns/byteString.ts:66](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/fns/byteString.ts#L66) 12 | 13 | Returns the length of the ByteString. Not the length of the string. 14 | 15 | ## Parameters 16 | 17 | ### a 18 | 19 | [`ByteString`](../type-aliases/ByteString.md) 20 | 21 | a ByteString 22 | 23 | ## Returns 24 | 25 | [`Int32`](../type-aliases/Int32.md) 26 | 27 | The length of the ByteString. 28 | 29 | ## Onchain 30 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/max.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / max 6 | 7 | # Function: max() 8 | 9 | > **max**(`a`, `b`): [`Int32`](../type-aliases/Int32.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/fns/math.ts:11](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/fns/math.ts#L11) 12 | 13 | Returns the maximum of two Int32 values. 14 | 15 | ## Parameters 16 | 17 | ### a 18 | 19 | [`Int32`](../type-aliases/Int32.md) 20 | 21 | First Int32 value 22 | 23 | ### b 24 | 25 | [`Int32`](../type-aliases/Int32.md) 26 | 27 | Second Int32 value 28 | 29 | ## Returns 30 | 31 | [`Int32`](../type-aliases/Int32.md) 32 | 33 | The larger of the two Int32 values. 34 | 35 | ## Onchain 36 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/method.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / method 6 | 7 | # Function: method() 8 | 9 | > **method**(`options`): (`target`, `methodName`, `descriptor`) => `PropertyDescriptor` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/decorators.ts:35](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/decorators.ts#L35) 12 | 13 | Indicates whether the method is a contract method, and ordinary methods do not affect the execution of the contract. 14 | 15 | ## Parameters 16 | 17 | ### options 18 | 19 | [`MethodDecoratorOptions`](../interfaces/MethodDecoratorOptions.md) = `...` 20 | 21 | ## Returns 22 | 23 | `Function` 24 | 25 | ### Parameters 26 | 27 | #### target 28 | 29 | `any` 30 | 31 | #### methodName 32 | 33 | `string` 34 | 35 | #### descriptor 36 | 37 | `PropertyDescriptor` 38 | 39 | ### Returns 40 | 41 | `PropertyDescriptor` 42 | 43 | ## Onchain 44 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/min.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / min 6 | 7 | # Function: min() 8 | 9 | > **min**(`a`, `b`): [`Int32`](../type-aliases/Int32.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/fns/math.ts:23](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/fns/math.ts#L23) 12 | 13 | Returns the minimum of two Int32 values. 14 | 15 | ## Parameters 16 | 17 | ### a 18 | 19 | [`Int32`](../type-aliases/Int32.md) 20 | 21 | First Int32 value 22 | 23 | ### b 24 | 25 | [`Int32`](../type-aliases/Int32.md) 26 | 27 | Second Int32 value 28 | 29 | ## Returns 30 | 31 | [`Int32`](../type-aliases/Int32.md) 32 | 33 | The smaller of the two Int32 values. 34 | 35 | ## Onchain 36 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/prop.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / prop 6 | 7 | # Function: prop() 8 | 9 | > **prop**(): (`target`, `propertyName`) => `void` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/decorators.ts:113](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/decorators.ts#L113) 12 | 13 | Indicates whether the property is an property of a contract, and ordinary class properties cannot be accessed in contract methods 14 | 15 | ## Returns 16 | 17 | `Function` 18 | 19 | ### Parameters 20 | 21 | #### target 22 | 23 | `any` 24 | 25 | #### propertyName 26 | 27 | `string` 28 | 29 | ### Returns 30 | 31 | `void` 32 | 33 | ## Onchain 34 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/pubKey2Addr.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / pubKey2Addr 6 | 7 | # Function: pubKey2Addr() 8 | 9 | > **pubKey2Addr**(`pubkey`): [`Ripemd160`](../type-aliases/Ripemd160.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/fns/pubKey2Addr.ts:12](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/fns/pubKey2Addr.ts#L12) 12 | 13 | Get Addr for PubKey. 14 | Under the hood this just wraps the hash160 function. 15 | 16 | ## Parameters 17 | 18 | ### pubkey 19 | 20 | [`PubKey`](../type-aliases/PubKey.md) 21 | 22 | the public key. 23 | 24 | ## Returns 25 | 26 | [`Ripemd160`](../type-aliases/Ripemd160.md) 27 | 28 | address for the passed public key. 29 | 30 | ## Onchain 31 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/ripemd160.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / ripemd160 6 | 7 | # Function: ripemd160() 8 | 9 | > **ripemd160**(`a`): [`Ripemd160`](../type-aliases/Ripemd160.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/fns/hashes.ts:77](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/fns/hashes.ts#L77) 12 | 13 | A RIPEMD160 hash, which is always 160 bits or 20 bytes long. 14 | See: 15 | https://en.wikipedia.org/wiki/RIPEMD 16 | 17 | ## Parameters 18 | 19 | ### a 20 | 21 | [`ByteString`](../type-aliases/ByteString.md) 22 | 23 | ByteString Data, a.k.a. pre-image, which can be any size. 24 | 25 | ## Returns 26 | 27 | [`Ripemd160`](../type-aliases/Ripemd160.md) 28 | 29 | The hash in the form of a ByteString. 30 | 31 | ## Onchain 32 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/sha1.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / sha1 6 | 7 | # Function: sha1() 8 | 9 | > **sha1**(`a`): [`Sha1`](../type-aliases/Sha1.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/fns/hashes.ts:64](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/fns/hashes.ts#L64) 12 | 13 | A SHA or SHA1 hash, which is always 160 bits or 20 bytes long. 14 | 15 | See: 16 | https://en.wikipedia.org/wiki/SHA-1 17 | 18 | ## Parameters 19 | 20 | ### a 21 | 22 | [`ByteString`](../type-aliases/ByteString.md) 23 | 24 | ByteString Data, a.k.a. pre-image, which can be any size. 25 | 26 | ## Returns 27 | 28 | [`Sha1`](../type-aliases/Sha1.md) 29 | 30 | The hash in the form of a string. 31 | 32 | ## Onchain 33 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/sha256.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / sha256 6 | 7 | # Function: sha256() 8 | 9 | > **sha256**(`a`): [`Sha256`](../type-aliases/Sha256.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/fns/hashes.ts:34](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/fns/hashes.ts#L34) 12 | 13 | A SHA256 hash, which is always 256 bits or 32 bytes long. 14 | 15 | See: 16 | https://www.movable-type.co.uk/scripts/sha256.html 17 | 18 | ## Parameters 19 | 20 | ### a 21 | 22 | [`ByteString`](../type-aliases/ByteString.md) 23 | 24 | ByteString Data, a.k.a. pre-image, which can be any size. 25 | 26 | ## Returns 27 | 28 | [`Sha256`](../type-aliases/Sha256.md) 29 | 30 | The hash in the form of a string. 31 | 32 | ## Onchain 33 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/textToHex.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / textToHex 6 | 7 | # Function: textToHex() 8 | 9 | > **textToHex**(`text`): `string` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/utils/common.ts:290](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/utils/common.ts#L290) 12 | 13 | convert utf8 text to hex string 14 | 15 | ## Parameters 16 | 17 | ### text 18 | 19 | `string` 20 | 21 | ## Returns 22 | 23 | `string` 24 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/toBitcoinNetwork.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / toBitcoinNetwork 6 | 7 | # Function: toBitcoinNetwork() 8 | 9 | > **toBitcoinNetwork**(`network`): `Network` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/utils/common.ts:40](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/utils/common.ts#L40) 12 | 13 | convert `SupportedNetwork` to bitcoinjs-lib network 14 | 15 | ## Parameters 16 | 17 | ### network 18 | 19 | [`SupportedNetwork`](../type-aliases/SupportedNetwork.md) 20 | 21 | ## Returns 22 | 23 | `Network` 24 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/toXOnly.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / toXOnly 6 | 7 | # Function: toXOnly() 8 | 9 | > **toXOnly**(`pubKeyHex`, `isP2TR`): `string` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/utils/common.ts:130](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/utils/common.ts#L130) 12 | 13 | pubKey in x-only format 14 | 15 | ## Parameters 16 | 17 | ### pubKeyHex 18 | 19 | `string` 20 | 21 | ### isP2TR 22 | 23 | `boolean` 24 | 25 | ## Returns 26 | 27 | `string` 28 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/uint8ArrayToHex.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / uint8ArrayToHex 6 | 7 | # Function: uint8ArrayToHex() 8 | 9 | > **uint8ArrayToHex**(`bytes`): `string` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/utils/common.ts:19](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/utils/common.ts#L19) 12 | 13 | Converts a Uint8Array to a hexadecimal string. 14 | 15 | ## Parameters 16 | 17 | ### bytes 18 | 19 | `Uint8Array` 20 | 21 | The input array of bytes. 22 | 23 | ## Returns 24 | 25 | `string` 26 | 27 | The hexadecimal representation of the input bytes. 28 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/functions/within.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / within 6 | 7 | # Function: within() 8 | 9 | > **within**(`value`, `lower`, `upper`): `boolean` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/fns/math.ts:36](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/fns/math.ts#L36) 12 | 13 | Checks whether a Int32 value is strictly between two other Int32 values. 14 | 15 | ## Parameters 16 | 17 | ### value 18 | 19 | [`Int32`](../type-aliases/Int32.md) 20 | 21 | The Int32 value to check 22 | 23 | ### lower 24 | 25 | [`Int32`](../type-aliases/Int32.md) 26 | 27 | The lower bound (exclusive) 28 | 29 | ### upper 30 | 31 | [`Int32`](../type-aliases/Int32.md) 32 | 33 | The upper bound (exclusive) 34 | 35 | ## Returns 36 | 37 | `boolean` 38 | 39 | True if value is strictly between lower and upper, otherwise false. 40 | 41 | ## Onchain 42 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/Addr.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / Addr 6 | 7 | # Type Alias: Addr 8 | 9 | > **Addr**: [`PubKeyHash`](PubKeyHash.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:147](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L147) 12 | 13 | A domain specific subtype of `ByteString`, representing an address. 14 | 15 | ## Onchain 16 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/BacktraceInfo.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / BacktraceInfo 6 | 7 | # Type Alias: BacktraceInfo 8 | 9 | > **BacktraceInfo**: `object` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/structs.ts:284](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/structs.ts#L284) 12 | 13 | Used for contract traceability to ensure that the spent contract comes from a unique outpoint 14 | 15 | ## Type declaration 16 | 17 | ### prevPrevTxPreimage 18 | 19 | > **prevPrevTxPreimage**: [`CompactTxHashPreimage`](CompactTxHashPreimage.md) 20 | 21 | ### prevTxInput 22 | 23 | > **prevTxInput**: [`TxIn`](TxIn.md) 24 | 25 | ### prevTxInputIndexVal 26 | 27 | > **prevTxInputIndexVal**: [`Int32`](Int32.md) 28 | 29 | ## Onchain 30 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/Bool.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / Bool 6 | 7 | # Type Alias: Bool 8 | 9 | > **Bool**: `Flavor`\<`boolean`, `"bool"`\> 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:23](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L23) 12 | 13 | A Bool represents a boolean. A simple value true or false. 14 | 15 | ## Onchain 16 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/ByteString.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / ByteString 6 | 7 | # Type Alias: ByteString 8 | 9 | > **ByteString**: `Flavor`\<`string`, `"bytes"`\> 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:9](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L9) 12 | 13 | A ByteString represents a byte array in hex format. 14 | 15 | ## Onchain 16 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/ChainTxVerifyResponse.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / ChainTxVerifyResponse 6 | 7 | # Type Alias: ChainTxVerifyResponse 8 | 9 | > **ChainTxVerifyResponse**: `object` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/builtin-libs/backtrace.ts:10](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/builtin-libs/backtrace.ts#L10) 12 | 13 | ## Type declaration 14 | 15 | ### prevPrevOutpoint 16 | 17 | > **prevPrevOutpoint**: [`ByteString`](ByteString.md) 18 | 19 | ### prevPrevScript 20 | 21 | > **prevPrevScript**: [`ByteString`](ByteString.md) 22 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/InputStateProof.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / InputStateProof 6 | 7 | # Type Alias: InputStateProof 8 | 9 | > **InputStateProof**: `object` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/structs.ts:252](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/structs.ts#L252) 12 | 13 | A structure used to verify the contract state contained in the input 14 | 15 | ## Type declaration 16 | 17 | ### outputIndexVal 18 | 19 | > **outputIndexVal**: [`Int32`](Int32.md) 20 | 21 | ### stateHashes 22 | 23 | > **stateHashes**: [`StateHashes`](StateHashes.md) 24 | 25 | ### txHashPreimage 26 | 27 | > **txHashPreimage**: [`HashRootTxHashPreimage`](HashRootTxHashPreimage.md) 28 | 29 | ## Onchain 30 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/InputStateProofs.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / InputStateProofs 6 | 7 | # Type Alias: InputStateProofs 8 | 9 | > **InputStateProofs**: [`FixedArray`](FixedArray.md)\<[`InputStateProof`](InputStateProof.md), *typeof* `TX_INPUT_COUNT_MAX`\> 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/structs.ts:277](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/structs.ts#L277) 12 | 13 | A array representing all input state proofs 14 | 15 | ## Onchain 16 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/Int32.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / Int32 6 | 7 | # Type Alias: Int32 8 | 9 | > **Int32**: `Flavor`\<`bigint`, `"int"`\> 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:16](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L16) 12 | 13 | A Int32 represents a number. 14 | 15 | ## Onchain 16 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/OpCodeType.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / OpCodeType 6 | 7 | # Type Alias: OpCodeType 8 | 9 | > **OpCodeType**: [`ByteString`](ByteString.md) & `object` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:233](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L233) 12 | 13 | A domain specific subtype of `ByteString`, representing a Script word. 14 | 15 | ## Type declaration 16 | 17 | ### \_\_type 18 | 19 | > **\_\_type**: `"OpCodeType"` 20 | 21 | ## Onchain 22 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/Outpoint.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / Outpoint 6 | 7 | # Type Alias: Outpoint 8 | 9 | > **Outpoint**: `object` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/structs.ts:14](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/structs.ts#L14) 12 | 13 | The structure used to refer to a particular transaction output 14 | 15 | ## Type declaration 16 | 17 | ### outputIndex 18 | 19 | > **outputIndex**: [`ByteString`](ByteString.md) 20 | 21 | The index of the output in the transaction. 22 | 23 | ### txHash 24 | 25 | > **txHash**: [`ByteString`](ByteString.md) 26 | 27 | The transaction hash, which is the reverse order of bytes of the `txId`. 28 | 29 | ## Onchain 30 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/Prevouts.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / Prevouts 6 | 7 | # Type Alias: Prevouts 8 | 9 | > **Prevouts**: [`FixedArray`](FixedArray.md)\<[`ByteString`](ByteString.md), *typeof* `TX_INPUT_COUNT_MAX`\> 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/structs.ts:157](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/structs.ts#L157) 12 | 13 | An array refers to the outputs from previous transactions that are being spent as inputs in the current transaction. 14 | 15 | ## Onchain 16 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/PrivKey.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / PrivKey 6 | 7 | # Type Alias: PrivKey 8 | 9 | > **PrivKey**: [`Int32`](Int32.md) & `object` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:39](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L39) 12 | 13 | A domain specific subtype of `Int32`, representing a private key. 14 | 15 | ## Type declaration 16 | 17 | ### \_\_type 18 | 19 | > **\_\_type**: `"PrivKey"` 20 | 21 | ## Onchain 22 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/PubKey.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / PubKey 6 | 7 | # Type Alias: PubKey 8 | 9 | > **PubKey**: [`ByteString`](ByteString.md) & `object` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:56](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L56) 12 | 13 | A domain specific subtype of `ByteString`, representing a public key. 14 | 15 | ## Type declaration 16 | 17 | ### \_\_type 18 | 19 | > **\_\_type**: `"PubKey"` 20 | 21 | ## Onchain 22 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/PubKeyHash.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / PubKeyHash 6 | 7 | # Type Alias: PubKeyHash 8 | 9 | > **PubKeyHash**: [`Ripemd160`](Ripemd160.md) 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:130](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L130) 12 | 13 | A domain specific subtype of `ByteString`, representing an address. 14 | 15 | ## Onchain 16 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/Ripemd160.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / Ripemd160 6 | 7 | # Type Alias: Ripemd160 8 | 9 | > **Ripemd160**: [`ByteString`](ByteString.md) & `object` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:113](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L113) 12 | 13 | A domain specific subtype of `ByteString`, representing a RIPEMD-160 hash. 14 | 15 | ## Type declaration 16 | 17 | ### \_\_type 18 | 19 | > **\_\_type**: `"Ripemd160"` 20 | 21 | ## Onchain 22 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/Sha1.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / Sha1 6 | 7 | # Type Alias: Sha1 8 | 9 | > **Sha1**: [`ByteString`](ByteString.md) & `object` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:164](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L164) 12 | 13 | A domain specific subtype of `ByteString`, representing a SHA-1 hash. 14 | 15 | ## Type declaration 16 | 17 | ### \_\_type 18 | 19 | > **\_\_type**: `"Sha1"` 20 | 21 | ## Onchain 22 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/Sha256.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / Sha256 6 | 7 | # Type Alias: Sha256 8 | 9 | > **Sha256**: [`ByteString`](ByteString.md) & `object` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:182](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L182) 12 | 13 | A domain specific subtype of `ByteString`, representing a SHA-256 hash. 14 | 15 | ## Type declaration 16 | 17 | ### \_\_type 18 | 19 | > **\_\_type**: `"Sha256"` 20 | 21 | ## Onchain 22 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/Sig.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / Sig 6 | 7 | # Type Alias: Sig 8 | 9 | > **Sig**: [`ByteString`](ByteString.md) & `object` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:96](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L96) 12 | 13 | A domain specific subtype of `ByteString`, representing a signature. 14 | 15 | ## Type declaration 16 | 17 | ### \_\_type 18 | 19 | > **\_\_type**: `"Sig"` 20 | 21 | ## Onchain 22 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/SpentAmounts.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / SpentAmounts 6 | 7 | # Type Alias: SpentAmounts 8 | 9 | > **SpentAmounts**: [`FixedArray`](FixedArray.md)\<[`ByteString`](ByteString.md), *typeof* `TX_INPUT_COUNT_MAX`\> 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/structs.ts:175](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/structs.ts#L175) 12 | 13 | The context of the spent amounts. 14 | spentAmounts is an array of the spent amounts, that is the amount of the previous output. [spentAmount1, spentAmount2, ...], length is MAX_INPUT. The rest is empty ByteString if inputs are less than MAX_INPUT. 15 | each non-empty element is a ByteString of 8 bytes, which is the amount of the previous output. 16 | 17 | ## Onchain 18 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/SpentScripts.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / SpentScripts 6 | 7 | # Type Alias: SpentScripts 8 | 9 | > **SpentScripts**: [`FixedArray`](FixedArray.md)\<[`ByteString`](ByteString.md), *typeof* `TX_INPUT_COUNT_MAX`\> 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/structs.ts:166](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/structs.ts#L166) 12 | 13 | The context of the spent scripts. 14 | spentScripts is an array of the spent scripts, that is the script of the previous output. [spentScript1, spentScript2, ...], length is MAX_INPUT. The rest is empty ByteString if inputs are less than MAX_INPUT. 15 | each non-empty element is a ByteString, which is the script of the previous output. 16 | 17 | ## Onchain 18 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/StateHashes.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / StateHashes 6 | 7 | # Type Alias: StateHashes 8 | 9 | > **StateHashes**: [`FixedArray`](FixedArray.md)\<[`ByteString`](ByteString.md), *typeof* `STATE_OUTPUT_COUNT_MAX`\> 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/structs.ts:245](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/structs.ts#L245) 12 | 13 | An array of hashes representing the states of all stateful covenants included in the transaction. 14 | A transaction output can contain up to 5 stateful covenants. 15 | 16 | ## Onchain 17 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/StatefulCovenantUtxo.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / StatefulCovenantUtxo 6 | 7 | # Type Alias: StatefulCovenantUtxo 8 | 9 | > **StatefulCovenantUtxo**: `StateProvableUtxo` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/covenant.ts:34](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/covenant.ts#L34) 12 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/SupportedNetwork.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / SupportedNetwork 6 | 7 | # Type Alias: SupportedNetwork 8 | 9 | > **SupportedNetwork**: `"btc-signet"` \| `"fractal-mainnet"` \| `"fractal-testnet"` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/globalTypes.ts:22](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/globalTypes.ts#L22) 12 | 13 | All Networks Supported by the SDK 14 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/TxIn.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / TxIn 6 | 7 | # Type Alias: TxIn 8 | 9 | > **TxIn**: `object` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/structs.ts:41](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/structs.ts#L41) 12 | 13 | A structure representing the transaction input, excluding witnesses 14 | 15 | ## Type declaration 16 | 17 | ### prevOutputIndexVal 18 | 19 | > **prevOutputIndexVal**: [`Int32`](Int32.md) 20 | 21 | ### prevTxHash 22 | 23 | > **prevTxHash**: [`ByteString`](ByteString.md) 24 | 25 | ### sequence 26 | 27 | > **sequence**: [`ByteString`](ByteString.md) 28 | 29 | ## Onchain 30 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/TxOut.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / TxOut 6 | 7 | # Type Alias: TxOut 8 | 9 | > **TxOut**: `object` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/structs.ts:31](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/structs.ts#L31) 12 | 13 | A structure representing a transaction output 14 | 15 | ## Type declaration 16 | 17 | ### satoshis 18 | 19 | > **satoshis**: [`ByteString`](ByteString.md) 20 | 21 | ### script 22 | 23 | > **script**: [`ByteString`](ByteString.md) 24 | 25 | ## Onchain 26 | -------------------------------------------------------------------------------- /btc-docs/references/sdk/type-aliases/XOnlyPubKey.md: -------------------------------------------------------------------------------- 1 | [**bitcoinjs-lib v0.2.9-beta.16**](../README.md) 2 | 3 | *** 4 | 5 | [bitcoinjs-lib](../README.md) / XOnlyPubKey 6 | 7 | # Type Alias: XOnlyPubKey 8 | 9 | > **XOnlyPubKey**: [`ByteString`](ByteString.md) & `object` 10 | 11 | Defined in: [packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts:73](https://github.com/sCrypt-Inc/scrypt-btc-mono/blob/7d2760b2d3565565fcb011792878d3764e0701be/packages/scrypt-ts-btc/src/smart-contract/types/primitives.ts#L73) 12 | 13 | A domain specific subtype of `ByteString`, representing an x-only public key. 14 | 15 | ## Type declaration 16 | 17 | ### \_\_type 18 | 19 | > **\_\_type**: `"XOnlyPubKey"` 20 | 21 | ## Onchain 22 | -------------------------------------------------------------------------------- /btc-docs/sidebars.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Creating a sidebar enables you to: 3 | - create an ordered group of docs 4 | - render a sidebar for each doc of that group 5 | - provide next/previous navigation 6 | 7 | The sidebars can be generated from the filesystem, or explicitly defined here. 8 | 9 | Create as many sidebars as you want. 10 | */ 11 | 12 | // @ts-check 13 | 14 | /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ 15 | const sidebars = { 16 | btcDocsSidebar: [{type: 'autogenerated', dirName: '.'}], 17 | }; 18 | 19 | module.exports = sidebars; 20 | -------------------------------------------------------------------------------- /btc-docs/tutorials/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "position": 15, 3 | "label": "Tutorials", 4 | "collapsible": true, 5 | "collapsed": false, 6 | "link": { 7 | "type": "generated-index", 8 | "title": "Tutorials" 9 | } 10 | } -------------------------------------------------------------------------------- /docs/advanced/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "position": 13, 3 | "label": "Advanced", 4 | "collapsible": true, 5 | "collapsed": true, 6 | "link": { 7 | "type": "generated-index", 8 | "title": "Advanced" 9 | } 10 | } -------------------------------------------------------------------------------- /docs/bitcoin-basics/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "position": 3, 3 | "label": "Bitcoin Basics", 4 | "collapsible": true, 5 | "collapsed": true 6 | } -------------------------------------------------------------------------------- /docs/how-to-deploy-and-call-a-contract/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "position": 4, 3 | "label": "How to Deploy & Call a Contract", 4 | "collapsible": true, 5 | "collapsed": true 6 | } -------------------------------------------------------------------------------- /docs/how-to-write-a-contract/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "position": 3, 3 | "label": "How to Write a Contract", 4 | "collapsible": true, 5 | "collapsed": true 6 | } -------------------------------------------------------------------------------- /docs/reference/.nojekyll: -------------------------------------------------------------------------------- 1 | TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. -------------------------------------------------------------------------------- /docs/reference/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "position": 16, 3 | "label": "Reference", 4 | "collapsible": true, 5 | "collapsed": true 6 | } -------------------------------------------------------------------------------- /docs/reference/classes/SmartContractLib.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / SmartContractLib 2 | 3 | # Class: SmartContractLib 4 | 5 | The contract library class. To write a contract library, extend this class as such: 6 | 7 | **`Example`** 8 | 9 | ```ts 10 | class YourSmartContractLib extends SmartContractLib { 11 | // your library functions code here 12 | } 13 | ``` 14 | 15 | ## Table of contents 16 | 17 | ### Constructors 18 | 19 | - [constructor](SmartContractLib.md#constructor) 20 | 21 | ### Properties 22 | 23 | - [args](SmartContractLib.md#args) 24 | 25 | ## Constructors 26 | 27 | ### constructor 28 | 29 | • **new SmartContractLib**(`...args`) 30 | 31 | #### Parameters 32 | 33 | | Name | Type | 34 | | :------ | :------ | 35 | | `...args` | `any`[] | 36 | 37 | #### Defined in 38 | 39 | dist/smart-contract/library.d.ts:15 40 | 41 | ## Properties 42 | 43 | ### args 44 | 45 | • **args**: `any`[] 46 | 47 | #### Defined in 48 | 49 | dist/smart-contract/library.d.ts:14 50 | -------------------------------------------------------------------------------- /docs/reference/classes/bsv.encoding.Base58.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / [bsv](../modules/bsv.md) / [encoding](../modules/bsv.encoding.md) / Base58 2 | 3 | # Class: Base58 4 | 5 | [bsv](../modules/bsv.md).[encoding](../modules/bsv.encoding.md).Base58 6 | 7 | ## Table of contents 8 | 9 | ### Constructors 10 | 11 | - [constructor](bsv.encoding.Base58.md#constructor) 12 | 13 | ## Constructors 14 | 15 | ### constructor 16 | 17 | • **new Base58**() 18 | -------------------------------------------------------------------------------- /docs/reference/classes/bsv.encoding.Base58Check.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / [bsv](../modules/bsv.md) / [encoding](../modules/bsv.encoding.md) / Base58Check 2 | 3 | # Class: Base58Check 4 | 5 | [bsv](../modules/bsv.md).[encoding](../modules/bsv.encoding.md).Base58Check 6 | 7 | ## Table of contents 8 | 9 | ### Constructors 10 | 11 | - [constructor](bsv.encoding.Base58Check.md#constructor) 12 | 13 | ## Constructors 14 | 15 | ### constructor 16 | 17 | • **new Base58Check**() 18 | -------------------------------------------------------------------------------- /docs/reference/classes/bsv.encoding.Varint.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / [bsv](../modules/bsv.md) / [encoding](../modules/bsv.encoding.md) / Varint 2 | 3 | # Class: Varint 4 | 5 | [bsv](../modules/bsv.md).[encoding](../modules/bsv.encoding.md).Varint 6 | 7 | ## Table of contents 8 | 9 | ### Constructors 10 | 11 | - [constructor](bsv.encoding.Varint.md#constructor) 12 | 13 | ## Constructors 14 | 15 | ### constructor 16 | 17 | • **new Varint**() 18 | -------------------------------------------------------------------------------- /docs/reference/enums/ProviderEvent.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / ProviderEvent 2 | 3 | # Enumeration: ProviderEvent 4 | 5 | The provider is an EventEmitter, and the following are all the events it can emit. 6 | https://stackoverflow.com/a/50511773 7 | 8 | ## Table of contents 9 | 10 | ### Enumeration Members 11 | 12 | - [Connected](ProviderEvent.md#connected) 13 | - [NetworkChange](ProviderEvent.md#networkchange) 14 | 15 | ## Enumeration Members 16 | 17 | ### Connected 18 | 19 | • **Connected** = ``"connected"`` 20 | 21 | The provider will send a 'Connected' event after the connection is successful. 22 | 23 | #### Defined in 24 | 25 | dist/bsv/abstract-provider.d.ts:24 26 | 27 | ___ 28 | 29 | ### NetworkChange 30 | 31 | • **NetworkChange** = ``"networkChange"`` 32 | 33 | After the network connected to the provider changes, it will issue the 'NetworkChange' event, such as switching from the testnet to the mainnet. 34 | 35 | #### Defined in 36 | 37 | dist/bsv/abstract-provider.d.ts:26 38 | -------------------------------------------------------------------------------- /docs/reference/interfaces/LogConfig.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / LogConfig 2 | 3 | # Interface: LogConfig 4 | 5 | ## Hierarchy 6 | 7 | - **`LogConfig`** 8 | 9 | ↳ [`ScryptConfig`](ScryptConfig.md) 10 | 11 | ## Table of contents 12 | 13 | ### Properties 14 | 15 | - [logLevel](LogConfig.md#loglevel) 16 | 17 | ## Properties 18 | 19 | ### logLevel 20 | 21 | • `Optional` **logLevel**: [`LogLevel`](../README.md#loglevel) 22 | 23 | #### Defined in 24 | 25 | dist/client/core/logger-controller.d.ts:4 26 | -------------------------------------------------------------------------------- /docs/reference/interfaces/Outpoint.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / Outpoint 2 | 3 | # Interface: Outpoint 4 | 5 | The structure used to refer to a particular transaction output 6 | 7 | ## Table of contents 8 | 9 | ### Properties 10 | 11 | - [outputIndex](Outpoint.md#outputindex) 12 | - [txid](Outpoint.md#txid) 13 | 14 | ## Properties 15 | 16 | ### outputIndex 17 | 18 | • **outputIndex**: `bigint` 19 | 20 | index of the specific output 21 | 22 | #### Defined in 23 | 24 | dist/smart-contract/contract.d.ts:35 25 | 26 | ___ 27 | 28 | ### txid 29 | 30 | • **txid**: [`ByteString`](../README.md#bytestring) 31 | 32 | txid of the transaction holding the output 33 | 34 | #### Defined in 35 | 36 | dist/smart-contract/contract.d.ts:33 37 | -------------------------------------------------------------------------------- /docs/reference/interfaces/SignTransactionOptions.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / SignTransactionOptions 2 | 3 | # Interface: SignTransactionOptions 4 | 5 | `SignTransactionOptions` is the options can be provided when signing a transaction. 6 | 7 | ## Table of contents 8 | 9 | ### Properties 10 | 11 | - [address](SignTransactionOptions.md#address) 12 | - [sigRequests](SignTransactionOptions.md#sigrequests) 13 | 14 | ## Properties 15 | 16 | ### address 17 | 18 | • `Optional` **address**: [`AddressesOption`](../README.md#addressesoption) 19 | 20 | The address(es) whose corresponding private key(s) should be used to sign the tx. 21 | 22 | #### Defined in 23 | 24 | dist/bsv/abstract-signer.d.ts:50 25 | 26 | ___ 27 | 28 | ### sigRequests 29 | 30 | • `Optional` **sigRequests**: [`SignatureRequest`](SignatureRequest.md)[] 31 | 32 | The `SignatureRequest` for the some inputs of the transaction. 33 | 34 | #### Defined in 35 | 36 | dist/bsv/abstract-signer.d.ts:48 37 | -------------------------------------------------------------------------------- /docs/reference/interfaces/SubScription.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / SubScription 2 | 3 | # Interface: SubScription 4 | 5 | SubScription can be used to unsubscribe 6 | 7 | ## Table of contents 8 | 9 | ### Properties 10 | 11 | - [unsubscribe](SubScription.md#unsubscribe) 12 | 13 | ## Properties 14 | 15 | ### unsubscribe 16 | 17 | • **unsubscribe**: () => `void` 18 | 19 | #### Type declaration 20 | 21 | ▸ (): `void` 22 | 23 | ##### Returns 24 | 25 | `void` 26 | 27 | #### Defined in 28 | 29 | dist/client/apis/contract-api.d.ts:16 30 | -------------------------------------------------------------------------------- /docs/reference/interfaces/TxInputRef.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / TxInputRef 2 | 3 | # Interface: TxInputRef 4 | 5 | A reference to an input of a transaction 6 | 7 | ## Table of contents 8 | 9 | ### Properties 10 | 11 | - [inputIndex](TxInputRef.md#inputindex) 12 | - [tx](TxInputRef.md#tx) 13 | 14 | ## Properties 15 | 16 | ### inputIndex 17 | 18 | • **inputIndex**: `number` 19 | 20 | an index indicating the position of inputs in this transaction 21 | 22 | #### Defined in 23 | 24 | dist/smart-contract/contract.d.ts:17 25 | 26 | ___ 27 | 28 | ### tx 29 | 30 | • **tx**: [`Transaction`](../classes/bsv.Transaction-1.md) 31 | 32 | transaction object 33 | 34 | #### Defined in 35 | 36 | dist/smart-contract/contract.d.ts:15 37 | -------------------------------------------------------------------------------- /docs/reference/interfaces/TxOutputRef.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / TxOutputRef 2 | 3 | # Interface: TxOutputRef 4 | 5 | A reference to an output of a transaction 6 | 7 | ## Table of contents 8 | 9 | ### Properties 10 | 11 | - [outputIndex](TxOutputRef.md#outputindex) 12 | - [tx](TxOutputRef.md#tx) 13 | 14 | ## Properties 15 | 16 | ### outputIndex 17 | 18 | • **outputIndex**: `number` 19 | 20 | index of an output in this transaction 21 | 22 | #### Defined in 23 | 24 | dist/smart-contract/contract.d.ts:25 25 | 26 | ___ 27 | 28 | ### tx 29 | 30 | • **tx**: [`Transaction`](../classes/bsv.Transaction-1.md) 31 | 32 | transaction object 33 | 34 | #### Defined in 35 | 36 | dist/smart-contract/contract.d.ts:23 37 | -------------------------------------------------------------------------------- /docs/reference/interfaces/VerifyResult.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / VerifyResult 2 | 3 | # Interface: VerifyResult 4 | 5 | ## Table of contents 6 | 7 | ### Properties 8 | 9 | - [error](VerifyResult.md#error) 10 | - [success](VerifyResult.md#success) 11 | 12 | ## Properties 13 | 14 | ### error 15 | 16 | • `Optional` **error**: `string` 17 | 18 | #### Defined in 19 | 20 | node_modules/scryptlib/dist/contract.d.ts:26 21 | 22 | ___ 23 | 24 | ### success 25 | 26 | • **success**: `boolean` 27 | 28 | #### Defined in 29 | 30 | node_modules/scryptlib/dist/contract.d.ts:25 31 | -------------------------------------------------------------------------------- /docs/reference/interfaces/bsv.Networks.Network.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / [bsv](../modules/bsv.md) / [Networks](../modules/bsv.Networks.md) / Network 2 | 3 | # Interface: Network 4 | 5 | [bsv](../modules/bsv.md).[Networks](../modules/bsv.Networks.md).Network 6 | 7 | ## Table of contents 8 | 9 | ### Properties 10 | 11 | - [alias](bsv.Networks.Network.md#alias) 12 | - [name](bsv.Networks.Network.md#name) 13 | 14 | ## Properties 15 | 16 | ### alias 17 | 18 | • `Readonly` **alias**: `string` 19 | 20 | #### Defined in 21 | 22 | node_modules/bsv/index.d.ts:1378 23 | 24 | ___ 25 | 26 | ### name 27 | 28 | • `Readonly` **name**: `string` 29 | 30 | #### Defined in 31 | 32 | node_modules/bsv/index.d.ts:1377 33 | -------------------------------------------------------------------------------- /docs/reference/interfaces/bsv.Script.IOpChunk.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / [bsv](../modules/bsv.md) / [Script](../modules/bsv.Script.md) / IOpChunk 2 | 3 | # Interface: IOpChunk 4 | 5 | [bsv](../modules/bsv.md).[Script](../modules/bsv.Script.md).IOpChunk 6 | 7 | ## Table of contents 8 | 9 | ### Properties 10 | 11 | - [buf](bsv.Script.IOpChunk.md#buf) 12 | - [len](bsv.Script.IOpChunk.md#len) 13 | - [opcodenum](bsv.Script.IOpChunk.md#opcodenum) 14 | 15 | ## Properties 16 | 17 | ### buf 18 | 19 | • **buf**: `Buffer` 20 | 21 | #### Defined in 22 | 23 | node_modules/bsv/index.d.ts:1213 24 | 25 | ___ 26 | 27 | ### len 28 | 29 | • **len**: `number` 30 | 31 | #### Defined in 32 | 33 | node_modules/bsv/index.d.ts:1214 34 | 35 | ___ 36 | 37 | ### opcodenum 38 | 39 | • **opcodenum**: `number` 40 | 41 | #### Defined in 42 | 43 | node_modules/bsv/index.d.ts:1215 44 | -------------------------------------------------------------------------------- /docs/reference/interfaces/bsv.Script.Interpreter.InterpretState.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / [bsv](../modules/bsv.md) / [Script](../modules/bsv.Script.md) / [Interpreter](../modules/bsv.Script.Interpreter.md) / InterpretState 2 | 3 | # Interface: InterpretState 4 | 5 | [Script](../modules/bsv.Script.md).[Interpreter](../modules/bsv.Script.Interpreter.md).InterpretState 6 | 7 | ## Table of contents 8 | 9 | ### Properties 10 | 11 | - [altstack](bsv.Script.Interpreter.InterpretState.md#altstack) 12 | - [mainstack](bsv.Script.Interpreter.InterpretState.md#mainstack) 13 | - [step](bsv.Script.Interpreter.InterpretState.md#step) 14 | 15 | ## Properties 16 | 17 | ### altstack 18 | 19 | • **altstack**: `any` 20 | 21 | #### Defined in 22 | 23 | node_modules/bsv/index.d.ts:1266 24 | 25 | ___ 26 | 27 | ### mainstack 28 | 29 | • **mainstack**: `any` 30 | 31 | #### Defined in 32 | 33 | node_modules/bsv/index.d.ts:1265 34 | 35 | ___ 36 | 37 | ### step 38 | 39 | • **step**: `any` 40 | 41 | #### Defined in 42 | 43 | node_modules/bsv/index.d.ts:1264 44 | -------------------------------------------------------------------------------- /docs/reference/interfaces/bsv.Util.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / [bsv](../modules/bsv.md) / Util 2 | 3 | # Interface: Util 4 | 5 | [bsv](../modules/bsv.md).Util 6 | 7 | ## Table of contents 8 | 9 | ### Properties 10 | 11 | - [buffer](bsv.Util.md#buffer) 12 | 13 | ## Properties 14 | 15 | ### buffer 16 | 17 | • `Readonly` **buffer**: `Object` 18 | 19 | #### Type declaration 20 | 21 | | Name | Type | 22 | | :------ | :------ | 23 | | `reverse` | (`a`: `any`) => `any` | 24 | 25 | #### Defined in 26 | 27 | node_modules/bsv/index.d.ts:1370 28 | -------------------------------------------------------------------------------- /docs/reference/interfaces/bsv.crypto.IOpts.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / [bsv](../modules/bsv.md) / [crypto](../modules/bsv.crypto.md) / IOpts 2 | 3 | # Interface: IOpts 4 | 5 | [bsv](../modules/bsv.md).[crypto](../modules/bsv.crypto.md).IOpts 6 | 7 | ## Table of contents 8 | 9 | ### Properties 10 | 11 | - [endian](bsv.crypto.IOpts.md#endian) 12 | - [size](bsv.crypto.IOpts.md#size) 13 | 14 | ## Properties 15 | 16 | ### endian 17 | 18 | • **endian**: ``"big"`` \| ``"little"`` 19 | 20 | #### Defined in 21 | 22 | node_modules/bsv/index.d.ts:651 23 | 24 | ___ 25 | 26 | ### size 27 | 28 | • `Optional` **size**: `number` 29 | 30 | #### Defined in 31 | 32 | node_modules/bsv/index.d.ts:652 33 | -------------------------------------------------------------------------------- /docs/reference/modules/bsv.Script.Interpreter.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / [bsv](bsv.md) / [Script](bsv.Script.md) / Interpreter 2 | 3 | # Namespace: Interpreter 4 | 5 | [bsv](bsv.md).[Script](bsv.Script.md).Interpreter 6 | 7 | ## Table of contents 8 | 9 | ### Interfaces 10 | 11 | - [InterpretState](../interfaces/bsv.Script.Interpreter.InterpretState.md) 12 | 13 | ### Type Aliases 14 | 15 | - [StepListenerFunction](bsv.Script.Interpreter.md#steplistenerfunction) 16 | 17 | ## Type Aliases 18 | 19 | ### StepListenerFunction 20 | 21 | Ƭ **StepListenerFunction**: (`step`: `any`, `stack`: `any`[], `altstack`: `any`[]) => `void` 22 | 23 | #### Type declaration 24 | 25 | ▸ (`step`, `stack`, `altstack`): `void` 26 | 27 | ##### Parameters 28 | 29 | | Name | Type | 30 | | :------ | :------ | 31 | | `step` | `any` | 32 | | `stack` | `any`[] | 33 | | `altstack` | `any`[] | 34 | 35 | ##### Returns 36 | 37 | `void` 38 | 39 | #### Defined in 40 | 41 | node_modules/bsv/index.d.ts:1268 42 | -------------------------------------------------------------------------------- /docs/reference/modules/bsv.Transaction.Input.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / [bsv](bsv.md) / [Transaction](bsv.Transaction.md) / Input 2 | 3 | # Namespace: Input 4 | 5 | [bsv](bsv.md).[Transaction](bsv.Transaction.md).Input 6 | 7 | ## Table of contents 8 | 9 | ### Classes 10 | 11 | - [PublicKeyHash](../classes/bsv.Transaction.Input.PublicKeyHash.md) 12 | -------------------------------------------------------------------------------- /docs/reference/modules/bsv.Transaction.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / [bsv](bsv.md) / Transaction 2 | 3 | # Namespace: Transaction 4 | 5 | [bsv](bsv.md).Transaction 6 | 7 | ## Table of contents 8 | 9 | ### Namespaces 10 | 11 | - [Input](bsv.Transaction.Input.md) 12 | - [Sighash](bsv.Transaction.Sighash.md) 13 | 14 | ### Classes 15 | 16 | - [Input](../classes/bsv.Transaction.Input-1.md) 17 | - [Output](../classes/bsv.Transaction.Output.md) 18 | - [Signature](../classes/bsv.Transaction.Signature.md) 19 | - [UnspentOutput](../classes/bsv.Transaction.UnspentOutput.md) 20 | 21 | ### Interfaces 22 | 23 | - [IUnspentOutput](../interfaces/bsv.Transaction.IUnspentOutput.md) 24 | -------------------------------------------------------------------------------- /docs/reference/modules/bsv.crypto.Random.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / [bsv](bsv.md) / [crypto](bsv.crypto.md) / Random 2 | 3 | # Namespace: Random 4 | 5 | [bsv](bsv.md).[crypto](bsv.crypto.md).Random 6 | 7 | ## Table of contents 8 | 9 | ### Functions 10 | 11 | - [getRandomBuffer](bsv.crypto.Random.md#getrandombuffer) 12 | 13 | ## Functions 14 | 15 | ### getRandomBuffer 16 | 17 | ▸ **getRandomBuffer**(`size`): `Buffer` 18 | 19 | #### Parameters 20 | 21 | | Name | Type | 22 | | :------ | :------ | 23 | | `size` | `number` | 24 | 25 | #### Returns 26 | 27 | `Buffer` 28 | 29 | #### Defined in 30 | 31 | node_modules/bsv/index.d.ts:752 32 | -------------------------------------------------------------------------------- /docs/reference/modules/bsv.crypto.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / [bsv](bsv.md) / crypto 2 | 3 | # Namespace: crypto 4 | 5 | [bsv](bsv.md).crypto 6 | 7 | ## Table of contents 8 | 9 | ### Namespaces 10 | 11 | - [ECDSA](bsv.crypto.ECDSA.md) 12 | - [Hash](bsv.crypto.Hash.md) 13 | - [Random](bsv.crypto.Random.md) 14 | 15 | ### Classes 16 | 17 | - [BN](../classes/bsv.crypto.BN.md) 18 | - [Point](../classes/bsv.crypto.Point.md) 19 | - [Signature](../classes/bsv.crypto.Signature.md) 20 | 21 | ### Interfaces 22 | 23 | - [IOpts](../interfaces/bsv.crypto.IOpts.md) 24 | 25 | ### Type Aliases 26 | 27 | - [Endianness](bsv.crypto.md#endianness) 28 | 29 | ## Type Aliases 30 | 31 | ### Endianness 32 | 33 | Ƭ **Endianness**: ``"le"`` \| ``"be"`` 34 | 35 | #### Defined in 36 | 37 | node_modules/bsv/index.d.ts:655 38 | -------------------------------------------------------------------------------- /docs/reference/modules/bsv.encoding.md: -------------------------------------------------------------------------------- 1 | [scrypt-ts](../README.md) / [bsv](bsv.md) / encoding 2 | 3 | # Namespace: encoding 4 | 5 | [bsv](bsv.md).encoding 6 | 7 | ## Table of contents 8 | 9 | ### Classes 10 | 11 | - [Base58](../classes/bsv.encoding.Base58.md) 12 | - [Base58Check](../classes/bsv.encoding.Base58Check.md) 13 | - [BufferReader](../classes/bsv.encoding.BufferReader.md) 14 | - [BufferWriter](../classes/bsv.encoding.BufferWriter.md) 15 | - [Varint](../classes/bsv.encoding.Varint.md) 16 | -------------------------------------------------------------------------------- /docs/sidebars.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Creating a sidebar enables you to: 3 | - create an ordered group of docs 4 | - render a sidebar for each doc of that group 5 | - provide next/previous navigation 6 | 7 | The sidebars can be generated from the filesystem, or explicitly defined here. 8 | 9 | Create as many sidebars as you want. 10 | */ 11 | 12 | // @ts-check 13 | 14 | /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ 15 | const sidebars = { 16 | // By default, Docusaurus generates a sidebar from the docs folder structure 17 | tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], 18 | 19 | // But you can create a sidebar manually 20 | // tutorialSidebar: [ 21 | // { 22 | // type: 'doc', 23 | // label: 'Overview', 24 | // id: 'overview' 25 | // }, 26 | // { 27 | // type: 'category', 28 | // label: 'Tutorials', 29 | // items: ['Tutorials/hello-world'], 30 | // }, 31 | 32 | // ], 33 | }; 34 | 35 | module.exports = sidebars; 36 | -------------------------------------------------------------------------------- /docs/tokens/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "position": 14, 3 | "label": "Tokens", 4 | "collapsible": true, 5 | "collapsed": true 6 | } -------------------------------------------------------------------------------- /docs/tokens/tutorials/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "position": 3, 3 | "label": "Tutorials", 4 | "collapsible": true, 5 | "collapsed": false, 6 | "link": { 7 | "type": "generated-index", 8 | "title": "Tutorials" 9 | } 10 | } -------------------------------------------------------------------------------- /docs/tutorials/_category_.json: -------------------------------------------------------------------------------- 1 | { 2 | "position": 15, 3 | "label": "Tutorials", 4 | "collapsible": true, 5 | "collapsed": false, 6 | "link": { 7 | "type": "generated-index", 8 | "title": "Tutorials" 9 | } 10 | } -------------------------------------------------------------------------------- /open-api/btc-blockchain/sidebar.js: -------------------------------------------------------------------------------- 1 | module.exports = [{"type":"doc","id":"btc-blockchain/introduction"},{"type":"category","label":"Transactions","items":[{"type":"doc","id":"btc-blockchain/get-transaction-summary","label":"Get Transaction Summary","className":"api-method get"}]},{"type":"category","label":"Addresses","items":[{"type":"doc","id":"btc-blockchain/get-address-balance","label":"Get Address Balance","className":"api-method get"},{"type":"doc","id":"btc-blockchain/get-address-utxo","label":"Get Address UTXO","className":"api-method get"},{"type":"doc","id":"btc-blockchain/get-address-transaction-history","label":"Get Address Transaction History","className":"api-method get"}]}]; -------------------------------------------------------------------------------- /open-api/overview.md: -------------------------------------------------------------------------------- 1 | --- 2 | slug: /overview 3 | id: open-api-overview 4 | sidebar_position: 0 5 | --- 6 | 7 | # API Overview 8 | 9 | Our open API uses an HTTP bearer token to authenticate. You can refer to this [doc](https://docs.scrypt.io/advanced/how-to-integrate-scrypt-service#get-an-api-key) to get an API key as the bearer token. 10 | 11 | ![](../static/img/open-api-auth.png) 12 | 13 | -------------------------------------------------------------------------------- /src/components/HomepageFeatures/styles.module.css: -------------------------------------------------------------------------------- 1 | .features { 2 | display: flex; 3 | align-items: center; 4 | padding: 2rem 0; 5 | width: 100%; 6 | } 7 | 8 | .featureSvg { 9 | height: 200px; 10 | width: 200px; 11 | } 12 | -------------------------------------------------------------------------------- /src/pages/overview.js: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import { Redirect } from '@docusaurus/router'; 3 | 4 | function Overview() { 5 | return ; 6 | } 7 | 8 | export default Overview; -------------------------------------------------------------------------------- /static/.nojekyll: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/.nojekyll -------------------------------------------------------------------------------- /static/CNAME: -------------------------------------------------------------------------------- 1 | docs.scrypt.io -------------------------------------------------------------------------------- /static/img/advanced-counter-call.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/advanced-counter-call.png -------------------------------------------------------------------------------- /static/img/api-keys.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/api-keys.png -------------------------------------------------------------------------------- /static/img/asm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/asm.png -------------------------------------------------------------------------------- /static/img/bsv20-plugin_1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/bsv20-plugin_1.png -------------------------------------------------------------------------------- /static/img/bsv20-plugin_2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/bsv20-plugin_2.png -------------------------------------------------------------------------------- /static/img/call.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/call.png -------------------------------------------------------------------------------- /static/img/checksig-failed.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/checksig-failed.png -------------------------------------------------------------------------------- /static/img/close.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/close.jpg -------------------------------------------------------------------------------- /static/img/contract-artifacts.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/contract-artifacts.png -------------------------------------------------------------------------------- /static/img/copy-contract-source.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/copy-contract-source.png -------------------------------------------------------------------------------- /static/img/counter-call.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/counter-call.png -------------------------------------------------------------------------------- /static/img/create-angular-app.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/create-angular-app.png -------------------------------------------------------------------------------- /static/img/create-next-app.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/create-next-app.png -------------------------------------------------------------------------------- /static/img/create-svelte-app.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/create-svelte-app.png -------------------------------------------------------------------------------- /static/img/create-vue2-vite-app.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/create-vue2-vite-app.png -------------------------------------------------------------------------------- /static/img/create-vue3-vite-app.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/create-vue3-vite-app.png -------------------------------------------------------------------------------- /static/img/create-webhook.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/create-webhook.png -------------------------------------------------------------------------------- /static/img/debug.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/debug.jpg -------------------------------------------------------------------------------- /static/img/debugging1.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/debugging1.gif -------------------------------------------------------------------------------- /static/img/debugging2.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/debugging2.gif -------------------------------------------------------------------------------- /static/img/decoded-inscribed-image.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/decoded-inscribed-image.png -------------------------------------------------------------------------------- /static/img/deploy-output.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/deploy-output.png -------------------------------------------------------------------------------- /static/img/diffoutputs-btc.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/diffoutputs-btc.png -------------------------------------------------------------------------------- /static/img/diffoutputs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/diffoutputs.png -------------------------------------------------------------------------------- /static/img/discord.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/discord.png -------------------------------------------------------------------------------- /static/img/docusaurus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/docusaurus.png -------------------------------------------------------------------------------- /static/img/dotwallet-auth.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/dotwallet-auth.png -------------------------------------------------------------------------------- /static/img/dotwallet-create-dapp.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/dotwallet-create-dapp.png -------------------------------------------------------------------------------- /static/img/dotwallet-mail.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/dotwallet-mail.png -------------------------------------------------------------------------------- /static/img/dotwallet-uris.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/dotwallet-uris.png -------------------------------------------------------------------------------- /static/img/email.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/email.png -------------------------------------------------------------------------------- /static/img/extract-sensilet-private-key.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/extract-sensilet-private-key.gif -------------------------------------------------------------------------------- /static/img/faucet.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/faucet.gif -------------------------------------------------------------------------------- /static/img/favicon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/favicon.png -------------------------------------------------------------------------------- /static/img/frontend-dependency.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/frontend-dependency.png -------------------------------------------------------------------------------- /static/img/gh-pages.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/gh-pages.png -------------------------------------------------------------------------------- /static/img/github.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/github.png -------------------------------------------------------------------------------- /static/img/hello-world-contract-call-tx-btc.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/hello-world-contract-call-tx-btc.png -------------------------------------------------------------------------------- /static/img/hello-world-contract-call-tx.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/hello-world-contract-call-tx.png -------------------------------------------------------------------------------- /static/img/hello-world-contract-deploy-tx-btc.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/hello-world-contract-deploy-tx-btc.png -------------------------------------------------------------------------------- /static/img/hello-world-contract-deploy-tx.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/hello-world-contract-deploy-tx.png -------------------------------------------------------------------------------- /static/img/hello-world-deploy-and-call-output-btc.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/hello-world-deploy-and-call-output-btc.png -------------------------------------------------------------------------------- /static/img/hello-world-deploy-and-call-output.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/hello-world-deploy-and-call-output.png -------------------------------------------------------------------------------- /static/img/homepage.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/homepage.png -------------------------------------------------------------------------------- /static/img/inscribe-image.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/inscribe-image.png -------------------------------------------------------------------------------- /static/img/inscribed-tx.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/inscribed-tx.png -------------------------------------------------------------------------------- /static/img/insufficient-balance.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/insufficient-balance.png -------------------------------------------------------------------------------- /static/img/mandatory-script-verify-flag-failed.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/mandatory-script-verify-flag-failed.png -------------------------------------------------------------------------------- /static/img/medium.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/medium.png -------------------------------------------------------------------------------- /static/img/mint-bsv20-mint-tx.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/mint-bsv20-mint-tx.png -------------------------------------------------------------------------------- /static/img/mint-bsv20-transfer-tx.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/mint-bsv20-transfer-tx.png -------------------------------------------------------------------------------- /static/img/mint-bsv20.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/mint-bsv20.png -------------------------------------------------------------------------------- /static/img/mint-bsv20v2-mint-tx.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/mint-bsv20v2-mint-tx.png -------------------------------------------------------------------------------- /static/img/mint-bsv20v2-transfer-tx.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/mint-bsv20v2-transfer-tx.png -------------------------------------------------------------------------------- /static/img/mint-bsv20v2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/mint-bsv20v2.png -------------------------------------------------------------------------------- /static/img/missing-inputs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/missing-inputs.png -------------------------------------------------------------------------------- /static/img/no-private-key.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/no-private-key.png -------------------------------------------------------------------------------- /static/img/oauth2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/oauth2.png -------------------------------------------------------------------------------- /static/img/opcs.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/opcs.png -------------------------------------------------------------------------------- /static/img/opcs_mul.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/opcs_mul.jpg -------------------------------------------------------------------------------- /static/img/open-api-auth.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/open-api-auth.png -------------------------------------------------------------------------------- /static/img/oracle-demo-bsv20-unlocking-tx.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/oracle-demo-bsv20-unlocking-tx.png -------------------------------------------------------------------------------- /static/img/oracle.jpeg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/oracle.jpeg -------------------------------------------------------------------------------- /static/img/oracle.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/oracle.png -------------------------------------------------------------------------------- /static/img/ordinal-lock/buy1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/ordinal-lock/buy1.png -------------------------------------------------------------------------------- /static/img/ordinal-lock/buy2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/ordinal-lock/buy2.png -------------------------------------------------------------------------------- /static/img/ordinal-lock/buy3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/ordinal-lock/buy3.png -------------------------------------------------------------------------------- /static/img/ordinal-lock/buy4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/ordinal-lock/buy4.png -------------------------------------------------------------------------------- /static/img/ordinal-lock/load1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/ordinal-lock/load1.png -------------------------------------------------------------------------------- /static/img/ordinal-lock/load2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/ordinal-lock/load2.png -------------------------------------------------------------------------------- /static/img/ordinal-lock/panda-buy1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/ordinal-lock/panda-buy1.png -------------------------------------------------------------------------------- /static/img/ordinal-lock/panda-buy2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/ordinal-lock/panda-buy2.png -------------------------------------------------------------------------------- /static/img/ordinal-lock/panda-load1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/ordinal-lock/panda-load1.png -------------------------------------------------------------------------------- /static/img/ordinal-lock/panda-load2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/ordinal-lock/panda-load2.png -------------------------------------------------------------------------------- /static/img/ordinal-lock/panda-sell1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/ordinal-lock/panda-sell1.png -------------------------------------------------------------------------------- /static/img/ordinal-lock/panda-sell2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/ordinal-lock/panda-sell2.png -------------------------------------------------------------------------------- /static/img/ordinal-lock/sell1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/ordinal-lock/sell1.png -------------------------------------------------------------------------------- /static/img/ordinal-lock/sell2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/ordinal-lock/sell2.png -------------------------------------------------------------------------------- /static/img/outpoint.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/outpoint.webp -------------------------------------------------------------------------------- /static/img/panda.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/panda.gif -------------------------------------------------------------------------------- /static/img/react-scaffold-btc.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/react-scaffold-btc.png -------------------------------------------------------------------------------- /static/img/react-scaffold.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/react-scaffold.png -------------------------------------------------------------------------------- /static/img/reddit.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/reddit.png -------------------------------------------------------------------------------- /static/img/scriptContext.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/scriptContext.jpg -------------------------------------------------------------------------------- /static/img/scrypt-cli-compile.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/scrypt-cli-compile.png -------------------------------------------------------------------------------- /static/img/scrypt.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/scrypt.png -------------------------------------------------------------------------------- /static/img/sighashpreimage.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/sighashpreimage.png -------------------------------------------------------------------------------- /static/img/sighashtypes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/sighashtypes.png -------------------------------------------------------------------------------- /static/img/signing.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/signing.png -------------------------------------------------------------------------------- /static/img/signingTx.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/signingTx.png -------------------------------------------------------------------------------- /static/img/slack.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/slack.png -------------------------------------------------------------------------------- /static/img/state-btc.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/state-btc.png -------------------------------------------------------------------------------- /static/img/state.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/state.jpg -------------------------------------------------------------------------------- /static/img/swap1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/swap1.png -------------------------------------------------------------------------------- /static/img/swap2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/swap2.png -------------------------------------------------------------------------------- /static/img/telegram.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/telegram.png -------------------------------------------------------------------------------- /static/img/twitter.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/twitter.png -------------------------------------------------------------------------------- /static/img/txn-mempool-conflict.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/txn-mempool-conflict.png -------------------------------------------------------------------------------- /static/img/utxo.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/utxo.jpg -------------------------------------------------------------------------------- /static/img/verify-diagram.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/verify-diagram.webp -------------------------------------------------------------------------------- /static/img/verify-scripthash.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/verify-scripthash.png -------------------------------------------------------------------------------- /static/img/verify-submit-filled.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/verify-submit-filled.png -------------------------------------------------------------------------------- /static/img/verify-submit.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/verify-submit.png -------------------------------------------------------------------------------- /static/img/verify-tx-out.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/verify-tx-out.png -------------------------------------------------------------------------------- /static/img/verify-verified-code.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/verify-verified-code.png -------------------------------------------------------------------------------- /static/img/voting-homepage.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/voting-homepage.png -------------------------------------------------------------------------------- /static/img/voting-scripts.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/voting-scripts.png -------------------------------------------------------------------------------- /static/img/voting.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/voting.gif -------------------------------------------------------------------------------- /static/img/vue-cli-1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/vue-cli-1.png -------------------------------------------------------------------------------- /static/img/vue-cli-2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/vue-cli-2.png -------------------------------------------------------------------------------- /static/img/watch.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/watch.gif -------------------------------------------------------------------------------- /static/img/wechat-qrcode.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/wechat-qrcode.jpg -------------------------------------------------------------------------------- /static/img/wechat.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/wechat.png -------------------------------------------------------------------------------- /static/img/yt.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/yt.png -------------------------------------------------------------------------------- /static/img/zksnark-verifier.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sCrypt-Inc/scryptTS-docs/f935d4827c0606ee76a40259f2ce6417b4e8fbfb/static/img/zksnark-verifier.png -------------------------------------------------------------------------------- /static/scripts/setup-scryptc.sh: -------------------------------------------------------------------------------- 1 | ../setup --------------------------------------------------------------------------------