Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@dkackman
dkackman committed Mar 20, 2024
1 parent 713ad1e commit 06c2d38
Show file tree
Hide file tree
Showing 10 changed files with 150 additions and 307 deletions.
208 changes: 22 additions & 186 deletions docs/api/chia.dotnet.wallet.AssetToken-1.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<meta name="title" content="Class AssetToken&lt;T&gt;
| chia-dotnet-wallet ">


<meta name="description" content="Represents a CAT">
<link rel="icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
Expand Down Expand Up @@ -92,15 +92,16 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>

<h1 id="chia_dotnet_wallet_AssetToken_1" data-uid="chia.dotnet.wallet.AssetToken`1" class="text-break">
Class AssetToken&lt;T&gt;
<a class="header-action link-secondary" title="View source" href="https://github.com/dkackman/chia-dotnet-wallet/blob/main/src/wallet/AssetToken.cs/#L6"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/dkackman/chia-dotnet-wallet/blob/main/src/wallet/AssetToken.cs/#L12"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="chia.html">chia</a>.<a class="xref" href="chia.dotnet.html">dotnet</a>.<a class="xref" href="chia.dotnet.wallet.html">wallet</a></dd></dl>
<dl><dt>Assembly</dt><dd>chia-dotnet-wallet.dll</dd></dl>
</div>

<div class="markdown summary"></div>
<div class="markdown summary"><p>Represents a CAT</p>
</div>
<div class="markdown conceptual"></div>

<div class="codewrapper">
Expand All @@ -112,7 +113,8 @@ <h1 id="chia_dotnet_wallet_AssetToken_1" data-uid="chia.dotnet.wallet.AssetToken
<h4 class="section">Type Parameters</h4>
<dl class="parameters">
<dt><code>T</code></dt>
<dd></dd>
<dd><p>A Program</p>
</dd>
</dl>

<dl class="typelist inheritance">
Expand Down Expand Up @@ -309,10 +311,11 @@ <h2 class="section" id="constructors">Constructors

<h3 id="chia_dotnet_wallet_AssetToken_1__ctor_System_Byte____0_" data-uid="chia.dotnet.wallet.AssetToken`1.#ctor(System.Byte[],`0)">
AssetToken(byte[], T)
<a class="header-action link-secondary" title="View source" href="https://github.com/dkackman/chia-dotnet-wallet/blob/main/src/wallet/AssetToken.cs/#L6"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/dkackman/chia-dotnet-wallet/blob/main/src/wallet/AssetToken.cs/#L12"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Represents a CAT</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
Expand All @@ -322,9 +325,11 @@ <h3 id="chia_dotnet_wallet_AssetToken_1__ctor_System_Byte____0_" data-uid="chia.
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>assetId</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
<dd></dd>
<dd><p>The asset id</p>
</dd>
<dt><code>innerPuzzle</code> <span class="xref">T</span></dt>
<dd></dd>
<dd><p>The inner puzzle program</p>
</dd>
</dl>


Expand All @@ -346,10 +351,11 @@ <h2 class="section" id="properties">Properties

<h3 id="chia_dotnet_wallet_AssetToken_1_AssetId" data-uid="chia.dotnet.wallet.AssetToken`1.AssetId">
AssetId
<a class="header-action link-secondary" title="View source" href="https://github.com/dkackman/chia-dotnet-wallet/blob/main/src/wallet/AssetToken.cs/#L13"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/dkackman/chia-dotnet-wallet/blob/main/src/wallet/AssetToken.cs/#L21"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>The Token's asset id</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
Expand All @@ -363,7 +369,7 @@ <h3 id="chia_dotnet_wallet_AssetToken_1_AssetId" data-uid="chia.dotnet.wallet.As
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
<dd></dd>
<dd>Represents a CAT</dd>
</dl>


Expand All @@ -377,10 +383,11 @@ <h4 class="section">Property Value</h4>

<h3 id="chia_dotnet_wallet_AssetToken_1_InnerPuzzle" data-uid="chia.dotnet.wallet.AssetToken`1.InnerPuzzle">
InnerPuzzle
<a class="header-action link-secondary" title="View source" href="https://github.com/dkackman/chia-dotnet-wallet/blob/main/src/wallet/AssetToken.cs/#L14"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/dkackman/chia-dotnet-wallet/blob/main/src/wallet/AssetToken.cs/#L26"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>The tokens inner puzzle Program</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
Expand All @@ -394,92 +401,7 @@ <h3 id="chia_dotnet_wallet_AssetToken_1_InnerPuzzle" data-uid="chia.dotnet.walle
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><span class="xref">T</span></dt>
<dd></dd>
</dl>








<h2 class="section" id="methods">Methods
</h2>


<a id="chia_dotnet_wallet_AssetToken_1_CalculateIssuePayment_" data-uid="chia.dotnet.wallet.AssetToken`1.CalculateIssuePayment*"></a>

<h3 id="chia_dotnet_wallet_AssetToken_1_CalculateIssuePayment_chia_dotnet_clvm_Program_chia_dotnet_clvm_Program_System_Byte___System_Int32_" data-uid="chia.dotnet.wallet.AssetToken`1.CalculateIssuePayment(chia.dotnet.clvm.Program,chia.dotnet.clvm.Program,System.Byte[],System.Int32)">
CalculateIssuePayment(Program, Program, byte[], int)
<a class="header-action link-secondary" title="View source" href="https://github.com/dkackman/chia-dotnet-wallet/blob/main/src/wallet/AssetToken.cs/#L16"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Program CalculateIssuePayment(Program tail, Program solution, byte[] innerPuzzleHash, int amount)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>tail</code> <span class="xref">Program</span></dt>
<dd></dd>
<dt><code>solution</code> <span class="xref">Program</span></dt>
<dd></dd>
<dt><code>innerPuzzleHash</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
<dd></dd>
<dt><code>amount</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">Program</span></dt>
<dd></dd>
</dl>











<a id="chia_dotnet_wallet_AssetToken_1_CalculatePuzzle_" data-uid="chia.dotnet.wallet.AssetToken`1.CalculatePuzzle*"></a>

<h3 id="chia_dotnet_wallet_AssetToken_1_CalculatePuzzle_chia_dotnet_clvm_Program_chia_dotnet_clvm_Program_System_Byte___System_Int32_" data-uid="chia.dotnet.wallet.AssetToken`1.CalculatePuzzle(chia.dotnet.clvm.Program,chia.dotnet.clvm.Program,System.Byte[],System.Int32)">
CalculatePuzzle(Program, Program, byte[], int)
<a class="header-action link-secondary" title="View source" href="https://github.com/dkackman/chia-dotnet-wallet/blob/main/src/wallet/AssetToken.cs/#L38"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static AssetToken&lt;Program&gt; CalculatePuzzle(Program tail, Program solution, byte[] innerPuzzleHash, int amount)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>tail</code> <span class="xref">Program</span></dt>
<dd></dd>
<dt><code>solution</code> <span class="xref">Program</span></dt>
<dd></dd>
<dt><code>innerPuzzleHash</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
<dd></dd>
<dt><code>amount</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="chia.dotnet.wallet.AssetToken-1.html">AssetToken</a>&lt;<span class="xref">Program</span>&gt;</dt>
<dd></dd>
<dd>Represents a CAT</dd>
</dl>


Expand All @@ -490,96 +412,10 @@ <h4 class="section">Returns</h4>





<a id="chia_dotnet_wallet_AssetToken_1_Issue_" data-uid="chia.dotnet.wallet.AssetToken`1.Issue*"></a>

<h3 id="chia_dotnet_wallet_AssetToken_1_Issue_chia_dotnet_CoinSpend_chia_dotnet_clvm_Program_chia_dotnet_clvm_Program_System_Byte___System_Int32_" data-uid="chia.dotnet.wallet.AssetToken`1.Issue(chia.dotnet.CoinSpend,chia.dotnet.clvm.Program,chia.dotnet.clvm.Program,System.Byte[],System.Int32)">
Issue(CoinSpend, Program, Program, byte[], int)
<a class="header-action link-secondary" title="View source" href="https://github.com/dkackman/chia-dotnet-wallet/blob/main/src/wallet/AssetToken.cs/#L48"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static CoinSpend Issue(CoinSpend originCoinSpend, Program tail, Program solution, byte[] innerPuzzleHash, int amount)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>originCoinSpend</code> <span class="xref">CoinSpend</span></dt>
<dd></dd>
<dt><code>tail</code> <span class="xref">Program</span></dt>
<dd></dd>
<dt><code>solution</code> <span class="xref">Program</span></dt>
<dd></dd>
<dt><code>innerPuzzleHash</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
<dd></dd>
<dt><code>amount</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd></dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><span class="xref">CoinSpend</span></dt>
<dd></dd>
</dl>











<a id="chia_dotnet_wallet_AssetToken_1_Spend_" data-uid="chia.dotnet.wallet.AssetToken`1.Spend*"></a>

<h3 id="chia_dotnet_wallet_AssetToken_1_Spend_System_Collections_Generic_List_chia_dotnet_wallet_SpendableAssetCoin__" data-uid="chia.dotnet.wallet.AssetToken`1.Spend(System.Collections.Generic.List{chia.dotnet.wallet.SpendableAssetCoin})">
Spend(List&lt;SpendableAssetCoin&gt;)
<a class="header-action link-secondary" title="View source" href="https://github.com/dkackman/chia-dotnet-wallet/blob/main/src/wallet/AssetToken.cs/#L70"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Spends a list of spendable asset coins by creating coin spends.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static List&lt;CoinSpend&gt; Spend(List&lt;SpendableAssetCoin&gt; spendableAssetCoins)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>spendableAssetCoins</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<a class="xref" href="chia.dotnet.wallet.SpendableAssetCoin.html">SpendableAssetCoin</a>&gt;</dt>
<dd><p>The list of spendable asset coins to spend.</p>
</dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.list-1">List</a>&lt;<span class="xref">CoinSpend</span>&gt;</dt>
<dd><p>A list of coin spends.</p>
</dd>
</dl>












</article>

<div class="contribution d-print-none">
<a href="https://github.com/dkackman/chia-dotnet-wallet/blob/main/src/wallet/AssetToken.cs/#L6" class="edit-link">Edit this page</a>
<a href="https://github.com/dkackman/chia-dotnet-wallet/blob/main/src/wallet/AssetToken.cs/#L12" class="edit-link">Edit this page</a>
</div>


Expand Down

0 comments on commit 06c2d38

Please sign in to comment.