js-libp2p/classes/_record_envelope_index_.envelope.html
2020-12-11 18:28:40 +01:00

490 lines
23 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Envelope | libp2p - v0.30.0-rc.1</title>
<meta name="description" content="Documentation for libp2p - v0.30.0-rc.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<link href="https://unpkg.com/nord-highlightjs@0.1.0/dist/nord.css" rel="stylesheet" type="text/css" />
<style>
.toolbar-icon {
display: inline-block;
vertical-align: middle;
margin-left: 10px;
cursor: pointer;
}
.toolbar-icon-search {
box-sizing: border-box;
position: absolute;
overflow: hidden;
right: -40px;
width: 40px;
height: 40px;
display: flex;
justify-content: center;
align-items: center;
@media (min-width: 901px){
display: none
}
}
@media (min-width: 901px){
.toolbar-icon-menu {
display: none
}
.toolbar-icon-options {
display: none
}
}
.gg-menu {
transform: scale(var(--ggs,1))
}
.gg-menu,
.gg-menu::after,
.gg-menu::before {
box-sizing: border-box;
position: relative;
display: block;
width: 20px;
height: 2px;
border-radius: 3px;
background: currentColor
}
.gg-menu::after,
.gg-menu::before {
content: "";
position: absolute;
top: -6px
}
.gg-menu::after {
top: 6px
}
.gg-options {
box-sizing: border-box;
position: relative;
display: block;
transform: scale(var(--ggs,1));
width: 10px;
height: 2px;
box-shadow:
-3px 4px 0 0,
3px -4px 0 0
}
.gg-options::after,
.gg-options::before {
content: "";
display: block;
box-sizing: border-box;
position: absolute;
width: 8px;
height: 8px;
border: 2px solid;
border-radius: 100%
}
.gg-options::before {
top: -7px;
left: -4px
}
.gg-options::after {
bottom: -7px;
right: -4px
}
.gg-search {
box-sizing: border-box;
position: relative;
display: block;
transform: scale(var(--ggs,1));
width: 16px;
height: 16px;
border: 2px solid;
border-radius: 100%;
margin-left: -4px;
margin-top: -4px
}
.gg-search::after {
content: "";
display: block;
box-sizing: border-box;
position: absolute;
border-radius: 3px;
width: 2px;
height: 8px;
background: currentColor;
transform: rotate(-45deg);
top: 10px;
left: 12px
}
</style>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="toolbar-icon toolbar-icon-search"><i class="gg-search"></i></label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">libp2p - v0.30.0-rc.1</a>
</div>
<div class="table-cell" id="tsd-widgets">
<a href="#" class="toolbar-icon toolbar-icon-menu" data-toggle="menu"><i class="gg-menu"></i></a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules/_record_envelope_index_.html">record/envelope/index</a>
</li>
<li>
<a href="_record_envelope_index_.envelope.html">Envelope</a>
</li>
</ul>
<h1>Class Envelope</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Envelope</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>References</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_record_envelope_index_.envelope.html#record" class="tsd-kind-icon">Record</a></li>
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_record_envelope_index_.envelope.html#createfromprotobuf" class="tsd-kind-icon">create<wbr>From<wbr>Protobuf</a></li>
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_record_envelope_index_.envelope.html#openandcertify" class="tsd-kind-icon">open<wbr>And<wbr>Certify</a></li>
<li class="tsd-kind-reference tsd-parent-kind-class"><a href="_record_envelope_index_.envelope.html#seal" class="tsd-kind-icon">seal</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_record_envelope_index_.envelope.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_record_envelope_index_.envelope.html#_marshal" class="tsd-kind-icon">_marshal</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_record_envelope_index_.envelope.html#payload" class="tsd-kind-icon">payload</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_record_envelope_index_.envelope.html#payloadtype" class="tsd-kind-icon">payload<wbr>Type</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_record_envelope_index_.envelope.html#peerid" class="tsd-kind-icon">peer<wbr>Id</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_record_envelope_index_.envelope.html#signature" class="tsd-kind-icon">signature</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_record_envelope_index_.envelope.html#equals" class="tsd-kind-icon">equals</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_record_envelope_index_.envelope.html#marshal" class="tsd-kind-icon">marshal</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_record_envelope_index_.envelope.html#validate" class="tsd-kind-icon">validate</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>References</h2>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="record" class="tsd-anchor"></a>
<h3>Record</h3>
Re-exports <a href="../modules/_record_envelope_index_.html#record">Record</a>
</section>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="createfromprotobuf" class="tsd-anchor"></a>
<h3>create<wbr>From<wbr>Protobuf</h3>
Re-exports <a href="../modules/_record_envelope_index_.html#createfromprotobuf">createFromProtobuf</a>
</section>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="openandcertify" class="tsd-anchor"></a>
<h3>open<wbr>And<wbr>Certify</h3>
Re-exports <a href="../modules/_record_envelope_index_.html#openandcertify">openAndCertify</a>
</section>
<section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-class">
<a name="seal" class="tsd-anchor"></a>
<h3>seal</h3>
Re-exports <a href="../modules/_record_envelope_index_.html#seal">seal</a>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Envelope<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>payload<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">; </span>payloadType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">; </span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>signature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_record_envelope_index_.envelope.html" class="tsd-signature-type">Envelope</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The Envelope is responsible for keeping an arbitrary signed record
by a libp2p peer.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>payload<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">; </span>payloadType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">; </span>peerId<span class="tsd-signature-symbol">: </span><a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a><span class="tsd-signature-symbol">; </span>signature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>payload<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span></h5>
</li>
<li class="tsd-parameter">
<h5>payload<wbr>Type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span></h5>
</li>
<li class="tsd-parameter">
<h5>peer<wbr>Id<span class="tsd-signature-symbol">: </span><a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a></h5>
</li>
<li class="tsd-parameter">
<h5>signature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_record_envelope_index_.envelope.html" class="tsd-signature-type">Envelope</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="_marshal" class="tsd-anchor"></a>
<h3>_marshal</h3>
<div class="tsd-signature tsd-kind-icon">_marshal<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="payload" class="tsd-anchor"></a>
<h3>payload</h3>
<div class="tsd-signature tsd-kind-icon">payload<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Uint8Array</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="payloadtype" class="tsd-anchor"></a>
<h3>payload<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">payload<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Uint8Array</span></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="peerid" class="tsd-anchor"></a>
<h3>peer<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">peer<wbr>Id<span class="tsd-signature-symbol">:</span> <a href="../modules/_metrics_index_.html#peerid" class="tsd-signature-type">PeerId</a></div>
<aside class="tsd-sources">
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="signature" class="tsd-anchor"></a>
<h3>signature</h3>
<div class="tsd-signature tsd-kind-icon">signature<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Uint8Array</span></div>
<aside class="tsd-sources">
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="equals" class="tsd-anchor"></a>
<h3>equals</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">equals<span class="tsd-signature-symbol">(</span>other<span class="tsd-signature-symbol">: </span><a href="_record_envelope_index_.envelope.html" class="tsd-signature-type">Envelope</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Verifies if the other Envelope is identical to this one.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>other: <a href="_record_envelope_index_.envelope.html" class="tsd-signature-type">Envelope</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="marshal" class="tsd-anchor"></a>
<h3>marshal</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">marshal<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Marshal the envelope content.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Uint8Array</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="validate" class="tsd-anchor"></a>
<h3>validate</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">validate<span class="tsd-signature-symbol">(</span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Validate envelope data signature for the given domain.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>domain: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="current tsd-kind-module">
<a href="../modules/_record_envelope_index_.html">record/envelope/index</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="_record_envelope_index_.envelope.html" class="tsd-kind-icon">Envelope</a>
<ul>
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="_record_envelope_index_.envelope.html#record" class="tsd-kind-icon">Record</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="_record_envelope_index_.envelope.html#createfromprotobuf" class="tsd-kind-icon">create<wbr>From<wbr>Protobuf</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="_record_envelope_index_.envelope.html#openandcertify" class="tsd-kind-icon">open<wbr>And<wbr>Certify</a>
</li>
<li class=" tsd-kind-reference tsd-parent-kind-class">
<a href="_record_envelope_index_.envelope.html#seal" class="tsd-kind-icon">seal</a>
</li>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="_record_envelope_index_.envelope.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_record_envelope_index_.envelope.html#_marshal" class="tsd-kind-icon">_marshal</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_record_envelope_index_.envelope.html#payload" class="tsd-kind-icon">payload</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_record_envelope_index_.envelope.html#payloadtype" class="tsd-kind-icon">payload<wbr>Type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_record_envelope_index_.envelope.html#peerid" class="tsd-kind-icon">peer<wbr>Id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="_record_envelope_index_.envelope.html#signature" class="tsd-kind-icon">signature</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_record_envelope_index_.envelope.html#equals" class="tsd-kind-icon">equals</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_record_envelope_index_.envelope.html#marshal" class="tsd-kind-icon">marshal</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_record_envelope_index_.envelope.html#validate" class="tsd-kind-icon">validate</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/_record_envelope_index_.html#record" class="tsd-kind-icon">Record</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/_record_envelope_index_.html#createfromprotobuf" class="tsd-kind-icon">create<wbr>From<wbr>Protobuf</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/_record_envelope_index_.html#openandcertify" class="tsd-kind-icon">open<wbr>And<wbr>Certify</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a href="../modules/_record_envelope_index_.html#seal" class="tsd-kind-icon">seal</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>