ripple-address-codec

What is ripple-address-codec?

The ripple-address-codec npm package provides utilities for encoding and decoding Ripple (XRP) addresses. It is useful for developers working with the Ripple network who need to handle address validation, encoding, and decoding.

What are ripple-address-codec's main functionalities?

Encoding a Ripple Address

This feature allows you to encode a Ripple account ID into a standard Ripple address format. The `encodeAccountID` function takes a Buffer containing the account ID and returns the encoded address.

const { encodeAccountID } = require('ripple-address-codec');
const accountID = Buffer.from('rippleAccountID', 'hex');
const encodedAddress = encodeAccountID(accountID);
console.log(encodedAddress);

Decoding a Ripple Address

This feature allows you to decode a Ripple address back into its original account ID. The `decodeAccountID` function takes a Ripple address string and returns a Buffer containing the decoded account ID.

const { decodeAccountID } = require('ripple-address-codec');
const rippleAddress = 'rippleAddressString';
const decodedAccountID = decodeAccountID(rippleAddress);
console.log(decodedAccountID.toString('hex'));

Validating a Ripple Address

This feature allows you to validate whether a given string is a valid Ripple address. The `isValidClassicAddress` function takes a Ripple address string and returns a boolean indicating its validity.

const { isValidClassicAddress } = require('ripple-address-codec');
const rippleAddress = 'rippleAddressString';
const isValid = isValidClassicAddress(rippleAddress);
console.log(isValid);

Other packages similar to ripple-address-codec

ripple-lib

The ripple-lib package is a comprehensive library for interacting with the Ripple network. It includes functionalities for address encoding/decoding, transaction signing, and network communication. Compared to ripple-address-codec, ripple-lib offers a broader range of features beyond just address handling.

xrpl

The xrpl package is another library for interacting with the XRP Ledger. It provides tools for address encoding/decoding, transaction management, and ledger querying. Similar to ripple-lib, xrpl offers a more extensive set of functionalities compared to ripple-address-codec.

README

ripple-address-codec

API

> var api = require('ripple-address-codec');
> api.decodeSeed('sEdTM1uX8pu2do5XvTnutH6HsouMaM2')
{ version: [ 1, 225, 75 ],
  bytes: [ 76, 58, 29, 33, 63, 189, 251, 20, 199, 194, 141, 96, 148, 105, 179, 65 ],
  type: 'ed25519' }
> api.decodeSeed('sn259rEFXrQrWyx3Q7XneWcwV6dfL')
{ version: 33,
  bytes: [ 207, 45, 227, 120, 251, 221, 126, 46, 232, 125, 72, 109, 251, 90, 123, 255 ],
  type: 'secp256k1' }
> api.decodeAccountID('rJrRMgiRgrU6hDF4pgu5DXQdWyPbY35ErN')
[ 186,
  142,
  120,
  98,
  110,
  228,
  44,
  65,
  180,
  109,
  70,
  195,
  4,
  141,
  243,
  161,
  195,
  200,
  112,
  114 ]

And ?? There's more to the wonderful world then ripple

We give you the kitchen sink.

> console.log(api)
{ Codec: [Function: AddressCodec],
  codecs:
   { bitcoin:
      { alphabet: '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz',
        codec: [Object],
        base: 58 },
     ripple:
      { alphabet: 'rpshnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCg65jkm8oFqi1tuvAxyz',
        codec: [Object],
        base: 58 },
     tipple:
      { alphabet: 'RPShNAF39wBUDnEGHJKLM4pQrsT7VWXYZ2bcdeCg65jkm8ofqi1tuvaxyz',
        codec: [Object],
        base: 58 },
     stellar:
      { alphabet: 'gsphnaf39wBUDNEGHJKLM4PQRST7VWXYZ2bcdeCr65jkm8oFqi1tuvAxyz',
        codec: [Object],
        base: 58 } },
  decode: [Function: decode],
  encode: [Function: encode],
  decodeEdSeed: [Function],
  encodeEdSeed: [Function],
  isValidEdSeed: [Function],
  decodeSeed: [Function],
  encodeSeed: [Function],
  isValidSeed: [Function],
  decodeAccountID: [Function],
  encodeAccountID: [Function],
  isValidAccountID: [Function],
  decodeAddress: [Function],
  encodeAddress: [Function],
  isValidAddress: [Function],
  decodeNodePublic: [Function],
  encodeNodePublic: [Function],
  isValidNodePublic: [Function],
  decodeNodePrivate: [Function],
  encodeNodePrivate: [Function],
  isValidNodePrivate: [Function],
  decodeK256Seed: [Function],
  encodeK256Seed: [Function],
  isValidK256Seed: [Function] }

Decode a bip32 bitcoin public key

var pubVersion = [0x04, 0x88, 0xB2, 0x1E];
var options = {version: pubVersion, alphabet: 'bitcoin'};
var key = 'xpub661MyMwAqRbcEYS8w7XLSVeEsBXy79zSzH1J8vCdxAZningWLdN3zgtU6LBpB85b3D2yc8sfvZU521AAwdZafEz7mnzBBsz4wKY5e4cp9LB';
var decoded = api.decode(key, options);
var reencoded = api.encode(decoded, options);
console.log(key);
// 'xpub661MyMwAqRbcEYS8w7XLSVeEsBXy79zSzH1J8vCdxAZningWLdN3zgtU6LBpB85b3D2yc8sfvZU521AAwdZafEz7mnzBBsz4wKY5e4cp9LB'
console.log(reencoded);
// 'xpub661MyMwAqRbcEYS8w7XLSVeEsBXy79zSzH1J8vCdxAZningWLdN3zgtU6LBpB85b3D2yc8sfvZU521AAwdZafEz7mnzBBsz4wKY5e4cp9LB'