status-im
/
nim-libp2p
mirror of https://github.com/status-im/nim-libp2p.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
nim-libp2p/move-transport-interop-tests/libp2p/signed_envelope.html

514 lines
44 KiB
HTML
Raw Normal View History

update docs for move-transport-interop-tests
2024-02-26 13:55:24 +00:00
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- Favicon -->
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
<!-- CSS -->
<title>libp2p/signed_envelope</title>
<link rel="stylesheet" type="text/css" href="../nimdoc.out.css">
<script type="text/javascript" src="../dochack.js"></script>
<script type="text/javascript">
function main() {
var pragmaDots = document.getElementsByClassName("pragmadots");
for (var i = 0; i < pragmaDots.length; i++) {
pragmaDots[i].onclick = function(event) {
// Hide tease
event.target.parentNode.style.display = "none";
// Show actual
event.target.parentNode.nextElementSibling.style.display = "inline";
}
}
function switchTheme(e) {
if (e.target.checked) {
document.documentElement.setAttribute('data-theme', 'dark');
localStorage.setItem('theme', 'dark');
} else {
document.documentElement.setAttribute('data-theme', 'light');
localStorage.setItem('theme', 'light');
}
}
const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
if (toggleSwitch !== null) {
toggleSwitch.addEventListener('change', switchTheme, false);
}
var currentTheme = localStorage.getItem('theme');
if (!currentTheme && window.matchMedia('(prefers-color-scheme: dark)').matches) {
currentTheme = 'dark';
}
if (currentTheme) {
document.documentElement.setAttribute('data-theme', currentTheme);
if (currentTheme === 'dark' && toggleSwitch !== null) {
toggleSwitch.checked = true;
}
}
}
window.addEventListener('DOMContentLoaded', main);
</script>
</head>
<body>
<div class="document" id="documentId">
<div class="container">
<h1 class="title">libp2p/signed_envelope</h1>
<div class="row">
<div class="three columns">
<div class="theme-switch-wrapper">
<label class="theme-switch" for="checkbox">
<input type="checkbox" id="checkbox" />
<div class="slider round"></div>
</label>
&nbsp;&nbsp;&nbsp; <em>Dark Mode</em>
</div>
<div id="global-links">
<ul class="simple">
<li>
<a href="../theindex.html">Index</a>
</li>
</ul>
</div>
<div id="searchInputDiv">
Search: <input type="text" id="searchInput"
onkeyup="search()" />
</div>
<div>
Group by:
<select onchange="groupBy(this.value)">
<option value="section">Section</option>
<option value="type">Type</option>
</select>
</div>
<script type="text/javascript">
function main2() {
// Create the slider
var firstSlider = document.getElementsByClassName("theme-switch-wrapper")[0];
var newSlider = document.createRange().createContextualFragment(`
<div class="theme-switch-wrapper">
<label class="theme-switch" for="internalcheckbox">
<input type="checkbox" id="internalcheckbox">
<div class="slider round"></div>
</label>
&nbsp;&nbsp;&nbsp; <em>Internal</em>
</div>
`);
var sliderInst = firstSlider.after(newSlider);
// Restore slider state from storage
var currentMode = localStorage.getItem('privateMode');
if (currentMode == "private") {
document.getElementById("internalcheckbox").checked = true;
} else {
hidePrivateProcs();
}
document.getElementById("internalcheckbox").onclick = togglePrivateProcs;
}
function hidePrivateProcs() {
var toHide = document.getElementsByClassName("tohide");
for (var i = 0; i < toHide.length; i++) {
var pragmas = toHide[i].querySelectorAll("span.Identifier");
var public = false;
for (var z = 0; z < pragmas.length; z++) {
if (pragmas[z].innerText == "public") {
public = true;
break;
}
}
if (public == false) {
toHide[i].style.display = "none";
toHide[i].classList.add("hidden");
links = document.querySelectorAll("a[href='#" + encodeURIComponent(toHide[i].id) + "']");
for (var y = 0; y < links.length; y++) {
links[y].parentNode.style.display = "none";
links[y].parentNode.classList.add("hidden");
}
}
}
// TOC
var nestedSections = document.getElementsByClassName("nested-toc-section");
for (var i = 0; i < nestedSections.length; i++) {
if (nestedSections[i].querySelectorAll("li:not(.hidden)").length == 0) {
nestedSections[i].style.display = "none";
nestedSections[i].classList.add("hidden");
}
}
var sections = document.getElementsByClassName("simple-toc-section");
for (var i = 0; i < sections.length; i++) {
if (sections[i].querySelectorAll(".nested-toc-section:not(.hidden)").length == 0) {
sections[i].parentNode.style.display = "none";
sections[i].parentNode.classList.add("hidden");
}
}
// Sections
var sections = document.getElementsByClassName("section");
for (var i = 0; i < sections.length; i++) {
if (sections[i].querySelectorAll(".item > div").length == 0) continue;
if (sections[i].querySelectorAll(".item > div:not(.hidden)").length == 0) {
sections[i].style.display = "none";
sections[i].classList.add("hidden");
}
}
}
function showPrivateProcs() {
var toHide = Array.from(document.getElementsByClassName("hidden"));
for (var i = 0; i < toHide.length; i++) {
toHide[i].style.display = "";
toHide[i].classList.remove("hidden");
}
}
function togglePrivateProcs() {
if (document.getElementById("internalcheckbox").checked) {
localStorage.setItem('privateMode', 'private');
showPrivateProcs();
} else {
localStorage.setItem('privateMode', 'public');
hidePrivateProcs();
}
}
window.addEventListener("DOMContentLoaded", main2);
</script>
<ul class="simple simple-toc" id="toc-list">
<li>
<a class="reference reference-toplevel" href="#6" id="56">Imports</a>
<ul class="simple simple-toc-section">
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#7" id="57">Types</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#Envelope"
title="Envelope = object
publicKey*: PublicKey
domain*: string
payloadType*: seq[byte]
payload: seq[byte]
signature*: Signature">Envelope</a></li>
<li><a class="reference" href="#EnvelopeError"
title="EnvelopeError = enum
EnvelopeInvalidProtobuf, EnvelopeFieldMissing, EnvelopeInvalidSignature,
EnvelopeWrongType">EnvelopeError</a></li>
<li><a class="reference" href="#SignedPayload"
title="SignedPayload[T] = object
envelope*: Envelope
data*: T">SignedPayload</a></li>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
<ul class="simple simple-toc-section">
<ul class="simple nested-toc-section">decode
<li><a class="reference" href="#decode%2Ctypedesc%5BEnvelope%5D%2Cseq%5Bbyte%5D%2Cstring"
title="decode(T: typedesc[Envelope]; buf: seq[byte]; domain: string): Result[Envelope,
EnvelopeError]">decode(T: typedesc[Envelope]; buf: seq[byte]; domain: string): Result[Envelope,
EnvelopeError]</a></li>
<li><a class="reference" href="#decode%2Ctypedesc%5BSignedPayload%5BT%5D%5D%2Cseq%5Bbyte%5D"
title="decode[T](_: typedesc[SignedPayload[T]]; buffer: seq[byte]): Result[
SignedPayload[T], EnvelopeError]">decode[T](_: typedesc[SignedPayload[T]]; buffer: seq[byte]): Result[
SignedPayload[T], EnvelopeError]</a></li>
</ul>
<ul class="simple nested-toc-section">encode
<li><a class="reference" href="#encode%2CEnvelope"
title="encode(env: Envelope): Result[seq[byte], CryptoError]">encode(env: Envelope): Result[seq[byte], CryptoError]</a></li>
<li><a class="reference" href="#encode%2CSignedPayload%5BT%5D"
title="encode[T](msg: SignedPayload[T]): Result[seq[byte], CryptoError]">encode[T](msg: SignedPayload[T]): Result[seq[byte], CryptoError]</a></li>
</ul>
<ul class="simple nested-toc-section">getField
<li><a class="reference" href="#getField%2CProtoBuffer%2Cint%2CEnvelope%2Cstring"
title="getField(pb: ProtoBuffer; field: int; value: var Envelope; domain: string): ProtoResult[
bool]">getField(pb: ProtoBuffer; field: int; value: var Envelope; domain: string): ProtoResult[
bool]</a></li>
<li><a class="reference" href="#getField%2CProtoBuffer%2Cint%2CSignedPayload%5BT%5D"
title="getField[T](pb: ProtoBuffer; field: int; value: var SignedPayload[T]): ProtoResult[
bool]">getField[T](pb: ProtoBuffer; field: int; value: var SignedPayload[T]): ProtoResult[
bool]</a></li>
</ul>
<ul class="simple nested-toc-section">init
<li><a class="reference" href="#init%2Ctypedesc%5BEnvelope%5D%2CPrivateKey%2Cseq%5Bbyte%5D%2Cseq%5Bbyte%5D%2Cstring"
title="init(T: typedesc[Envelope]; privateKey: PrivateKey; payloadType: seq[byte];
payload: seq[byte]; domain: string): Result[Envelope, CryptoError]">init(T: typedesc[Envelope]; privateKey: PrivateKey; payloadType: seq[byte];
payload: seq[byte]; domain: string): Result[Envelope, CryptoError]</a></li>
<li><a class="reference" href="#init%2Ctypedesc%5BSignedPayload%5BT%5D%5D%2CPrivateKey%2CT"
title="init[T](_: typedesc[SignedPayload[T]]; privateKey: PrivateKey; data: T): Result[
SignedPayload[T], CryptoError]">init[T](_: typedesc[SignedPayload[T]]; privateKey: PrivateKey; data: T): Result[
SignedPayload[T], CryptoError]</a></li>
</ul>
<ul class="simple nested-toc-section">payload
<li><a class="reference" href="#payload%2CEnvelope"
title="payload(env: Envelope): seq[byte]">payload(env: Envelope): seq[byte]</a></li>
</ul>
<ul class="simple nested-toc-section">write
<li><a class="reference" href="#write%2CProtoBuffer%2Cint%2CEnvelope"
title="write(pb: var ProtoBuffer; field: int; env: Envelope): Result[void, CryptoError]">write(pb: var ProtoBuffer; field: int; env: Envelope): Result[void, CryptoError]</a></li>
</ul>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#19" id="69">Exports</a>
<ul class="simple simple-toc-section">
</ul>
</li>
</ul>
</div>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/move-transport-interop-tests/libp2p/signed_envelope.nim#L1"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/signed_envelope.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
<p class="module-desc">This module implements Signed Envelope.</p>
<div class="section" id="6">
<h1><a class="toc-backref" href="#6">Imports</a></h1>
<dl class="item">
<a class="reference external" href="multicodec.html">multicodec</a>, <a class="reference external" href="crypto/crypto.html">crypto/crypto</a>, <a class="reference external" href="protobuf/minprotobuf.html">protobuf/minprotobuf</a>, <a class="reference external" href="vbuffer.html">vbuffer</a>
</dl></div>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<div id="Envelope" class="tohide">
<dt><pre><a href="signed_envelope.html#Envelope"><span class="Identifier">Envelope</span></a> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">publicKey</span><span class="Operator">*</span><span class="Other">:</span> <a href="crypto/crypto.html#PublicKey"><span class="Identifier">PublicKey</span></a>
<span class="Identifier">domain</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">string</span>
<span class="Identifier">payloadType</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span>
<span class="Identifier">payload</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span>
<span class="Identifier">signature</span><span class="Operator">*</span><span class="Other">:</span> <a href="crypto/crypto.html#Signature"><span class="Identifier">Signature</span></a>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/move-transport-interop-tests/libp2p/signed_envelope.nim#L30"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/signed_envelope.nim#L30" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="EnvelopeError" class="tohide">
<dt><pre><a href="signed_envelope.html#EnvelopeError"><span class="Identifier">EnvelopeError</span></a> <span class="Other">=</span> <span class="Keyword">enum</span>
<span class="Identifier">EnvelopeInvalidProtobuf</span><span class="Other">,</span> <span class="Identifier">EnvelopeFieldMissing</span><span class="Other">,</span> <span class="Identifier">EnvelopeInvalidSignature</span><span class="Other">,</span>
<span class="Identifier">EnvelopeWrongType</span></pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/move-transport-interop-tests/libp2p/signed_envelope.nim#L24"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/signed_envelope.nim#L24" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="SignedPayload" class="tohide">
<dt><pre><a href="signed_envelope.html#SignedPayload"><span class="Identifier">SignedPayload</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> <span class="Other">=</span> <span class="Keyword">object</span>
<span class="Identifier">envelope</span><span class="Operator">*</span><span class="Other">:</span> <a href="signed_envelope.html#Envelope"><span class="Identifier">Envelope</span></a>
<span class="Identifier">data</span><span class="Operator">*</span><span class="Other">:</span> <span class="Identifier">T</span>
</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/move-transport-interop-tests/libp2p/signed_envelope.nim#L124"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/signed_envelope.nim#L124" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
</dl></div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<div id="decode,typedesc[Envelope],seq[byte],string" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#decode%2Ctypedesc%5BEnvelope%5D%2Cseq%5Bbyte%5D%2Cstring"><span class="Identifier">decode</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="signed_envelope.html#Envelope"><span class="Identifier">Envelope</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">buf</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">domain</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Result</span><span class="Other">[</span>
<a href="signed_envelope.html#Envelope"><span class="Identifier">Envelope</span></a><span class="Other">,</span> <a href="signed_envelope.html#EnvelopeError"><span class="Identifier">EnvelopeError</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/move-transport-interop-tests/libp2p/signed_envelope.nim#L54"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/signed_envelope.nim#L54" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="decode,typedesc[SignedPayload[T]],seq[byte]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#decode%2Ctypedesc%5BSignedPayload%5BT%5D%5D%2Cseq%5Bbyte%5D"><span class="Identifier">decode</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Operator">_</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="signed_envelope.html#SignedPayload"><span class="Identifier">SignedPayload</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">buffer</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Result</span><span class="Other">[</span>
<a href="signed_envelope.html#SignedPayload"><span class="Identifier">SignedPayload</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">,</span> <a href="signed_envelope.html#EnvelopeError"><span class="Identifier">EnvelopeError</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/move-transport-interop-tests/libp2p/signed_envelope.nim#L151"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/signed_envelope.nim#L151" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="encode,Envelope" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#encode%2CEnvelope"><span class="Identifier">encode</span></a><span class="Other">(</span><span class="Identifier">env</span><span class="Other">:</span> <a href="signed_envelope.html#Envelope"><span class="Identifier">Envelope</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Result</span><span class="Other">[</span><span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">,</span> <a href="crypto/crypto.html#CryptoError"><span class="Identifier">CryptoError</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/move-transport-interop-tests/libp2p/signed_envelope.nim#L88"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/signed_envelope.nim#L88" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="encode,SignedPayload[T]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#encode%2CSignedPayload%5BT%5D"><span class="Identifier">encode</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">msg</span><span class="Other">:</span> <a href="signed_envelope.html#SignedPayload"><span class="Identifier">SignedPayload</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Result</span><span class="Other">[</span><span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">,</span> <a href="crypto/crypto.html#CryptoError"><span class="Identifier">CryptoError</span></a><span class="Other">]</span> {.
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/move-transport-interop-tests/libp2p/signed_envelope.nim#L169"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/signed_envelope.nim#L169" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="getField,ProtoBuffer,int,Envelope,string" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#getField%2CProtoBuffer%2Cint%2CEnvelope%2Cstring"><span class="Identifier">getField</span></a><span class="Other">(</span><span class="Identifier">pb</span><span class="Other">:</span> <a href="protobuf/minprotobuf.html#ProtoBuffer"><span class="Identifier">ProtoBuffer</span></a><span class="Other">;</span> <span class="Identifier">field</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">value</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="signed_envelope.html#Envelope"><span class="Identifier">Envelope</span></a><span class="Other">;</span> <span class="Identifier">domain</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <a href="protobuf/minprotobuf.html#ProtoResult"><span class="Identifier">ProtoResult</span></a><span class="Other">[</span>
<span class="Identifier">bool</span><span class="Other">]</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/move-transport-interop-tests/libp2p/signed_envelope.nim#L106"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/signed_envelope.nim#L106" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="getField,ProtoBuffer,int,SignedPayload[T]" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#getField%2CProtoBuffer%2Cint%2CSignedPayload%5BT%5D"><span class="Identifier">getField</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">pb</span><span class="Other">:</span> <a href="protobuf/minprotobuf.html#ProtoBuffer"><span class="Identifier">ProtoBuffer</span></a><span class="Other">;</span> <span class="Identifier">field</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">value</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="signed_envelope.html#SignedPayload"><span class="Identifier">SignedPayload</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="protobuf/minprotobuf.html#ProtoResult"><span class="Identifier">ProtoResult</span></a><span class="Other">[</span>
<span class="Identifier">bool</span><span class="Other">]</span> {.<span class="Identifier">inline</span><span class="Other">,</span> <span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/move-transport-interop-tests/libp2p/signed_envelope.nim#L141"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/signed_envelope.nim#L141" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="init,typedesc[Envelope],PrivateKey,seq[byte],seq[byte],string" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#init%2Ctypedesc%5BEnvelope%5D%2CPrivateKey%2Cseq%5Bbyte%5D%2Cseq%5Bbyte%5D%2Cstring"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="signed_envelope.html#Envelope"><span class="Identifier">Envelope</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">privateKey</span><span class="Other">:</span> <a href="crypto/crypto.html#PrivateKey"><span class="Identifier">PrivateKey</span></a><span class="Other">;</span> <span class="Identifier">payloadType</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">;</span>
<span class="Identifier">payload</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">domain</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Result</span><span class="Other">[</span><a href="signed_envelope.html#Envelope"><span class="Identifier">Envelope</span></a><span class="Other">,</span> <a href="crypto/crypto.html#CryptoError"><span class="Identifier">CryptoError</span></a><span class="Other">]</span> {.
<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/move-transport-interop-tests/libp2p/signed_envelope.nim#L72"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/signed_envelope.nim#L72" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="init,typedesc[SignedPayload[T]],PrivateKey,T" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#init%2Ctypedesc%5BSignedPayload%5BT%5D%5D%2CPrivateKey%2CT"><span class="Identifier">init</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Operator">_</span><span class="Other">:</span> <span class="Identifier">typedesc</span><span class="Other">[</span><a href="signed_envelope.html#SignedPayload"><span class="Identifier">SignedPayload</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">privateKey</span><span class="Other">:</span> <a href="crypto/crypto.html#PrivateKey"><span class="Identifier">PrivateKey</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Result</span><span class="Other">[</span>
<a href="signed_envelope.html#SignedPayload"><span class="Identifier">SignedPayload</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">,</span> <a href="crypto/crypto.html#CryptoError"><span class="Identifier">CryptoError</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/move-transport-interop-tests/libp2p/signed_envelope.nim#L129"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/signed_envelope.nim#L129" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="payload,Envelope" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#payload%2CEnvelope"><span class="Identifier">payload</span></a><span class="Other">(</span><span class="Identifier">env</span><span class="Other">:</span> <a href="signed_envelope.html#Envelope"><span class="Identifier">Envelope</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><span class="Identifier">byte</span><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/move-transport-interop-tests/libp2p/signed_envelope.nim#L102"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/signed_envelope.nim#L102" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
<div id="write,ProtoBuffer,int,Envelope" class="tohide">
<dt><pre><span class="Keyword">proc</span> <a href="#write%2CProtoBuffer%2Cint%2CEnvelope"><span class="Identifier">write</span></a><span class="Other">(</span><span class="Identifier">pb</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="protobuf/minprotobuf.html#ProtoBuffer"><span class="Identifier">ProtoBuffer</span></a><span class="Other">;</span> <span class="Identifier">field</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">env</span><span class="Other">:</span> <a href="signed_envelope.html#Envelope"><span class="Identifier">Envelope</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">Result</span><span class="Other">[</span><span class="Identifier">void</span><span class="Other">,</span>
<a href="crypto/crypto.html#CryptoError"><span class="Identifier">CryptoError</span></a><span class="Other">]</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
<dd>
&nbsp;&nbsp;<a
href="https://github.com/status-im/nim-libp2p/tree/move-transport-interop-tests/libp2p/signed_envelope.nim#L118"
class="link-seesrc" target="_blank">Source</a>
&nbsp;&nbsp;<a href="https://github.com/status-im/nim-libp2p/edit/devel/libp2p/signed_envelope.nim#L118" class="link-seesrc" target="_blank" >Edit</a>
</dd>
</div>
</dl></div>
<div class="section" id="19">
<h1><a class="toc-backref" href="#19">Exports</a></h1>
<dl class="item">
<a href="crypto/crypto.html#Signature"><span class="Identifier">Signature</span></a>, <a href="crypto/crypto.html#shortLog"><span class="Identifier">shortLog</span></a>, <a href="crypto/crypto.html#toBytes,Signature,openArray[byte]"><span class="Identifier">toBytes</span></a>, <a href="crypto/crypto.html#DigestSheme"><span class="Identifier">DigestSheme</span></a>, <a href="crypto/ecnist.html#ephemeral,EcCurveKind,HmacDrbgContext"><span class="Identifier">ephemeral</span></a>, <a href="crypto/crypto.html#decodeProposal,seq[byte],seq[byte],seq[byte],string,string,string"><span class="Identifier">decodeProposal</span></a>, <a href="crypto/crypto.html#init,typedesc[PrivateKey],SkPrivateKey"><span class="Identifier">init</span></a>, <a href="crypto/crypto.html#getRawBytes"><span class="Identifier">getRawBytes</span></a>, <a href="crypto/crypto.html#sign,PrivateKey,openArray[byte]"><span class="Identifier">sign</span></a>, <a href="crypto/crypto.html#SupportedSchemesInt"><span class="Identifier">SupportedSchemesInt</span></a>, <a href="crypto/crypto.html#macOpenArray.t,Secret,int"><span class="Identifier">macOpenArray</span></a>, <a href="crypto/crypto.html#Secret"><span class="Identifier">Secret</span></a>, <a href="crypto/crypto.html#$"><span class="Identifier">$</span></a>, <a href="crypto/crypto.html#write,ProtoBuffer,int,T"><span class="Identifier">write</span></a>, <a href="crypto/crypto.html#init,typedesc[Signature],string"><span class="Identifier">init</span></a>, <a href="crypto/crypto.html#selectBest,int,string,string"><span class="Identifier">selectBest</span></a>, <a href="crypto/crypto.html#init,typedesc[PublicKey],EdPublicKey"><span class="Identifier">init</span></a>, <a href="crypto/ecnist.html#ECDHEScheme"><span class="Identifier">ECDHEScheme</span></a>, <a href="crypto/ecnist.html#ephemeral,string,HmacDrbgContext"><span class="Identifier">ephemeral</span></a>, <a href="utility.html#withValue.t,,untyped,untyped"><span class="Identifier">withValue</span></a>, <a href="utility.html#safeConvert.t,S"><span class="Identifier">safeConvert</span></a>, <a href="crypto/crypto.html#init,T,string"><span class="Identifier">init</span></a>, <a href="crypto/crypto.html#createExchange,openArray[byte],openArray[byte]"><span class="Identifier">createExchange</span></a>, <a href="crypto/crypto.html#init,typedesc[PrivateKey],string"><span class="Identifier">init</span></a>, <a href="utility.html#withValue.m,,untyped,untyped,untyped"><span class="Identifier">withValue</span></a>, <a href="utility.html#public.t"><span class="Identifier">public</span></a>, <a href="crypto/crypto.html#init,PrivateKey,openArray[byte]"><span class="Identifier">init</span></a>, <a href="crypto/crypto.html#getField,ProtoBuffer,int,T"><span class="Identifier">getField</span></a>, <a href="utility.html#valueOr.t,Option[T],untyped"><span class="Identifier">valueOr</span></a>, <a href="crypto/crypto.html#init,Signature,string"><span class="Identifier">init</span></a>, <a href="crypto/crypto.html#toBytes,PrivateKey,openArray[byte]"><span class="Identifier">toBytes</span></a>, <a href="crypto/crypto.html#random,typedesc[KeyPair],PKScheme,HmacDrbgContext"><span class="Identifier">random</span></a>, <a href="crypto/crypto.html#createProposal,openArray[byte],openArray[byte],string,string,string"><span class="Identifier">createProposal</span></a>, <a href="crypto/crypto.html#init,typedesc[PrivateKey],"><span class="Identifier">init</span></a>, <a href="crypto/crypto.html#getBytes,PublicKey"><span class="Identifier">getBytes</span></a>, <a href="crypto/crypto.html#write,VBuffer,PublicKey"><span class="Identifier">write</span></a>, <a href="utility.html#toOpt.t,Result[T,E]"><span class="Identifier">toOpt</span></a>, <a href="crypto/crypto.html#init,typedesc[PublicKey],string"><span class="Identifier">init</span></a>, <a href="crypto/crypto.html#newRng"><span class="Identifier">newRng</span></a>, <a href="crypto/crypto.html#toRawBytes,,openArray[byte]"><span class="Identifier">toRawBytes</span></a>, <a href="crypto/crypto.html#getPublicKey,PrivateKey"><span class="
</dl></div>
</div>
</div>
<div class="row">
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
update docs for move-transport-interop-tests
2024-02-26 14:54:31 +00:00
<small style="color: var(--hint);">Made with Nim. Generated: 2024-02-26 14:54:23 UTC</small>
update docs for move-transport-interop-tests
2024-02-26 13:55:24 +00:00
</div>
</div>
</div>
</div>
</body>
</html>