Skip to content

Commit

Permalink
Merge pull request #57 from orcaprotocol/willkim/release
Browse files Browse the repository at this point in the history
fix: release
  • Loading branch information
Will Kim authored Jun 3, 2022
2 parents b392e2b + d7575d8 commit 5488979
Show file tree
Hide file tree
Showing 7 changed files with 135 additions and 134 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ fetch Pod objects.
```js
import { getPod, getUserPods, getAdminPods } from '@orcaprotocol/orca-sdk';

// ENS names also work for the below.
const podFromEnsName = await getPod('mypod.pod.xyz');
// ENS names also work for the below.
const podFromAddress = await getPod('0x123...456');
const podFromId = await getPod(1);
// Returns null
Expand Down
72 changes: 36 additions & 36 deletions docs/classes/Pod.html

Large diffs are not rendered by default.

34 changes: 17 additions & 17 deletions docs/classes/Proposal.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ <h2>Getting Started</h2>
</code></pre>
<p>Once you init the SDK, you can call <code>getPod()</code>, <code>getUserPods()</code>, or <code>getAdminPods()</code> anywhere to
fetch Pod objects.</p>
<pre><code class="language-js"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">getPod</span><span class="hl-1">, </span><span class="hl-2">getUserPods</span><span class="hl-1">, </span><span class="hl-2">getAdminPods</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@orcaprotocol/orca-sdk&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-4">// ENS names also work for the below.</span><br/><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-8">podFromEnsName</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-5">getPod</span><span class="hl-1">(</span><span class="hl-3">&#39;mypod.pod.xyz&#39;</span><span class="hl-1">);</span><br/><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-8">podFromAddress</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-5">getPod</span><span class="hl-1">(</span><span class="hl-3">&#39;0x123...456&#39;</span><span class="hl-1">);</span><br/><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-8">podFromId</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-5">getPod</span><span class="hl-1">(</span><span class="hl-6">1</span><span class="hl-1">);</span><br/><span class="hl-4">// Returns null</span><br/><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-8">notAPod</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-5">getPod</span><span class="hl-1">(</span><span class="hl-3">&#39;not a pod&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-4">// Fetches all Pods that a user is a member of</span><br/><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-8">userPods</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-5">getUserPods</span><span class="hl-1">(</span><span class="hl-2">userAddress</span><span class="hl-1">);</span><br/><br/><span class="hl-4">// Fetches all Pods that a user is an admin of</span><br/><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-8">adminPods</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-5">getAdminPods</span><span class="hl-1">(</span><span class="hl-2">adminAddress</span><span class="hl-1">);</span>
<pre><code class="language-js"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">getPod</span><span class="hl-1">, </span><span class="hl-2">getUserPods</span><span class="hl-1">, </span><span class="hl-2">getAdminPods</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@orcaprotocol/orca-sdk&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-8">podFromEnsName</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-5">getPod</span><span class="hl-1">(</span><span class="hl-3">&#39;mypod.pod.xyz&#39;</span><span class="hl-1">);</span><br/><span class="hl-4">// ENS names also work for the below.</span><br/><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-8">podFromAddress</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-5">getPod</span><span class="hl-1">(</span><span class="hl-3">&#39;0x123...456&#39;</span><span class="hl-1">);</span><br/><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-8">podFromId</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-5">getPod</span><span class="hl-1">(</span><span class="hl-6">1</span><span class="hl-1">);</span><br/><span class="hl-4">// Returns null</span><br/><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-8">notAPod</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-5">getPod</span><span class="hl-1">(</span><span class="hl-3">&#39;not a pod&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-4">// Fetches all Pods that a user is a member of</span><br/><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-8">userPods</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-5">getUserPods</span><span class="hl-1">(</span><span class="hl-2">userAddress</span><span class="hl-1">);</span><br/><br/><span class="hl-4">// Fetches all Pods that a user is an admin of</span><br/><span class="hl-7">const</span><span class="hl-1"> </span><span class="hl-8">adminPods</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-5">getAdminPods</span><span class="hl-1">(</span><span class="hl-2">adminAddress</span><span class="hl-1">);</span>
</code></pre>

<a href="#types" id="types" style="color: inherit; text-decoration: none;">
Expand Down
Loading

0 comments on commit 5488979

Please sign in to comment.