From 8b2b12041dffd8670a95b4131bbd02de41ab3f34 Mon Sep 17 00:00:00 2001 From: Eric Martindale Date: Fri, 6 Dec 2024 09:32:55 -0800 Subject: [PATCH] Update docs --- docs/Actor.html | 543 ++-- docs/Bitcoin.html | 894 +++---- docs/CLI.html | 166 +- docs/Chain.html | 19 +- docs/Channel.html | 19 +- docs/Circuit.html | 21 +- docs/Collection.html | 19 +- docs/Environment.html | 27 +- docs/Fabric.html | 29 +- docs/Federation.html | 19 +- docs/Filesystem.html | 29 +- docs/HKDF.html | 19 +- docs/HTTPServer.html | 19 +- docs/Hash256.html | 23 +- docs/Identity.html | 23 +- docs/Interface.html | 19 +- docs/Key.html | 21 +- docs/Ledger.html | 1317 +--------- docs/Lightning.html | 21 +- docs/Logger.html | 73 +- docs/Machine.html | 19 +- docs/Message.html | 29 +- docs/Peer.html | 588 ++++- docs/Reader.html | 19 +- docs/Redis.html | 25 +- docs/Remote.html | 35 +- docs/Resource.html | 19 +- docs/Scribe.html | 3367 +------------------------ docs/Script.html | 19 +- docs/Service.html | 300 ++- docs/Session.html | 19 +- docs/Signer.html | 63 +- docs/Snapshot.html | 19 +- docs/Stack.html | 19 +- docs/Stash.html | 19 +- docs/State.html | 347 ++- docs/Store.html | 19 +- docs/Swarm.html | 19 +- docs/Token.html | 315 +++ docs/Tree.html | 19 +- docs/Value.html | 19 +- docs/Vector.html | 19 +- docs/Walker.html | 19 +- docs/Wallet.html | 649 +++-- docs/Worker.html | 19 +- docs/ZMQ.html | 19 +- docs/docco.css | 518 ++++ docs/index.html | 25 +- docs/public/fonts/aller-bold.eot | Bin 0 -> 29804 bytes docs/public/fonts/aller-bold.ttf | Bin 0 -> 66836 bytes docs/public/fonts/aller-bold.woff | Bin 0 -> 33244 bytes docs/public/fonts/aller-light.eot | Bin 0 -> 29509 bytes docs/public/fonts/aller-light.ttf | Bin 0 -> 68620 bytes docs/public/fonts/aller-light.woff | Bin 0 -> 33124 bytes docs/public/fonts/roboto-black.eot | Bin 0 -> 20702 bytes docs/public/fonts/roboto-black.ttf | Bin 0 -> 44828 bytes docs/public/fonts/roboto-black.woff | Bin 0 -> 24536 bytes docs/public/stylesheets/normalize.css | 375 +++ docs/services_bitcoin.js.html | 86 +- docs/services_lightning.js.html | 57 +- docs/services_redis.js.html | 25 +- docs/services_zmq.js.html | 21 +- docs/settings_deprecations.js.html | 19 +- docs/types_actor.js.html | 92 +- docs/types_aggregator.js.html | 28 +- docs/types_app.js.html | 32 +- docs/types_chain.js.html | 19 +- docs/types_channel.js.html | 27 +- docs/types_circuit.js.html | 21 +- docs/types_cli.js.html | 262 +- docs/types_collection.js.html | 19 +- docs/types_compiler.js.html | 31 +- docs/types_contract.js.html | 160 +- docs/types_document.js.html | 19 +- docs/types_entity.js.html | 28 +- docs/types_environment.js.html | 72 +- docs/types_fabric.js.html | 26 +- docs/types_federation.js.html | 21 +- docs/types_filesystem.js.html | 56 +- docs/types_hash256.js.html | 62 +- docs/types_hkdf.js.html | 19 +- docs/types_identity.js.html | 31 +- docs/types_interface.js.html | 19 +- docs/types_key.js.html | 55 +- docs/types_keystore.js.html | 32 +- docs/types_ledger.js.html | 19 +- docs/types_logger.js.html | 37 +- docs/types_machine.js.html | 21 +- docs/types_message.js.html | 59 +- docs/types_node.js.html | 29 +- docs/types_oracle.js.html | 28 +- docs/types_path.js.html | 30 +- docs/types_peer.js.html | 825 +++--- docs/types_reader.js.html | 19 +- docs/types_remote.js.html | 45 +- docs/types_resource.js.html | 19 +- docs/types_router.js.html | 27 +- docs/types_scribe.js.html | 29 +- docs/types_script.js.html | 19 +- docs/types_service.js.html | 117 +- docs/types_session.js.html | 19 +- docs/types_signer.js.html | 19 +- docs/types_snapshot.js.html | 19 +- docs/types_stack.js.html | 19 +- docs/types_state.js.html | 19 +- docs/types_store.js.html | 23 +- docs/types_swap.js.html | 29 +- docs/types_swarm.js.html | 19 +- docs/types_token.js.html | 256 ++ docs/types_tree.js.html | 19 +- docs/types_value.js.html | 19 +- docs/types_vector.js.html | 19 +- docs/types_walker.js.html | 19 +- docs/types_wallet.js.html | 29 +- docs/types_witness.js.html | 19 +- docs/types_worker.js.html | 19 +- package-lock.json | 1998 ++++++--------- package.json | 13 +- reports/install.log | 4 +- types/keystore.js | 4 +- types/store.js | 4 +- 121 files changed, 6031 insertions(+), 9479 deletions(-) create mode 100644 docs/Token.html create mode 100644 docs/docco.css create mode 100644 docs/public/fonts/aller-bold.eot create mode 100644 docs/public/fonts/aller-bold.ttf create mode 100644 docs/public/fonts/aller-bold.woff create mode 100644 docs/public/fonts/aller-light.eot create mode 100644 docs/public/fonts/aller-light.ttf create mode 100644 docs/public/fonts/aller-light.woff create mode 100644 docs/public/fonts/roboto-black.eot create mode 100644 docs/public/fonts/roboto-black.ttf create mode 100644 docs/public/fonts/roboto-black.woff create mode 100644 docs/public/stylesheets/normalize.css create mode 100644 docs/types_token.js.html diff --git a/docs/Actor.html b/docs/Actor.html index e4132cc80..2294bbe56 100644 --- a/docs/Actor.html +++ b/docs/Actor.html @@ -455,7 +455,7 @@

Methods

-

(static) fromAny(input) → {Actor}

+

_readObject(input) → {Object}

@@ -463,7 +463,7 @@

(static) from
- Create an Actor from a variety of formats. + Parse an Object into a corresponding Fabric state.
@@ -515,7 +515,7 @@

Parameters:
- Target Object to create. + Object to read as input. @@ -558,7 +558,7 @@
Parameters:
@@ -589,7 +589,7 @@
Returns:
- Instance of the Actor. + Fabric state.
@@ -600,7 +600,7 @@
Returns:
- Actor + Object
@@ -618,7 +618,7 @@
Returns:
-

(static) randomBytes(countopt) → {Buffer}

+

adopt(changes) → {Actor}

@@ -626,7 +626,7 @@

(static)
- Get a number of random bytes from the runtime environment. + Explicitly adopt a set of JSONPatch-encoded changes.
@@ -650,13 +650,9 @@

Parameters:
Type - Attributes - Default - - Description @@ -666,24 +662,13 @@
Parameters:
- count + changes - Number - - - - - - - - - <optional>
- - + Array @@ -691,14 +676,9 @@
Parameters:
- - - 32 - - - Number of random bytes to retrieve. + List of JSONPatch operations to apply. @@ -741,7 +721,7 @@
Parameters:
@@ -772,7 +752,7 @@
Returns:
- The random bytes. + Instance of the Actor.
@@ -783,7 +763,7 @@
Returns:
- Buffer + Actor
@@ -801,7 +781,7 @@
Returns:
-

_readObject(input) → {Object}

+

commit() → {String}

@@ -809,7 +789,7 @@

_readObjec
- Parse an Object into a corresponding Fabric state. + Resolve the current state to a commitment.
@@ -820,53 +800,118 @@

_readObjec -

Parameters:
- - - - +
-
- - - - - - - - - - -
NameTypeDescription
input - Object - Object to read as input.
+ + +
Source:
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + +
Returns:
+ + +
+ 32-byte ID +
+ + + +
+
+ Type +
+
+ + String + + +
+
+ + + + + + + + + + + + + +

export() → {Object}

+ + + + + + +
+ Export the Actor's state to a standard Object. +
+ + + + + + + @@ -904,7 +949,7 @@
Parameters:
@@ -935,7 +980,7 @@
Returns:
- Fabric state. + Standard object.
@@ -964,7 +1009,7 @@
Returns:
-

adopt(changes) → {Actor}

+

get(path) → {Object}

@@ -972,7 +1017,7 @@

adopt - Explicitly adopt a set of JSONPatch-encoded changes. + Retrieve a value from the Actor's state by JSONPointer path. @@ -1008,13 +1053,13 @@
Parameters:
- changes + path - Array + String @@ -1024,7 +1069,7 @@
Parameters:
- List of JSONPatch operations to apply. + Path to retrieve using JSONPointer. @@ -1067,7 +1112,7 @@
Parameters:
@@ -1098,7 +1143,7 @@
Returns:
- Instance of the Actor. + Value of the path in the Actor's state.
@@ -1109,7 +1154,7 @@
Returns:
- Actor + Object
@@ -1127,7 +1172,7 @@
Returns:
-

commit() → {String}

+

pause() → {Actor}

@@ -1135,7 +1180,7 @@

commit - Resolve the current state to a commitment. + Toggles `status` property to paused. @@ -1181,7 +1226,7 @@

commit @@ -1212,7 +1257,7 @@
Returns:
- 32-byte ID + Instance of the Actor.
@@ -1223,7 +1268,7 @@
Returns:
- String + Actor
@@ -1241,7 +1286,7 @@
Returns:
-

export() → {Object}

+

serialize() → {String}

@@ -1249,7 +1294,7 @@

export - Export the Actor's state to a standard Object. + Serialize the Actor's current state into a JSON-formatted string. @@ -1295,7 +1340,7 @@

export @@ -1325,10 +1370,6 @@

exportReturns:

-
- Standard object. -
-
@@ -1337,7 +1378,7 @@
Returns:
- Object + String
@@ -1355,7 +1396,7 @@
Returns:
-

get(path) → {Object}

+

set(path, value) → {Object}

@@ -1363,7 +1404,7 @@

get - Retrieve a value from the Actor's state by JSONPointer path. + Set a value in the Actor's state by JSONPointer path. @@ -1415,7 +1456,30 @@
Parameters:
- Path to retrieve using JSONPointer. + Path to set using JSONPointer. + + + + + + + value + + + + + + Object + + + + + + + + + + Value to set. @@ -1458,7 +1522,7 @@
Parameters:
@@ -1518,7 +1582,7 @@
Returns:
-

pause() → {Actor}

+

sign() → {Actor}

@@ -1526,7 +1590,7 @@

pause - Toggles `status` property to paused. + Signs the Actor. @@ -1572,7 +1636,7 @@

pause @@ -1602,10 +1666,6 @@

pauseReturns:

-
- Instance of the Actor. -
-
@@ -1632,7 +1692,7 @@
Returns:
-

serialize() → {String}

+

toBuffer() → {Buffer}

@@ -1640,7 +1700,7 @@

serialize - Serialize the Actor's current state into a JSON-formatted string. + Casts the Actor to a normalized Buffer. @@ -1686,7 +1746,7 @@

serialize @@ -1724,7 +1784,7 @@
Returns:
- String + Buffer
@@ -1742,7 +1802,7 @@
Returns:
-

set(path, value) → {Object}

+

toGenericMessage() → {Object}

@@ -1750,7 +1810,14 @@

set - Set a value in the Actor's state by JSONPointer path. + Casts the Actor to a generic message, used to uniquely identify the Actor's state. + Fields: + - `preimage`: JSON.stringify(state) + - `hash`: SHA256(preimage) + - `type`: 'FabricActorState' + - `version`: 1 (for now) + - `object`: state + - `parent`: null (for now) @@ -1761,78 +1828,6 @@

set - - - - Name - - - Type - - - - - - Description - - - - - - - - - path - - - - - - String - - - - - - - - - - Path to set using JSONPointer. - - - - - - - value - - - - - - Object - - - - - - - - - - Value to set. - - - - - - - @@ -1868,7 +1863,7 @@
Parameters:
@@ -1877,6 +1872,15 @@
Parameters:
+
See:
+
+ +
+

@@ -1899,7 +1903,7 @@
Returns:
- Value of the path in the Actor's state. + Generic message object.
@@ -1928,7 +1932,7 @@
Returns:
-

sign() → {Actor}

+

toObject() → {Object}

@@ -1936,7 +1940,7 @@

sign - Signs the Actor. + Returns the Actor's current state as an Object. @@ -1982,7 +1986,7 @@

sign @@ -2020,7 +2024,7 @@
Returns:
- Actor + Object
@@ -2038,7 +2042,7 @@
Returns:
-

toBuffer() → {Buffer}

+

unpause() → {Actor}

@@ -2046,7 +2050,7 @@

toBuffer - Casts the Actor to a normalized Buffer. + Toggles `status` property to unpaused. @@ -2092,7 +2096,7 @@

toBuffer @@ -2122,6 +2126,10 @@

toBufferReturns:

+
+ Instance of the Actor. +
+
@@ -2130,7 +2138,7 @@
Returns:
- Buffer + Actor
@@ -2148,7 +2156,7 @@
Returns:
-

toGenericMessage() → {Object}

+

value(formatopt) → {Object}

@@ -2156,7 +2164,7 @@

toGen
- Casts the Actor to a generic message. + Get the inner value of the Actor with an optional cast type.
@@ -2167,90 +2175,80 @@

toGen +

Parameters:
+ + + - -
- - - - - - - - - - - - - - - +
+ + + + + + + -
Source:
-
- -
+ + + + + -
- Generic message object. -
+ + + +
NameTypeAttributesDefaultDescription
format + String - + + <optional>
+ 		+ object -
Returns:
+ 		Cast the value to one of: `buffer, hex, json, string`
-
-
- Type -
-
- Object -
-
+
@@ -2262,16 +2260,12 @@
Returns:
-

toObject() → {Object}

-
- Returns the Actor's current state as an Object. -
@@ -2281,14 +2275,22 @@

toObjectSource: +
+ +
-
+
@@ -2304,22 +2306,26 @@

toObjectReturns:

+
+ Inner value of the Actor as an Object, or cast to the requested `format`. +
+
+
+ Type +
+
+ Object -
Source:
-
-
+
@@ -2327,68 +2333,78 @@

toObject +

(static) fromAny(input) → {Actor}

+
+ Create an Actor from a variety of formats. +
-
Returns:
-
-
- Type -
-
- Object +
Parameters:
-
-
+ + + + + + + + + + -

unpause() → {Actor}

+ + + + + +
NameTypeDescription
input + Object -
- Toggles `status` property to unpaused. -
+ + 		Target Object to create.
@@ -2426,7 +2442,7 @@

unpause @@ -2457,7 +2473,7 @@
Returns:
- Instance of the Actor. + Instance of the Actor.
@@ -2486,7 +2502,7 @@
Returns:
-

value(formatopt) → {Object}

+

(static) randomBytes(countopt) → {Buffer}

@@ -2494,7 +2510,7 @@

value - Get the inner value of the Actor with an optional cast type. + Get a number of random bytes from the runtime environment. @@ -2534,13 +2550,13 @@
Parameters:
- format + count - String + Number @@ -2561,12 +2577,12 @@
Parameters:
- object + 32 - Cast the value to one of: `buffer, hex, json, string` + Number of random bytes to retrieve. @@ -2609,7 +2625,7 @@
Parameters:
@@ -2640,7 +2656,7 @@
Returns:
- Inner value of the Actor as an Object, or cast to the requested `format`. + The random bytes.
@@ -2651,7 +2667,7 @@
Returns:
- Object + Buffer
@@ -2681,44 +2697,32 @@

Home

Classes

@@ -3279,34 +140,24 @@
Parameters:
+ -
Returns:
-
- Store-able blob. -
-
-
- Type -
-
- Buffer -
-
+

Methods

@@ -3314,7 +165,7 @@
Returns:
-

set(path) → {Mixed}

+

inherits(scribe) → {Scribe}

@@ -3322,7 +173,7 @@

set - Set a key in the State to a particular value. + Use an existing Scribe instance as a parent. @@ -3358,13 +209,13 @@
Parameters:
- path + scribe - Path + Scribe @@ -3374,7 +225,7 @@
Parameters:
- Key to retrieve. + Instance of Scribe to use as parent. @@ -3395,15 +246,6 @@
Parameters:
-
Overrides:
-
- -
- @@ -3426,7 +268,7 @@
Parameters:
@@ -3456,6 +298,10 @@
Parameters:
Returns:
+
+ The configured instance of the Scribe. +
+
@@ -3464,98 +310,10 @@
Returns:
- Mixed - - -
-
- - - - - - - - - - - - - -

toHTML()

- - - - - - -
- Converts the State to an HTML document. -
- - - - - - - - - - - - - -
- - - - - - - - -
Overrides:
-
- -
- - - - - - - - - - - - - - - - - + Scribe -
Source:
-
-
- - - - - - -
@@ -3570,20 +328,7 @@

toHTMLtoString() → {String}

+

now() → {Number}

@@ -3591,7 +336,7 @@

toString - Unmarshall an existing state to an instance of a Blob. + Retrives the current timestamp, in milliseconds. @@ -3615,15 +360,6 @@

toStringOverrides: -
- -
- @@ -3646,7 +382,7 @@

toString @@ -3677,7 +413,7 @@
Returns:
- Serialized Blob. + Number representation of the millisecond Integer value.
@@ -3688,7 +424,7 @@
Returns:
- String + Number
@@ -3809,7 +545,7 @@
Parameters:
@@ -3881,44 +617,32 @@

Home

Classes