cljs-web3-next.personal
The web3-eth-personal package allows you to interact with the Ethereum node’s accounts.
The web3-eth-personal package allows you to interact with the Ethereum node’s accounts.
ec-recovercljs
(ec-recover web3 & args)Recovers the Ethereum address which was used to sign the given data.
Parameters: web3 - web3 instance signature - String|Object: Either the encoded signature, the v, r, s values as separate parameters, or an object with the following values: messageHash - String: The hash of the given message. r - String: First 32 bytes of the signature s - String: Next 32 bytes of the signature v - String: Recovery value + 27
Returns the Ethereum address used to sign this data.
Recovers the Ethereum address which was used to sign the given data.
Parameters:
web3 - web3 instance
signature - String|Object: Either the encoded signature, the v, r, s values as
separate parameters, or an object with the following
values:
messageHash - String: The hash of the given message.
r - String: First 32 bytes of the signature
s - String: Next 32 bytes of the signature
v - String: Recovery value + 27
Returns the Ethereum address used to sign this data.extendcljs
(extend web3 & args)Allows extending the web3 modules.
Parameters: property - the name of the property to add to the module. if no property is set it will be added to the module directly. methods - array: The array of method descriptions: name - String: Name of the method to add. call - String: The RPC method name. params - Number: (optional) The number of parameters for that function. Default 0. inputFormatter - Array: (optional) Array of inputformatter functions. Each array item responds to a function parameter, so if you want some parameters not to be formatted, add a null instead. outputFormatter - ``Function: (optional) Can be used to format the output of the method.
Allows extending the web3 modules.
Parameters:
property - the name of the property to add to the module.
if no property is set it will be added to the module directly.
methods - array: The array of method descriptions:
name - String: Name of the method to add.
call - String: The RPC method name.
params - Number: (optional) The number of parameters
for that function. Default 0.
inputFormatter - Array: (optional) Array of inputformatter functions.
Each array item responds to a function parameter, so if you want some
parameters not to be formatted, add a null instead.
outputFormatter - ``Function: (optional) Can be used to format the
output of the method.get-prscljs
(get-prs web3)Get the web3-eth-personal package.
Parameter: web3 - web3 instance
Get the web3-eth-personal package. Parameter: web3 - web3 instance
import-raw-keycljs
(import-raw-key web3 & args)Imports the given unencrypted private key (hex string) into the key store, encrypting it with the passphrase.
Parameters: web3 - web3 instance keydata - hex string representing the unencrypted private key passphrase - passphrase callback - callback with error and result as parameters
Returns the address of the new account.
Imports the given unencrypted private key (hex string) into the key store, encrypting it with the passphrase. Parameters: web3 - web3 instance keydata - hex string representing the unencrypted private key passphrase - passphrase callback - callback with error and result as parameters Returns the address of the new account.
list-accountscljs
List accounts available.
Parameter: web3 - web3 instance
Returns all the Ethereum account addresses of all keys in the key store.
Example:
user> (list-accounts web3-instance)
["0x5e97870f263700f46aa00d967821199b9bc5a120",
"0x3d80b31a78c30fc628f20b2c89d7ddbf6e53cedc"]
List accounts available. Parameter: web3 - web3 instance Returns all the Ethereum account addresses of all keys in the key store. Example: user> `(list-accounts web3-instance)` ["0x5e97870f263700f46aa00d967821199b9bc5a120", "0x3d80b31a78c30fc628f20b2c89d7ddbf6e53cedc"]
lock-accountcljs
(lock-account web3 & args)Removes the private key with given address from memory. The account can no longer be used to send transactions.
Parameters: web3 - web3 instance address - address to lock
Removes the private key with given address from memory. The account can no longer be used to send transactions. Parameters: web3 - web3 instance address - address to lock
new-accountcljs
(new-account web3 & args)Creates a new account.
Note: Never call this function over a unsecured Websocket or HTTP provider, as your password will be send in plain text!
Parameters: web3 - web3 instance password - String: The password to encrypt this account with.
Returns: Promise returns Boolean: true if the account was created, otherwise false.
Creates a new account. Note: Never call this function over a unsecured Websocket or HTTP provider, as your password will be send in plain text! Parameters: web3 - web3 instance password - String: The password to encrypt this account with. Returns: Promise returns Boolean: true if the account was created, otherwise false.
send-transactioncljs
(send-transaction web3 & args)Validate the given passphrase and submit transaction.
Parameters:
web3 - web3 instance
transaction - The same argument as for (web3-eth/send-transaction! ...)
and contains the from address. If the passphrase can be
used to decrypt the private key belonging to tx.from the
transaction is verified, signed and send onto the network.
The account is not unlocked globally in the node and cannot
be used in other RPC calls.
passphrase - passphrase
callback - callback with error and result as parameters
Example:
user> (send-transaction web3-instance {:from "0x..." :to "0x"} "password" callback)
Validate the given passphrase and submit transaction.
Parameters:
web3 - web3 instance
transaction - The same argument as for `(web3-eth/send-transaction! ...)`
and contains the from address. If the passphrase can be
used to decrypt the private key belonging to tx.from the
transaction is verified, signed and send onto the network.
The account is not unlocked globally in the node and cannot
be used in other RPC calls.
passphrase - passphrase
callback - callback with error and result as parameters
Example:
user> `(send-transaction web3-instance
{:from "0x..."
:to "0x"}
"password"
callback)`signcljs
(sign web3 & args)Signs data using a specific account.
Note: Sending your account password over an unsecured HTTP RPC connection is highly unsecure.
Parameters: web3 - web3 instance String - Data to sign. If String it will be converted using web3.utils.utf8ToHex. String - Address to sign data with. String - The password of the account to sign data with. Function - (optional) Optional callback, returns an error object as first parameter and the result as second.
Returns: Promise returns String - The signature.
Signs data using a specific account.
Note: Sending your account password over an unsecured HTTP RPC connection is
highly unsecure.
Parameters:
web3 - web3 instance
String - Data to sign. If String it will be converted using
web3.utils.utf8ToHex.
String - Address to sign data with.
String - The password of the account to sign data with.
Function - (optional) Optional callback, returns an error object as first
parameter and the result as second.
Returns:
Promise returns String - The signature.unlock-accountcljs
(unlock-account web3 & args)Unlocks the given account for duration seconds.
Parameters: web3 - web3 instance address - address to unlock passphrase - passphrase duration - time to unlock for in seconds, 0 for indefinitely callback - callback with error and result parameters
Returns boolean as to whether the account was successfully unlocked.
Example:
user> (web3-personal/unlock-account web3-instance account "password" indefinitely callback)
Unlocks the given account for duration seconds.
Parameters:
web3 - web3 instance
address - address to unlock
passphrase - passphrase
duration - time to unlock for in seconds, 0 for indefinitely
callback - callback with error and result parameters
Returns boolean as to whether the account was successfully unlocked.
Example:
user> `(web3-personal/unlock-account web3-instance
account
"password"
indefinitely
callback)`cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close