Skip to content

Commit

Permalink
Deploying to gh-pages from @ 4ba3fe7 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@ml-james
ml-james committed Dec 31, 2024
1 parent c897d8c commit 4f09844
Show file tree
Hide file tree
Showing 189 changed files with 18,268 additions and 30,568 deletions.
283 changes: 78 additions & 205 deletions allclasses-index.html
View file

Large diffs are not rendered by default.

93 changes: 36 additions & 57 deletions allclasses.html
View file

Large diffs are not rendered by default.

26 changes: 10 additions & 16 deletions allpackages-index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>All Packages (solana4j)</title>
<title>All Packages (solana4j-json-rpc)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
Expand All @@ -21,7 +21,7 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="All Packages (solana4j)";
parent.document.title="All Packages (solana4j-json-rpc)";
}
}
catch(err) {
Expand All @@ -46,7 +46,7 @@
</a>
<ul class="navList" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li><a href="com.lmax.solana4j/module-summary.html">Module</a></li>
<li><a href="com.lmax.solana4j.client/module-summary.html">Module</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
Expand Down Expand Up @@ -108,27 +108,21 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
</tr>
<tbody>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="com.lmax.solana4j/com/lmax/solana4j/package-summary.html">com.lmax.solana4j</a></th>
<th class="colFirst" scope="row"><a href="com.lmax.solana4j.client/com/lmax/solana4j/client/package-summary.html">com.lmax.solana4j.client</a></th>
<td class="colLast">
<div class="block">This package is the base package and is the entrypoint to the solana message encoding library's APIs.</div>
<div class="block">This package is the base package and is the entrypoint to the solana client library's APIs.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="com.lmax.solana4j/com/lmax/solana4j/api/package-summary.html">com.lmax.solana4j.api</a></th>
<th class="colFirst" scope="row"><a href="com.lmax.solana4j.client/com/lmax/solana4j/client/api/package-summary.html">com.lmax.solana4j.client.api</a></th>
<td class="colLast">
<div class="block">This package defines the solana message encoding library's API.</div>
<div class="block">This package defines the solana client library's API.</div>
</td>
</tr>
<tr class="altColor">
<th class="colFirst" scope="row"><a href="com.lmax.solana4j/com/lmax/solana4j/encoding/package-summary.html">com.lmax.solana4j.encoding</a></th>
<th class="colFirst" scope="row"><a href="com.lmax.solana4j.client/com/lmax/solana4j/client/jsonrpc/package-summary.html">com.lmax.solana4j.client.jsonrpc</a></th>
<td class="colLast">
<div class="block">This package exposes the solana message encoding library's API.</div>
</td>
</tr>
<tr class="rowColor">
<th class="colFirst" scope="row"><a href="com.lmax.solana4j/com/lmax/solana4j/programs/package-summary.html">com.lmax.solana4j.programs</a></th>
<td class="colLast">
<div class="block">This package contains implementations of interactions with Solana Programs on the Solana Blockchain.</div>
<div class="block">This package exposes the solana client library's API.</div>
</td>
</tr>
</tbody>
Expand All @@ -149,7 +143,7 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
</a>
<ul class="navList" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li><a href="com.lmax.solana4j/module-summary.html">Module</a></li>
<li><a href="com.lmax.solana4j.client/module-summary.html">Module</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
Expand Down
84 changes: 45 additions & 39 deletions ...tProgram.ComputeBudgetProgramFactory.html → ...om/lmax/solana4j/client/SolanaClient.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>ComputeBudgetProgram.ComputeBudgetProgramFactory (solana4j)</title>
<title>SolanaClient (solana4j-json-rpc)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.min.css" title="Style">
Expand All @@ -21,14 +21,14 @@
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ComputeBudgetProgram.ComputeBudgetProgramFactory (solana4j)";
parent.document.title="SolanaClient (solana4j-json-rpc)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var data = {"i0":9,"i1":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
Expand All @@ -55,7 +55,7 @@
<li><a href="../../../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ComputeBudgetProgram.ComputeBudgetProgramFactory.html">Use</a></li>
<li><a href="class-use/SolanaClient.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
Expand Down Expand Up @@ -117,30 +117,28 @@
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="moduleLabelInType">Module</span>&nbsp;<a href="../../../../module-summary.html">com.lmax.solana4j</a></div>
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.lmax.solana4j.programs</a></div>
<h2 title="Class ComputeBudgetProgram.ComputeBudgetProgramFactory" class="title">Class ComputeBudgetProgram.ComputeBudgetProgramFactory</h2>
<div class="subTitle"><span class="moduleLabelInType">Module</span>&nbsp;<a href="../../../../module-summary.html">com.lmax.solana4j.client</a></div>
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.lmax.solana4j.client</a></div>
<h2 title="Class SolanaClient" class="title">Class SolanaClient</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.lmax.solana4j.programs.ComputeBudgetProgram.ComputeBudgetProgramFactory</li>
<li>com.lmax.solana4j.client.SolanaClient</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="ComputeBudgetProgram.html" title="class in com.lmax.solana4j.programs">ComputeBudgetProgram</a></dd>
</dl>
<hr>
<pre>public static final class <span class="typeNameLabel">ComputeBudgetProgram.ComputeBudgetProgramFactory</span>
<pre>public final class <span class="typeNameLabel">SolanaClient</span>
extends java.lang.Object</pre>
<div class="block">Inner factory class for building compute budget program instructions using a <a href="../api/TransactionBuilder.html" title="interface in com.lmax.solana4j.api"><code>TransactionBuilder</code></a>.</div>
<div class="block">The <code>SolanaClient</code> class provides a static factory method to interact with the Solana blockchain.
This class simplifies the creation of a <a href="api/SolanaApi.html" title="interface in com.lmax.solana4j.client.api"><code>SolanaApi</code></a> instance,
which allows interaction with Solana nodes.</div>
</li>
</ul>
</div>
Expand All @@ -155,24 +153,26 @@ <h2 title="Class ComputeBudgetProgram.ComputeBudgetProgramFactory" class="title"
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="ComputeBudgetProgram.ComputeBudgetProgramFactory.html" title="class in com.lmax.solana4j.programs">ComputeBudgetProgram.ComputeBudgetProgramFactory</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setComputeUnitLimit(int)">setComputeUnitLimit</a></span>&#8203;(int&nbsp;computeUnits)</code></th>
<td class="colFirst"><code>static <a href="api/SolanaApi.html" title="interface in com.lmax.solana4j.client.api">SolanaApi</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.lang.String)">create</a></span>&#8203;(java.lang.String&nbsp;rpcUrl)</code></th>
<td class="colLast">
<div class="block">Sets the compute unit limit.</div>
<div class="block">Creates a new instance of <a href="api/SolanaApi.html" title="interface in com.lmax.solana4j.client.api"><code>SolanaApi</code></a> that connects to the provided Solana node.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="ComputeBudgetProgram.ComputeBudgetProgramFactory.html" title="class in com.lmax.solana4j.programs">ComputeBudgetProgram.ComputeBudgetProgramFactory</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setComputeUnitPrice(long)">setComputeUnitPrice</a></span>&#8203;(long&nbsp;microLamports)</code></th>
<td class="colFirst"><code>static <a href="api/SolanaApi.html" title="interface in com.lmax.solana4j.client.api">SolanaApi</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#create(java.lang.String,java.time.Duration,java.time.Duration)">create</a></span>&#8203;(java.lang.String&nbsp;rpcUrl,
java.time.Duration&nbsp;connectionTimeout,
java.time.Duration&nbsp;requestTimeout)</code></th>
<td class="colLast">
<div class="block">Sets the compute unit price.</div>
<div class="block">Creates a new instance of <a href="api/SolanaApi.html" title="interface in com.lmax.solana4j.client.api"><code>SolanaApi</code></a> that connects to the provided Solana node.</div>
</td>
</tr>
</table>
Expand All @@ -199,41 +199,47 @@ <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="setComputeUnitLimit(int)">
<a id="create(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setComputeUnitLimit</h4>
<pre class="methodSignature">public&nbsp;<a href="ComputeBudgetProgram.ComputeBudgetProgramFactory.html" title="class in com.lmax.solana4j.programs">ComputeBudgetProgram.ComputeBudgetProgramFactory</a>&nbsp;setComputeUnitLimit&#8203;(int&nbsp;computeUnits)</pre>
<div class="block">Sets the compute unit limit.
<h4>create</h4>
<pre class="methodSignature">public static&nbsp;<a href="api/SolanaApi.html" title="interface in com.lmax.solana4j.client.api">SolanaApi</a>&nbsp;create&#8203;(java.lang.String&nbsp;rpcUrl)</pre>
<div class="block">Creates a new instance of <a href="api/SolanaApi.html" title="interface in com.lmax.solana4j.client.api"><code>SolanaApi</code></a> that connects to the provided Solana node.
This method returns an API client that facilitates interaction with the Solana blockchain.

<p>
This method generates a transaction instruction to set the maximum number of compute units that can be used.
This overloaded version of the <code>create</code> method uses default timeout values:
30 seconds for both connection and request timeouts.
</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>computeUnits</code> - the number of compute units to set as the limit</dd>
<dd><code>rpcUrl</code> - The endpoint URL of the Solana node.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <code>ComputeBudgetProgramFactory</code> instance</dd>
<dd>An instance of <a href="api/SolanaApi.html" title="interface in com.lmax.solana4j.client.api"><code>SolanaApi</code></a> that communicates with the specified Solana node,
using default timeouts.</dd>
</dl>
</li>
</ul>
<a id="setComputeUnitPrice(long)">
<a id="create(java.lang.String,java.time.Duration,java.time.Duration)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setComputeUnitPrice</h4>
<pre class="methodSignature">public&nbsp;<a href="ComputeBudgetProgram.ComputeBudgetProgramFactory.html" title="class in com.lmax.solana4j.programs">ComputeBudgetProgram.ComputeBudgetProgramFactory</a>&nbsp;setComputeUnitPrice&#8203;(long&nbsp;microLamports)</pre>
<div class="block">Sets the compute unit price.
<p>
This method generates a transaction instruction to set the price per compute unit, expressed in microLamports.
</p></div>
<h4>create</h4>
<pre class="methodSignature">public static&nbsp;<a href="api/SolanaApi.html" title="interface in com.lmax.solana4j.client.api">SolanaApi</a>&nbsp;create&#8203;(java.lang.String&nbsp;rpcUrl,
java.time.Duration&nbsp;connectionTimeout,
java.time.Duration&nbsp;requestTimeout)</pre>
<div class="block">Creates a new instance of <a href="api/SolanaApi.html" title="interface in com.lmax.solana4j.client.api"><code>SolanaApi</code></a> that connects to the provided Solana node.
This method returns an API client that facilitates interaction with the Solana blockchain.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>microLamports</code> - the price in microLamports per compute unit</dd>
<dd><code>rpcUrl</code> - The endpoint URL of the Solana node.</dd>
<dd><code>connectionTimeout</code> - The maximum time to wait for a connection to be established.</dd>
<dd><code>requestTimeout</code> - The maximum time to wait for a response from the Solana node.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this <code>ComputeBudgetProgramFactory</code> instance</dd>
<dd>An instance of <a href="api/SolanaApi.html" title="interface in com.lmax.solana4j.client.api"><code>SolanaApi</code></a> that communicates with the specified Solana node.</dd>
</dl>
</li>
</ul>
Expand Down Expand Up @@ -261,7 +267,7 @@ <h4>setComputeUnitPrice</h4>
<li><a href="../../../../module-summary.html">Module</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ComputeBudgetProgram.ComputeBudgetProgramFactory.html">Use</a></li>
<li><a href="class-use/SolanaClient.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
Expand Down
Loading

0 comments on commit 4f09844

Please sign in to comment.