Skip to content
This repository has been archived by the owner on Jun 6, 2024. It is now read-only.

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Mar 24, 2023
1 parent 4289092 commit c52ddef
Show file tree
Hide file tree
Showing 41 changed files with 177 additions and 32 deletions.
2 changes: 1 addition & 1 deletion latest/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: d75cd65fcdf3019a1c4c2ad8f32ec79b
config: e0076fcd13b1de8401530ee661141e2a
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified latest/.doctrees/environment.pickle
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/accounts.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/conversion.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ecosystems.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/exceptions.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/explorer.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/provider.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/tokens.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/transactions.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/types.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/udc.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/utils.doctree
Binary file not shown.
Binary file modified latest/.doctrees/userguides/accounts.doctree
Binary file not shown.
Binary file modified latest/.doctrees/userguides/contracts.doctree
Binary file not shown.
Binary file modified latest/.doctrees/userguides/quickstart.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion latest/_sources/userguides/accounts.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ ape starknet accounts deploy <NEW-ALIAS> --network testnet --funder <EXISTING-FU
```

**NOTE**: You cannot use an Ethereum account to send funds to a Starknet account directly.
You must use the [StarkNet L2 bridge](https://goerli.starkgate.starknet.io/) to transfer existing Goerli L1 ETH to and from the L2 account.
You must use the [Starknet L2 bridge](https://goerli.starkgate.starknet.io/) to transfer existing Goerli L1 ETH to and from the L2 account.

## Listing Accounts

Expand Down
4 changes: 2 additions & 2 deletions latest/_sources/userguides/contracts.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ func deploy_my_contract{syscall_ptr: felt*, pedersen_ptr: HashBuiltin*, range_ch
}
```

This contract accepts a class hash of a declared contract deploys it.
This contract accepts a class hash of a declared contract and deploys it.
The following example shows how to use this factory class to deploy other contracts:

```python
Expand All @@ -96,7 +96,7 @@ contract = Contract(contract_address, contract_type=project.MyContract.contract_

## Contract Interaction

You can learn more about contract inteacting from the ApeWorX documentation about [contracts](https://docs.apeworx.io/ape/stable/userguides/contracts.html).
You can learn more about contract interaction from the ApeWorX documentation about [contracts](https://docs.apeworx.io/ape/stable/userguides/contracts.html).

**NOTE**: Currently, to pass in arrays as arguments, you have to also include the array size beforehand:

Expand Down
123 changes: 123 additions & 0 deletions latest/_static/_sphinx_javascript_frameworks_compat.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
/* Compatability shim for jQuery and underscores.js.
*
* Copyright Sphinx contributors
* Released under the two clause BSD licence
*/

/**
* small helper function to urldecode strings
*
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
*/
jQuery.urldecode = function(x) {
if (!x) {
return x
}
return decodeURIComponent(x.replace(/\+/g, ' '));
};

/**
* small helper function to urlencode strings
*/
jQuery.urlencode = encodeURIComponent;

/**
* This function returns the parsed url parameters of the
* current request. Multiple values per key are supported,
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
if (typeof s === 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
for (var i = 0; i < parts.length; i++) {
var tmp = parts[i].split('=', 2);
var key = jQuery.urldecode(tmp[0]);
var value = jQuery.urldecode(tmp[1]);
if (key in result)
result[key].push(value);
else
result[key] = [value];
}
return result;
};

/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
function highlight(node, addItems) {
if (node.nodeType === 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 &&
!jQuery(node.parentNode).hasClass(className) &&
!jQuery(node.parentNode).hasClass("nohighlight")) {
var span;
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.className = className;
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
var bbox = node.parentElement.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute('class', className);
addItems.push({
"parent": node.parentNode,
"target": rect});
}
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
highlight(this, addItems);
});
}
}
var addItems = [];
var result = this.each(function() {
highlight(this, addItems);
});
for (var i = 0; i < addItems.length; ++i) {
jQuery(addItems[i].parent).before(addItems[i].target);
}
return result;
};

/*
* backward compatibility for jQuery.browser
* This will be supported until firefox bug is fixed.
*/
if (!jQuery.browser) {
jQuery.uaMatch = function(ua) {
ua = ua.toLowerCase();

var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
/(msie) ([\w.]+)/.exec(ua) ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
[];

return {
browser: match[ 1 ] || "",
version: match[ 2 ] || "0"
};
};
jQuery.browser = {};
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
}
2 changes: 2 additions & 0 deletions latest/_static/jquery.js

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion latest/commands/accounts.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
Expand Down
3 changes: 2 additions & 1 deletion latest/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
Expand Down
3 changes: 2 additions & 1 deletion latest/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
Expand Down
3 changes: 2 additions & 1 deletion latest/methoddocs/accounts.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
Expand Down
3 changes: 2 additions & 1 deletion latest/methoddocs/conversion.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
Expand Down
3 changes: 2 additions & 1 deletion latest/methoddocs/ecosystems.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
Expand Down
3 changes: 2 additions & 1 deletion latest/methoddocs/exceptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
Expand Down
3 changes: 2 additions & 1 deletion latest/methoddocs/explorer.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
Expand Down
3 changes: 2 additions & 1 deletion latest/methoddocs/provider.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
Expand Down
3 changes: 2 additions & 1 deletion latest/methoddocs/tokens.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
Expand Down
3 changes: 2 additions & 1 deletion latest/methoddocs/transactions.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
Expand Down
3 changes: 2 additions & 1 deletion latest/methoddocs/types.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
Expand Down
3 changes: 2 additions & 1 deletion latest/methoddocs/udc.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
Expand Down
3 changes: 2 additions & 1 deletion latest/methoddocs/utils.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
Expand Down
3 changes: 2 additions & 1 deletion latest/py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
Expand Down
3 changes: 2 additions & 1 deletion latest/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
Expand Down
2 changes: 1 addition & 1 deletion latest/searchindex.js

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions latest/userguides/accounts.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
Expand Down Expand Up @@ -179,7 +180,7 @@ <h2>Deploying an Account<a class="headerlink" href="#deploying-an-account" title
</pre></div>
</div>
<p><strong>NOTE</strong>: You cannot use an Ethereum account to send funds to a Starknet account directly.
You must use the <a class="reference external" href="https://goerli.starkgate.starknet.io/">StarkNet L2 bridge</a> to transfer existing Goerli L1 ETH to and from the L2 account.</p>
You must use the <a class="reference external" href="https://goerli.starkgate.starknet.io/">Starknet L2 bridge</a> to transfer existing Goerli L1 ETH to and from the L2 account.</p>
</section>
<section id="listing-accounts">
<h2>Listing Accounts<a class="headerlink" href="#listing-accounts" title="Permalink to this heading"></a></h2>
Expand Down
7 changes: 4 additions & 3 deletions latest/userguides/contracts.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
Expand Down Expand Up @@ -187,7 +188,7 @@ <h3>Factory Contracts<a class="headerlink" href="#factory-contracts" title="Perm
<span class="p">}</span>
</pre></div>
</div>
<p>This contract accepts a class hash of a declared contract deploys it.
<p>This contract accepts a class hash of a declared contract and deploys it.
The following example shows how to use this factory class to deploy other contracts:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">ape</span> <span class="kn">import</span> <span class="n">Contract</span><span class="p">,</span> <span class="n">accounts</span><span class="p">,</span> <span class="n">networks</span><span class="p">,</span> <span class="n">project</span>

Expand All @@ -206,7 +207,7 @@ <h3>Factory Contracts<a class="headerlink" href="#factory-contracts" title="Perm
</section>
<section id="contract-interaction">
<h2>Contract Interaction<a class="headerlink" href="#contract-interaction" title="Permalink to this heading"></a></h2>
<p>You can learn more about contract inteacting from the ApeWorX documentation about <a class="reference external" href="https://docs.apeworx.io/ape/stable/userguides/contracts.html">contracts</a>.</p>
<p>You can learn more about contract interaction from the ApeWorX documentation about <a class="reference external" href="https://docs.apeworx.io/ape/stable/userguides/contracts.html">contracts</a>.</p>
<p><strong>NOTE</strong>: Currently, to pass in arrays as arguments, you have to also include the array size beforehand:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">receipt</span> <span class="o">=</span> <span class="n">contract</span><span class="o">.</span><span class="n">store_my_list</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">])</span>
</pre></div>
Expand Down
Loading

0 comments on commit c52ddef

Please sign in to comment.