@yipsec/rise

Version:

eclipse-resistant network identities

1 lines • 9.84 kB

JSON

{"list":[{"title":"module:rise","link":"<a href=\"module-rise.html\">rise</a>","description":"Rise is a protocol for decentalized, eclipse-resistant identities."},{"title":"module:rise~EncryptedRiseMessage","link":"<a href=\"module-rise-EncryptedRiseMessage.html\">EncryptedRiseMessage</a>","description":"Interface for an encrypted message."},{"title":"module:rise~EncryptedRiseMessage#decrypt","link":"<a href=\"module-rise-EncryptedRiseMessage.html#decrypt\">decrypt</a>","description":"Decrypts the message using the supplied private key."},{"title":"module:rise~RiseIdentity","link":"<a href=\"module-rise-RiseIdentity.html\">RiseIdentity</a>","description":"Rise private identity bundle. This is the primary interface for using\nthis module. Allows to generate new identities and use them as the\ncontext for protected operations."},{"title":"module:rise~RiseIdentity#fingerprint","link":"<a href=\"module-rise-RiseIdentity.html#fingerprint\">fingerprint</a>","description":"160 bit solution hash."},{"title":"module:rise~RiseIdentity#lock","link":"<a href=\"module-rise-RiseIdentity.html#lock\">lock</a>","description":"Creates an encrypted blob representation of this identity, suitable for\npersistance to disk."},{"title":"module:rise~RiseIdentity#message","link":"<a href=\"module-rise-RiseIdentity.html#message\">message</a>","description":"Constructs an encrypted and signed {@link module:rise~RiseMessage} for the given\npublic key."},{"title":"module:rise~RiseIdentity#mnemonic","link":"<a href=\"module-rise-RiseIdentity.html#mnemonic\">mnemonic</a>","description":"BIP39 recovery words."},{"title":"module:rise~RiseIdentity#salt","link":"<a href=\"module-rise-RiseIdentity.html#salt\">salt</a>","description":"Used for local PBKDF2."},{"title":"module:rise~RiseIdentity#secret","link":"<a href=\"module-rise-RiseIdentity.html#secret\">secret</a>","description":"Underlying secret key."},{"title":"module:rise~RiseIdentity#solution","link":"<a href=\"module-rise-RiseIdentity.html#solution\">solution</a>","description":"Underlying equihash solution."},{"title":"module:rise~RiseIdentity#solve","link":"<a href=\"module-rise-RiseIdentity.html#solve\">solve</a>","description":"Creates a new {@link RiseSolution} for this identity. This method updates\nthe internal state and will overwrite any previous solution performed in\nthis context."},{"title":"module:rise~RiseIdentity#toJSON","link":"<a href=\"module-rise-RiseIdentity.html#toJSON\">toJSON</a>","description":"Returns a plain object representation of this identity, serializable to JSON."},{"title":"module:rise~RiseIdentity.K","link":"<a href=\"module-rise-RiseIdentity.html#.K\">K</a>","description":"Equihash K parameter (length)."},{"title":"module:rise~RiseIdentity.MAGIC","link":"<a href=\"module-rise-RiseIdentity.html#.MAGIC\">MAGIC</a>","description":"Rise magic number. Used as message terminator and protocol identitifier."},{"title":"module:rise~RiseIdentity.N","link":"<a href=\"module-rise-RiseIdentity.html#.N\">N</a>","description":"Equihash N parameter (width in bits)."},{"title":"module:rise~RiseIdentity.SALT","link":"<a href=\"module-rise-RiseIdentity.html#.SALT\">SALT</a>","description":"Rise default salt for pbkdf2 operations."},{"title":"module:rise~RiseIdentity.TEST_K","link":"<a href=\"module-rise-RiseIdentity.html#.TEST_K\">TEST_K</a>","description":"Lowered length for testing."},{"title":"module:rise~RiseIdentity.TEST_MAGIC","link":"<a href=\"module-rise-RiseIdentity.html#.TEST_MAGIC\">TEST_MAGIC</a>","description":"Magic number to segment test network."},{"title":"module:rise~RiseIdentity.TEST_N","link":"<a href=\"module-rise-RiseIdentity.html#.TEST_N\">TEST_N</a>","description":"Lowered width for testing."},{"title":"module:rise~RiseIdentity.TEST_Z","link":"<a href=\"module-rise-RiseIdentity.html#.TEST_Z\">TEST_Z</a>","description":"Lowered difficulty for testing."},{"title":"module:rise~RiseIdentity.Z","link":"<a href=\"module-rise-RiseIdentity.html#.Z\">Z</a>","description":"Default difficuly setting. Require this many leading zeroes in solution\nproofs."},{"title":"module:rise~RiseIdentity.generate","link":"<a href=\"module-rise-RiseIdentity.html#.generate\">generate</a>","description":""Mines" a new {@link module:rise~RiseIdentity} and iteratively generates\n{@link module:rise~RiseSolution}s until one is found that satisfies the stated\ndifficulty."},{"title":"module:rise~RiseIdentity.unlock","link":"<a href=\"module-rise-RiseIdentity.html#.unlock\">unlock</a>","description":"Decrypts the blob given the password and creates a new instance."},{"title":"module:rise~RiseMessage","link":"<a href=\"module-rise-RiseMessage.html\">RiseMessage</a>","description":"Interface allowing for authenticated message exchange."},{"title":"module:rise~RiseMessage#body","link":"<a href=\"module-rise-RiseMessage.html#body\">body</a>","description":"Key-value pairs given for the message."},{"title":"module:rise~RiseMessage#encrypt","link":"<a href=\"module-rise-RiseMessage.html#encrypt\">encrypt</a>","description":"Encrypts the message state for the public key provided."},{"title":"module:rise~RiseMessage#head","link":"<a href=\"module-rise-RiseMessage.html#head\">head</a>","description":"Default message headers, plus any custom ones supplied."},{"title":"module:rise~RiseMessage#sign","link":"<a href=\"module-rise-RiseMessage.html#sign\">sign</a>","description":"Signs the message state using the private key provided."},{"title":"module:rise~RiseMessage#toBuffer","link":"<a href=\"module-rise-RiseMessage.html#toBuffer\">toBuffer</a>","description":"Serializes the message to wire format."},{"title":"module:rise~RiseMessage#unwrap","link":"<a href=\"module-rise-RiseMessage.html#unwrap\">unwrap</a>","description":"Returns only the body of this message."},{"title":"module:rise~RiseMessage#validate","link":"<a href=\"module-rise-RiseMessage.html#validate\">validate</a>","description":"Ensures the solution header is valid."},{"title":"module:rise~RiseMessage.fromBuffer","link":"<a href=\"module-rise-RiseMessage.html#.fromBuffer\">fromBuffer</a>","description":"Creates a new message instance from the serialized message."},{"title":"module:rise~RiseMessage~Head","link":"<a href=\"module-rise-RiseMessage.html#~Head\">Head</a>","description":"Protocol headers included in every rise message."},{"title":"module:rise~RiseSecret","link":"<a href=\"module-rise-RiseSecret.html\">RiseSecret</a>","description":"Interface for secp256k1 key pair. If no secret is provided, one will be\ngenerated."},{"title":"module:rise~RiseSecret#decrypt","link":"<a href=\"module-rise-RiseSecret.html#decrypt\">decrypt</a>","description":"Decrypts the given data using the underlying private key."},{"title":"module:rise~RiseSecret#privateKey","link":"<a href=\"module-rise-RiseSecret.html#privateKey\">privateKey</a>","description":"Underlying private key."},{"title":"module:rise~RiseSecret#publicKey","link":"<a href=\"module-rise-RiseSecret.html#publicKey\">publicKey</a>","description":"Public key derived from private key."},{"title":"module:rise~RiseSecret#sign","link":"<a href=\"module-rise-RiseSecret.html#sign\">sign</a>","description":"Creates a digital signature from the provided data."},{"title":"module:rise~RiseSolution","link":"<a href=\"module-rise-RiseSolution.html\">RiseSolution</a>","description":"Interface for identity solutions."},{"title":"module:rise~RiseSolution#difficulty","link":"<a href=\"module-rise-RiseSolution.html#difficulty\">difficulty</a>","description":"Number of leading zeroes in the proof."},{"title":"module:rise~RiseSolution#epoch","link":"<a href=\"module-rise-RiseSolution.html#epoch\">epoch</a>","description":"Network magic number."},{"title":"module:rise~RiseSolution#fingerprint","link":"<a href=\"module-rise-RiseSolution.html#fingerprint\">fingerprint</a>","description":"RIPEMD-160 hash for SHA-256 hash of serialized solution."},{"title":"module:rise~RiseSolution#getProofAsBinaryString","link":"<a href=\"module-rise-RiseSolution.html#getProofAsBinaryString\">getProofAsBinaryString</a>","description":"Represents the proof as a string of 1's and 0's."},{"title":"module:rise~RiseSolution#nonce","link":"<a href=\"module-rise-RiseSolution.html#nonce\">nonce</a>","description":"Solution nonce."},{"title":"module:rise~RiseSolution#proof","link":"<a href=\"module-rise-RiseSolution.html#proof\">proof</a>","description":"Equihash proof."},{"title":"module:rise~RiseSolution#pubkey","link":"<a href=\"module-rise-RiseSolution.html#pubkey\">pubkey</a>","description":"Public key."},{"title":"module:rise~RiseSolution#toJSON","link":"<a href=\"module-rise-RiseSolution.html#toJSON\">toJSON</a>","description":"Serilaizes the solution into a JSON object."},{"title":"module:rise~RiseSolution#verify","link":"<a href=\"module-rise-RiseSolution.html#verify\">verify</a>","description":"Ensures that the solution is valid."},{"title":"module:rise~RiseSolution.fromJSON","link":"<a href=\"module-rise-RiseSolution.html#.fromJSON\">fromJSON</a>","description":"Constructs a {@link RiseSolution} from a JSON object."},{"title":"module:rise~SignedRiseMessage","link":"<a href=\"module-rise-SignedRiseMessage.html\">SignedRiseMessage</a>","description":"Interface for digitall signed rise message"},{"title":"module:rise~SignedRiseMessage#verify","link":"<a href=\"module-rise-SignedRiseMessage.html#verify\">verify</a>","description":"Ensures that the digita signature is valid."}]}