mjs/cosmjs
mjs/cosmjs
1
0
Fork 0
mirror of https://github.com/cosmos/cosmjs.git synced 2025-03-10 21:49:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add doc comments to pubkeyToRawAddress and pubkeyToAddress

Browse Source
This commit is contained in:
Simon Warta 2022-10-18 14:17:25 +02:00
parent 51a7214d01
commit 01f6e1fffb
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
packages/tendermint-rpc/src/addresses.ts
View File

@ -15,7 +15,15 @@ export function rawSecp256k1PubkeyToRawAddress(pubkeyData: Uint8Array): Uint8Arr
return ripemd160(sha256(pubkeyData));
}
// For secp256k1 this assumes we already have a compressed pubkey.
/**
* Returns Tendermint address as bytes.
*
* This is for addresses that are derived by the Tendermint keypair (typically Ed25519).
* Sometimes those addresses are bech32-encoded and contain the term "cons" in the presix
* ("cosmosvalcons1...").
*
* For secp256k1 this assumes we already have a compressed pubkey, which is the default in Cosmos.
*/
export function pubkeyToRawAddress(type: "ed25519" | "secp256k1", data: Uint8Array): Uint8Array {
switch (type) {
case "ed25519":
@ -28,6 +36,15 @@ export function pubkeyToRawAddress(type: "ed25519" | "secp256k1", data: Uint8Arr
}
}
/**
* Returns Tendermint address in uppercase hex format.
*
* This is for addresses that are derived by the Tendermint keypair (typically Ed25519).
* Sometimes those addresses are bech32-encoded and contain the term "cons" in the presix
* ("cosmosvalcons1...").
*
* For secp256k1 this assumes we already have a compressed pubkey, which is the default in Cosmos.
*/
export function pubkeyToAddress(type: "ed25519" | "secp256k1", data: Uint8Array): string {
return toHex(pubkeyToRawAddress(type, data)).toUpperCase();
}