graphenebase.account module¶
-
class
graphenebase.account.
Address
(address, prefix=None)¶ Bases:
graphenebase.prefix.Prefix
Address class
This class serves as an address representation for Public Keys.
Parameters: - address (str) – Base58 encoded address (defaults to
None
) - pubkey (str) – Base58 encoded pubkey (defaults to
None
) - prefix (str) – Network prefix (defaults to
GPH
)
Example:
Address("GPHFN9r6VYzBK8EKtMewfNbfiGCr56pHDBFi")
-
classmethod
from_pubkey
(pubkey, compressed=True, version=56, prefix=None)¶ Load an address provided the public key.
Version: 56 => PTS
- address (str) – Base58 encoded address (defaults to
-
class
graphenebase.account.
BitcoinAddress
(address, prefix=None)¶ Bases:
graphenebase.account.Address
-
classmethod
from_pubkey
(pubkey, compressed=False, version=56, prefix=None)¶ Load an address provided the public key.
Version: 56 => PTS
-
classmethod
-
class
graphenebase.account.
BitcoinPublicKey
(pk, prefix=None)¶ Bases:
graphenebase.account.PublicKey
-
address
¶ Obtain a GrapheneAddress from a public key
-
-
class
graphenebase.account.
BrainKey
(brainkey=None, sequence=0, prefix=None)¶ Bases:
graphenebase.prefix.Prefix
Brainkey implementation similar to the graphene-ui web-wallet.
Parameters: - brainkey (str) – Brain Key
- sequence (int) – Sequence number for consecutive keys
Keys in Graphene are derived from a seed brain key which is a string of 16 words out of a predefined dictionary with 49744 words. It is a simple single-chain key derivation scheme that is not compatible with BIP44 but easy to use.
Given the brain key, a private key is derived as:
privkey = SHA256(SHA512(brainkey + " " + sequence))
Incrementing the sequence number yields a new key that can be regenerated given the brain key.
-
get_blind_private
()¶ Derive private key from the brain key (and no sequence number)
-
get_brainkey
()¶ Return brain key of this instance
-
get_private
()¶ Derive private key from the brain key and the current sequence number
-
get_private_key
()¶
-
get_public
()¶
-
get_public_key
()¶
-
next_sequence
()¶ Increment the sequence number by 1
-
normalize
(brainkey)¶ Correct formating with single whitespace syntax and no trailing space
-
static
suggest
()¶ Suggest a new random brain key. Randomness is provided by the operating system using
os.urandom()
.
-
class
graphenebase.account.
GrapheneAddress
(address, prefix=None)¶ Bases:
graphenebase.account.Address
Graphene Addresses are different. Hence we have a different class
-
classmethod
from_pubkey
(pubkey, compressed=True, version=56, prefix=None)¶ Load an address provided the public key.
Version: 56 => PTS
-
classmethod
-
class
graphenebase.account.
PasswordKey
(account, password, role='active', prefix=None)¶ Bases:
graphenebase.prefix.Prefix
This class derives a private key given the account name, the role and a password. It leverages the technology of Brainkeys and allows people to have a secure private key by providing a passphrase only.
-
get_private
()¶ Derive private key from the brain key and the current sequence number
-
get_private_key
()¶
-
get_public
()¶
-
get_public_key
()¶
-
-
class
graphenebase.account.
PrivateKey
(wif=None, prefix=None)¶ Bases:
graphenebase.prefix.Prefix
Derives the compressed and uncompressed public keys and constructs two instances of
PublicKey
:Parameters: - wif (str) – Base58check-encoded wif key
- prefix (str) – Network prefix (defaults to
GPH
)
Example::
PrivateKey("5HqUkGuo62BfcJU5vNhTXKJRXuUi9QSE6jp8C3uBJ2BVHtB8WSd")
Compressed vs. Uncompressed:
PrivateKey("w-i-f").pubkey
:- Instance of
PublicKey
using compressed key.
PrivateKey("w-i-f").pubkey.address
:- Instance of
Address
using compressed key.
PrivateKey("w-i-f").uncompressed
:- Instance of
PublicKey
using uncompressed key.
PrivateKey("w-i-f").uncompressed.address
:- Instance of
Address
using uncompressed key.
-
address
¶
-
bitcoin
¶
-
child
(offset256)¶ Derive new private key from this key and a sha256 “offset”
-
compressed
¶
-
derive_from_seed
(offset)¶ Derive private key using “generate_from_seed” method. Here, the key itself serves as a seed, and offset is expected to be a sha256 digest.
-
derive_private_key
(sequence)¶ Derive new private key from this private key and an arbitrary sequence number
-
get_secret
()¶ Get sha256 digest of the wif key.
-
pubkey
¶
-
uncompressed
¶
-
class
graphenebase.account.
PublicKey
(pk, prefix=None)¶ Bases:
graphenebase.prefix.Prefix
This class deals with Public Keys and inherits
Address
.Parameters: - pk (str) – Base58 encoded public key
- prefix (str) – Network prefix (defaults to
GPH
)
Example::
PublicKey("GPH6UtYWWs3rkZGV8JA86qrgkG6tyFksgECefKE1MiH4HkLD8PFGL")
Note
By default, graphene-based networks deal with compressed public keys. If an uncompressed key is required, the method
unCompressed
can be used:PublicKey("xxxxx").unCompressed()
-
add
(digest256)¶ Derive new public key from this key and a sha256 “digest”
-
address
¶ Obtain a GrapheneAddress from a public key
-
child
(offset256)¶ Derive new public key from this key and a sha256 “offset”
-
compressed
()¶ returns the compressed key
-
compressed_key
¶
-
classmethod
from_privkey
(privkey, prefix=None)¶ Derive uncompressed public key
-
point
()¶ Return the point for the public key
-
pubkey
¶
-
unCompressed
()¶ Alias for self.uncompressed() - LEGACY
-
uncompressed
()¶ Derive uncompressed key