kylefang/stacks.js
1
0
Fork 0
mirror of https://github.com/alexgo-io/stacks.js.git synced 2026-06-12 00:54:46 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
v3
stacks.js/docs/interfaces/transactions.contractdeployoptions.html
Alexander Graebe f572477ca0 feat: add regtest to list of available networks 
fixes #1041
2021-06-28 10:27:07 -07:00

412 lines
19 KiB
HTML
Vendored
Raw Permalink Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ContractDeployOptions | Stacks.js 1.4.1 Library Reference</title>
<meta name="description" content="Documentation for Stacks.js 1.4.1 Library Reference">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Stacks.js 1.4.1 Library Reference</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">Stacks.js 1.4.1 Library Reference</a>
</li>
<li>
<a href="../modules/transactions.html">transactions</a>
</li>
<li>
<a href="transactions.contractdeployoptions.html">ContractDeployOptions</a>
</li>
</ul>
<h1>Interface ContractDeployOptions</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Contract deploy transaction options</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">ContractDeployOptions</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="transactions.contractdeployoptions.html#anchormode" class="tsd-kind-icon">anchor<wbr>Mode</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="transactions.contractdeployoptions.html#codebody" class="tsd-kind-icon">code<wbr>Body</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="transactions.contractdeployoptions.html#contractname" class="tsd-kind-icon">contract<wbr>Name</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="transactions.contractdeployoptions.html#fee" class="tsd-kind-icon">fee</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="transactions.contractdeployoptions.html#network" class="tsd-kind-icon">network</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="transactions.contractdeployoptions.html#nonce" class="tsd-kind-icon">nonce</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="transactions.contractdeployoptions.html#postconditionmode" class="tsd-kind-icon">post<wbr>Condition<wbr>Mode</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="transactions.contractdeployoptions.html#postconditions" class="tsd-kind-icon">post<wbr>Conditions</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="transactions.contractdeployoptions.html#senderkey" class="tsd-kind-icon">sender<wbr>Key</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="transactions.contractdeployoptions.html#sponsored" class="tsd-kind-icon">sponsored</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="anchormode" class="tsd-anchor"></a>
<h3>anchor<wbr>Mode</h3>
<div class="tsd-signature tsd-kind-icon">anchor<wbr>Mode<span class="tsd-signature-symbol">:</span> <a href="../enums/transactions.anchormode.html" class="tsd-signature-type" data-tsd-kind="Enumeration">AnchorMode</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/builders.ts#L446">packages/transactions/src/builders.ts:446</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the transaction anchorMode, which specifies whether it should be
included in an anchor block or a microblock</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="codebody" class="tsd-anchor"></a>
<h3>code<wbr>Body</h3>
<div class="tsd-signature tsd-kind-icon">code<wbr>Body<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/builders.ts#L435">packages/transactions/src/builders.ts:435</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the Clarity code to be deployed</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="contractname" class="tsd-anchor"></a>
<h3>contract<wbr>Name</h3>
<div class="tsd-signature tsd-kind-icon">contract<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/builders.ts#L433">packages/transactions/src/builders.ts:433</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="fee" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> fee</h3>
<div class="tsd-signature tsd-kind-icon">fee<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BN</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/builders.ts#L439">packages/transactions/src/builders.ts:439</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>transaction fee in microstacks</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="network" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> network</h3>
<div class="tsd-signature tsd-kind-icon">network<span class="tsd-signature-symbol">:</span> <a href="network.stacksnetwork.html" class="tsd-signature-type" data-tsd-kind="Interface">StacksNetwork</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/builders.ts#L443">packages/transactions/src/builders.ts:443</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the network that the transaction will ultimately be broadcast to</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="nonce" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> nonce</h3>
<div class="tsd-signature tsd-kind-icon">nonce<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BN</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/builders.ts#L441">packages/transactions/src/builders.ts:441</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the transaction nonce, which must be increased monotonically with each new transaction</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="postconditionmode" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> post<wbr>Condition<wbr>Mode</h3>
<div class="tsd-signature tsd-kind-icon">post<wbr>Condition<wbr>Mode<span class="tsd-signature-symbol">:</span> <a href="../enums/transactions.postconditionmode.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PostConditionMode</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/builders.ts#L449">packages/transactions/src/builders.ts:449</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the post condition mode, specifying whether or not post-conditions must fully cover all
transfered assets</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="postconditions" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> post<wbr>Conditions</h3>
<div class="tsd-signature tsd-kind-icon">post<wbr>Conditions<span class="tsd-signature-symbol">:</span> <a href="../modules/transactions.html#postcondition" class="tsd-signature-type" data-tsd-kind="Type alias">PostCondition</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/builders.ts#L451">packages/transactions/src/builders.ts:451</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>a list of post conditions to add to the transaction</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="senderkey" class="tsd-anchor"></a>
<h3>sender<wbr>Key</h3>
<div class="tsd-signature tsd-kind-icon">sender<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/builders.ts#L437">packages/transactions/src/builders.ts:437</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>a hex string of the private key of the transaction sender</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="sponsored" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> sponsored</h3>
<div class="tsd-signature tsd-kind-icon">sponsored<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/blockstack/stacks.js/blob/master/packages/transactions/src/builders.ts#L453">packages/transactions/src/builders.ts:453</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>set to true if another account is sponsoring the transaction (covering the transaction fee)</p>
</div>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/auth.html">auth</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/bns.html">bns</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/cli.html">cli</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/common.html">common</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/encryption.html">encryption</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/keychain.html">keychain</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/network.html">network</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/profile.html">profile</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/stacking.html">stacking</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/storage.html">storage</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/transactions.html">transactions</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-module">
<a href="../modules/auth.html" class="tsd-kind-icon">auth</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/bns.html" class="tsd-kind-icon">bns</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/cli.html" class="tsd-kind-icon">cli</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/common.html" class="tsd-kind-icon">common</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/encryption.html" class="tsd-kind-icon">encryption</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/keychain.html" class="tsd-kind-icon">keychain</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/network.html" class="tsd-kind-icon">network</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/profile.html" class="tsd-kind-icon">profile</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/stacking.html" class="tsd-kind-icon">stacking</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/storage.html" class="tsd-kind-icon">storage</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-module">
<a href="../modules/transactions.html" class="tsd-kind-icon">transactions</a>
<ul>
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="transactions.contractdeployoptions.html" class="tsd-kind-icon">Contract<wbr>Deploy<wbr>Options</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="transactions.contractdeployoptions.html#anchormode" class="tsd-kind-icon">anchor<wbr>Mode</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="transactions.contractdeployoptions.html#codebody" class="tsd-kind-icon">code<wbr>Body</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="transactions.contractdeployoptions.html#contractname" class="tsd-kind-icon">contract<wbr>Name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="transactions.contractdeployoptions.html#fee" class="tsd-kind-icon">fee</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="transactions.contractdeployoptions.html#network" class="tsd-kind-icon">network</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="transactions.contractdeployoptions.html#nonce" class="tsd-kind-icon">nonce</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="transactions.contractdeployoptions.html#postconditionmode" class="tsd-kind-icon">post<wbr>Condition<wbr>Mode</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="transactions.contractdeployoptions.html#postconditions" class="tsd-kind-icon">post<wbr>Conditions</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="transactions.contractdeployoptions.html#senderkey" class="tsd-kind-icon">sender<wbr>Key</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="transactions.contractdeployoptions.html#sponsored" class="tsd-kind-icon">sponsored</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink