mirror of
https://github.com/alexgo-io/stacks.js.git
synced 2026-05-28 08:08:05 +08:00
396 lines
19 KiB
HTML
Vendored
396 lines
19 KiB
HTML
Vendored
<!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.0.0 Library Reference</title>
|
|
<meta name="description" content="Documentation for Stacks.js 1.0.0 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>
|
|
<link rel="stylesheet" href="../assets/css/custom-style.css">
|
|
<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.0.0 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>
|
|
</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.0.0 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>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>param</dt>
|
|
<dd><p>the contract name</p>
|
|
</dd>
|
|
<dt>param</dt>
|
|
<dd><p>the code body string</p>
|
|
</dd>
|
|
<dt>param</dt>
|
|
<dd><p>hex string sender private key used to sign transaction</p>
|
|
</dd>
|
|
<dt>param</dt>
|
|
<dd><p>transaction fee in microstacks</p>
|
|
</dd>
|
|
<dt>param</dt>
|
|
<dd><p>a nonce must be increased monotonically with each new transaction</p>
|
|
</dd>
|
|
<dt>param</dt>
|
|
<dd><p>the Stacks blockchain network this transaction is destined for</p>
|
|
</dd>
|
|
<dt>param</dt>
|
|
<dd><p>identify how the the transaction should be mined</p>
|
|
</dd>
|
|
<dt>param</dt>
|
|
<dd><p>whether post conditions must fully cover all
|
|
transferred assets</p>
|
|
</dd>
|
|
<dt>param</dt>
|
|
<dd><p>an array of post conditions to add to the
|
|
transaction</p>
|
|
</dd>
|
|
<dt>param</dt>
|
|
<dd><p>true if another account is sponsoring the transaction fees</p>
|
|
</dd>
|
|
</dl>
|
|
</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><span class="tsd-flag ts-flagOptional">Optional</span> 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#onchainonly" class="tsd-signature-type" data-tsd-kind="Enumeration member">OnChainOnly</a><span class="tsd-signature-symbol"> | </span><a href="../enums/transactions.anchormode.html#offchainonly" class="tsd-signature-type" data-tsd-kind="Enumeration member">OffChainOnly</a><span class="tsd-signature-symbol"> | </span><a href="../enums/transactions.anchormode.html#any" class="tsd-signature-type" data-tsd-kind="Enumeration member">Any</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#L455">packages/transactions/src/builders.ts:455</a></li>
|
|
</ul>
|
|
</aside>
|
|
</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#L450">packages/transactions/src/builders.ts:450</a></li>
|
|
</ul>
|
|
</aside>
|
|
</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#L449">packages/transactions/src/builders.ts:449</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#L452">packages/transactions/src/builders.ts:452</a></li>
|
|
</ul>
|
|
</aside>
|
|
</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> <span class="tsd-signature-type">StacksNetwork</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#L454">packages/transactions/src/builders.ts:454</a></li>
|
|
</ul>
|
|
</aside>
|
|
</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#L453">packages/transactions/src/builders.ts:453</a></li>
|
|
</ul>
|
|
</aside>
|
|
</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#allow" class="tsd-signature-type" data-tsd-kind="Enumeration member">Allow</a><span class="tsd-signature-symbol"> | </span><a href="../enums/transactions.postconditionmode.html#deny" class="tsd-signature-type" data-tsd-kind="Enumeration member">Deny</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#L456">packages/transactions/src/builders.ts:456</a></li>
|
|
</ul>
|
|
</aside>
|
|
</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="" 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#L457">packages/transactions/src/builders.ts:457</a></li>
|
|
</ul>
|
|
</aside>
|
|
</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#L451">packages/transactions/src/builders.ts:451</a></li>
|
|
</ul>
|
|
</aside>
|
|
</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#L458">packages/transactions/src/builders.ts:458</a></li>
|
|
</ul>
|
|
</aside>
|
|
</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>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</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> |