Skip to content

Commit

Permalink
documentation (#751)
Browse files Browse the repository at this point in the history
* documentation

* update: address comments

* update: address comments

* clean: imports
  • Loading branch information
anondev2323 authored Jul 10, 2023
1 parent 434fd79 commit fbdc118
Show file tree
Hide file tree
Showing 225 changed files with 7,841 additions and 4,462 deletions.
2 changes: 1 addition & 1 deletion docs/assets/search.js

Large diffs are not rendered by default.

89 changes: 60 additions & 29 deletions docs/classes/AptosContext.html

Large diffs are not rendered by default.

354 changes: 260 additions & 94 deletions docs/classes/EthContext.html

Large diffs are not rendered by default.

405 changes: 405 additions & 0 deletions docs/classes/EthContracts.html

Large diffs are not rendered by default.

936 changes: 936 additions & 0 deletions docs/classes/SeiContext.html

Large diffs are not rendered by default.

336 changes: 232 additions & 104 deletions docs/classes/SolanaContext.html

Large diffs are not rendered by default.

255 changes: 103 additions & 152 deletions docs/classes/SuiContext.html

Large diffs are not rendered by default.

333 changes: 237 additions & 96 deletions docs/classes/WormholeContext.html

Large diffs are not rendered by default.

38 changes: 25 additions & 13 deletions docs/enums/Context.html

Large diffs are not rendered by default.

15 changes: 10 additions & 5 deletions docs/enums/NftBridgeGovernanceAction.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<li><a href="NftBridgeGovernanceAction.html">NftBridgeGovernanceAction</a></li></ul>
<h1>Enumeration NftBridgeGovernanceAction</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/barnjamin/wormhole-connect/blob/ffd1682/sdk/src/vaa/nftBridge.ts#L15">sdk/src/vaa/nftBridge.ts:15</a></li></ul></aside>
<li>Defined in <a href="https://github.com/wormhole-foundation/wormhole-connect/blob/c930a2c/sdk/src/vaa/nftBridge.ts#L15">sdk/src/vaa/nftBridge.ts:15</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand All @@ -33,12 +33,12 @@ <h2>Enumeration Members</h2>
<h3 class="tsd-anchor-link"><span>Register<wbr/>Chain</span><a href="#RegisterChain" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">Register<wbr/>Chain</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/barnjamin/wormhole-connect/blob/ffd1682/sdk/src/vaa/nftBridge.ts#L16">sdk/src/vaa/nftBridge.ts:16</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/wormhole-foundation/wormhole-connect/blob/c930a2c/sdk/src/vaa/nftBridge.ts#L16">sdk/src/vaa/nftBridge.ts:16</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="UpgradeContract" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Upgrade<wbr/>Contract</span><a href="#UpgradeContract" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-enum-member">Upgrade<wbr/>Contract</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">2</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/barnjamin/wormhole-connect/blob/ffd1682/sdk/src/vaa/nftBridge.ts#L17">sdk/src/vaa/nftBridge.ts:17</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/wormhole-foundation/wormhole-connect/blob/c930a2c/sdk/src/vaa/nftBridge.ts#L17">sdk/src/vaa/nftBridge.ts:17</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down Expand Up @@ -70,11 +70,14 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="TokenBridgePayload.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Token<wbr/>Bridge<wbr/>Payload</span></a></li>
<li><a href="../classes/AptosContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Aptos<wbr/>Context</span></a></li>
<li><a href="../classes/EthContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Eth<wbr/>Context</span></a></li>
<li><a href="../classes/EthContracts.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Eth<wbr/>Contracts</span></a></li>
<li><a href="../classes/SeiContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Sei<wbr/>Context</span></a></li>
<li><a href="../classes/SolanaContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Solana<wbr/>Context</span></a></li>
<li><a href="../classes/SuiContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Sui<wbr/>Context</span></a></li>
<li><a href="../classes/WormholeContext.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Wormhole<wbr/>Context</span></a></li>
<li><a href="../interfaces/AssetMeta.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Asset<wbr/>Meta</span></a></li>
<li><a href="../interfaces/CoreContractUpgrade.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Core<wbr/>Contract<wbr/>Upgrade</span></a></li>
<li><a href="../interfaces/CosmosAssetInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Cosmos<wbr/>Asset<wbr/>Info</span></a></li>
<li><a href="../interfaces/Governance.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Governance</span></a></li>
<li><a href="../interfaces/GuardianSetUpgrade.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Guardian<wbr/>Set<wbr/>Upgrade</span></a></li>
<li><a href="../interfaces/GuardianSignature.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Guardian<wbr/>Signature</span></a></li>
Expand All @@ -89,13 +92,14 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../interfaces/ParsedNftBridgeRegisterChainVaa.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Parsed<wbr/>Nft<wbr/>Bridge<wbr/>Register<wbr/>Chain<wbr/>Vaa</span></a></li>
<li><a href="../interfaces/ParsedNftBridgeUpgradeContractVaa.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Parsed<wbr/>Nft<wbr/>Bridge<wbr/>Upgrade<wbr/>Contract<wbr/>Vaa</span></a></li>
<li><a href="../interfaces/ParsedNftTransferVaa.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Parsed<wbr/>Nft<wbr/>Transfer<wbr/>Vaa</span></a></li>
<li><a href="../interfaces/ParsedRelayerMessage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Parsed<wbr/>Relayer<wbr/>Message</span></a></li>
<li><a href="../interfaces/ParsedRelayerPayload.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Parsed<wbr/>Relayer<wbr/>Payload</span></a></li>
<li><a href="../interfaces/ParsedTokenBridgeRegisterChainVaa.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Parsed<wbr/>Token<wbr/>Bridge<wbr/>Register<wbr/>Chain<wbr/>Vaa</span></a></li>
<li><a href="../interfaces/ParsedTokenBridgeUpgradeContractVaa.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Parsed<wbr/>Token<wbr/>Bridge<wbr/>Upgrade<wbr/>Contract<wbr/>Vaa</span></a></li>
<li><a href="../interfaces/ParsedTokenTransferVaa.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Parsed<wbr/>Token<wbr/>Transfer<wbr/>Vaa</span></a></li>
<li><a href="../interfaces/ParsedVaa.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Parsed<wbr/>Vaa</span></a></li>
<li><a href="../interfaces/PortalContractUpgrade.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Portal<wbr/>Contract<wbr/>Upgrade</span></a></li>
<li><a href="../interfaces/PortalRegisterChain.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Portal<wbr/>Register<wbr/>Chain</span></a></li>
<li><a href="../interfaces/SeiTransaction.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Sei<wbr/>Transaction</span></a></li>
<li><a href="../interfaces/Signature.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Signature</span></a></li>
<li><a href="../interfaces/TokenBridgeAttestMeta.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Token<wbr/>Bridge<wbr/>Attest<wbr/>Meta</span></a></li>
<li><a href="../interfaces/TokenBridgeRegisterChain.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Token<wbr/>Bridge<wbr/>Register<wbr/>Chain</span></a></li>
Expand All @@ -112,15 +116,16 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../types/ChainContracts.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Chain<wbr/>Contracts</span></a></li>
<li><a href="../types/ChainId.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Chain<wbr/>Id</span></a></li>
<li><a href="../types/ChainName.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Chain<wbr/>Name</span></a></li>
<li><a href="../types/ChainResourceMap.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Chain<wbr/>Resource<wbr/>Map</span></a></li>
<li><a href="../types/ContractUpgrade.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Contract<wbr/>Upgrade</span></a></li>
<li><a href="../types/Contracts.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Contracts</span></a></li>
<li><a href="../types/Encoding.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Encoding</span></a></li>
<li><a href="../types/MainnetChainId.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Mainnet<wbr/>Chain<wbr/>Id</span></a></li>
<li><a href="../types/MainnetChainName.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Mainnet<wbr/>Chain<wbr/>Name</span></a></li>
<li><a href="../types/ParsedAttestMetaVaa.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Parsed<wbr/>Attest<wbr/>Meta<wbr/>Vaa</span></a></li>
<li><a href="../types/ParsedRelayerMessage.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Parsed<wbr/>Relayer<wbr/>Message</span></a></li>
<li><a href="../types/Payload.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Payload</span></a></li>
<li><a href="../types/RedeemResult.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Redeem<wbr/>Result</span></a></li>
<li><a href="../types/Rpcs.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Rpcs</span></a></li>
<li><a href="../types/SendResult.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Send<wbr/>Result</span></a></li>
<li><a href="../types/SignedVaa.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Signed<wbr/>Vaa</span></a></li>
<li><a href="../types/TestnetChainContracts.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Testnet<wbr/>Chain<wbr/>Contracts</span></a></li>
Expand Down
Loading

0 comments on commit fbdc118

Please sign in to comment.