xrpl 1.0.0-mpt-beta

package/src/Wallet/rfc1751.ts

@@ -0,0 +1,219 @@
+/* eslint-disable @typescript-eslint/no-magic-numbers -- Doing many bitwise operations which need specific numbers */
+/* eslint-disable no-bitwise -- Bitwise operators are required for this encoding/decoding */
+/* eslint-disable id-length -- Bitwise math uses shorthand terms */
+/*
+ *rfc1751.ts : Converts between 128-bit strings and a human-readable
+ *sequence of words, as defined in RFC1751: "A Convention for
+ *Human-Readable 128-bit Keys", by Daniel L. McDonald.
+ *Ported from rfc1751.py / Python Cryptography Toolkit (public domain).
+ *Copied from https://github.com/bip32/bip32.github.io/blob/master/js/rfc1751.js which
+ *is part of the public domain.
+ */
+
+import { hexToBytes, concat } from '@xrplf/isomorphic/utils'
+
+import rfc1751Words from './rfc1751Words.json'
+
+const rfc1751WordList: string[] = rfc1751Words
+
+// Added prettier-ignore to allow _BINARY to be on two lines, instead of one entry per line.
+
+// prettier-ignore
+const BINARY = ['0000', '0001', '0010', '0011', '0100', '0101', '0110', '0111',
+                '1000', '1001', '1010', '1011', '1100', '1101', '1110', '1111'];
+
+/**
+ * Convert a number array into a binary string.
+ *
+ * @param key - An array of numbers in base 10.
+ * @returns A binary string.
+ */
+function keyToBinary(key: number[]): string {
+  let res = ''
+  for (const num of key) {
+    res += BINARY[num >> 4] + BINARY[num & 0x0f]
+  }
+  return res
+}
+
+/**
+ * Converts a substring of an encoded secret to its numeric value.
+ *
+ * @param key - The encoded secret.
+ * @param start - The start index to parse from.
+ * @param length - The number of digits to parse after the start index.
+ * @returns The binary value of the substring.
+ */
+function extract(key: string, start: number, length: number): number {
+  const subKey = key.substring(start, start + length)
+  let acc = 0
+  for (let index = 0; index < subKey.length; index++) {
+    acc = acc * 2 + subKey.charCodeAt(index) - 48
+  }
+  return acc
+}
+
+/**
+ * Generates a modified RFC1751 mnemonic in the same way rippled's wallet_propose does.
+ *
+ * @param hex_key - An encoded secret in hex format.
+ * @returns A mnemonic following rippled's modified RFC1751 mnemonic standard.
+ */
+function keyToRFC1751Mnemonic(hex_key: string): string {
+  // Remove whitespace and interpret hex
+  const buf = hexToBytes(hex_key.replace(/\s+/gu, ''))
+  // Swap byte order and use rfc1751
+  let key: number[] = bufferToArray(swap128(buf))
+
+  // pad to 8 bytes
+  const padding: number[] = []
+  for (let index = 0; index < (8 - (key.length % 8)) % 8; index++) {
+    padding.push(0)
+  }
+  key = padding.concat(key)
+
+  const english: string[] = []
+  for (let index = 0; index < key.length; index += 8) {
+    const subKey = key.slice(index, index + 8)
+
+    // add parity
+    let skbin = keyToBinary(subKey)
+    let parity = 0
+    for (let j = 0; j < 64; j += 2) {
+      parity += extract(skbin, j, 2)
+    }
+    subKey.push((parity << 6) & 0xff)
+
+    skbin = keyToBinary(subKey)
+    for (let j = 0; j < 64; j += 11) {
+      english.push(rfc1751WordList[extract(skbin, j, 11)])
+    }
+  }
+  return english.join(' ')
+}
+
+/**
+ * Converts an english mnemonic following rippled's modified RFC1751 standard to an encoded hex secret.
+ *
+ * @param english - A mnemonic generated using ripple's modified RFC1751 standard.
+ * @throws Error if the parity after decoding does not match.
+ * @returns A Buffer containing an encoded secret.
+ */
+function rfc1751MnemonicToKey(english: string): Uint8Array {
+  const words = english.split(' ')
+  let key: number[] = []
+
+  for (let index = 0; index < words.length; index += 6) {
+    const { subKey, word }: { subKey: number[]; word: string } = getSubKey(
+      words,
+      index,
+    )
+
+    // check parity
+    const skbin = keyToBinary(subKey)
+    let parity = 0
+    for (let j = 0; j < 64; j += 2) {
+      parity += extract(skbin, j, 2)
+    }
+    const cs0 = extract(skbin, 64, 2)
+    const cs1 = parity & 3
+    if (cs0 !== cs1) {
+      throw new Error(`Parity error at ${word}`)
+    }
+
+    key = key.concat(subKey.slice(0, 8))
+  }
+
+  // This is a step specific to the XRPL's implementation
+  const bufferKey = swap128(Uint8Array.from(key))
+  return bufferKey
+}
+
+function getSubKey(
+  words: string[],
+  index: number,
+): { subKey: number[]; word: string } {
+  const sublist = words.slice(index, index + 6)
+  let bits = 0
+  const ch = [0, 0, 0, 0, 0, 0, 0, 0, 0]
+  let word = ''
+  for (word of sublist) {
+    const idx = rfc1751WordList.indexOf(word.toUpperCase())
+    if (idx === -1) {
+      throw new TypeError(
+        `Expected an RFC1751 word, but received '${word}'. ` +
+          `For the full list of words in the RFC1751 encoding see https://datatracker.ietf.org/doc/html/rfc1751`,
+      )
+    }
+    const shift = (8 - ((bits + 11) % 8)) % 8
+    const y = idx << shift
+    const cl = y >> 16
+    const cc = (y >> 8) & 0xff
+    const cr = y & 0xff
+    const t = Math.floor(bits / 8)
+    if (shift > 5) {
+      ch[t] |= cl
+      ch[t + 1] |= cc
+      ch[t + 2] |= cr
+    } else if (shift > -3) {
+      ch[t] |= cc
+      ch[t + 1] |= cr
+    } else {
+      ch[t] |= cr
+    }
+    bits += 11
+  }
+  const subKey: number[] = ch.slice()
+  return { subKey, word }
+}
+
+function bufferToArray(buf: Uint8Array): number[] {
+  /* eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- We know the end type */
+  return Array.prototype.slice.call(buf) as number[]
+}
+
+function swap(arr: Uint8Array, n: number, m: number): void {
+  const i = arr[n]
+  // eslint-disable-next-line no-param-reassign -- we have to swap
+  arr[n] = arr[m]
+  // eslint-disable-next-line no-param-reassign -- see above
+  arr[m] = i
+}
+
+/**
+ * Interprets arr as an array of 64-bit numbers and swaps byte order in 64 bit chunks.
+ * Example of two 64 bit numbers 0000000100000002 => 1000000020000000
+ *
+ * @param arr A Uint8Array representation of one or more 64 bit numbers
+ * @returns Uint8Array An array containing the bytes of 64 bit numbers each with reversed endianness
+ */
+function swap64(arr: Uint8Array): Uint8Array {
+  const len = arr.length
+
+  for (let i = 0; i < len; i += 8) {
+    swap(arr, i, i + 7)
+    swap(arr, i + 1, i + 6)
+    swap(arr, i + 2, i + 5)
+    swap(arr, i + 3, i + 4)
+  }
+
+  return arr
+}
+
+/**
+ * Swap the byte order of a 128-bit array.
+ * Ex. 0000000100000002 => 2000000010000000
+ *
+ * @param arr - A 128-bit (16 byte) array
+ * @returns An array containing the same data with reversed endianness
+ */
+function swap128(arr: Uint8Array): Uint8Array {
+  // Interprets arr as an array of (two, in this case) 64-bit numbers and swaps byte order in 64 bit chunks.
+  // Ex. 0000000100000002 => 1000000020000000
+  const reversedBytes = swap64(arr)
+  // Further swap the two 64-bit numbers since our buffer is 128 bits.
+  // Ex. 1000000020000000 => 2000000010000000
+  return concat([reversedBytes.slice(8, 16), reversedBytes.slice(0, 8)])
+}
+
+export { rfc1751MnemonicToKey, keyToRFC1751Mnemonic }

package/src/Wallet/rfc1751Words.json

@@ -0,0 +1,243 @@
+[ "A", "ABE", "ACE", "ACT", "AD", "ADA", "ADD",
+  "AGO", "AID", "AIM", "AIR", "ALL", "ALP", "AM", "AMY", "AN", "ANA",
+  "AND", "ANN", "ANT", "ANY", "APE", "APS", "APT", "ARC", "ARE", "ARK",
+  "ARM", "ART", "AS", "ASH", "ASK", "AT", "ATE", "AUG", "AUK", "AVE",
+  "AWE", "AWK", "AWL", "AWN", "AX", "AYE", "BAD", "BAG", "BAH", "BAM",
+  "BAN", "BAR", "BAT", "BAY", "BE", "BED", "BEE", "BEG", "BEN", "BET",
+  "BEY", "BIB", "BID", "BIG", "BIN", "BIT", "BOB", "BOG", "BON", "BOO",
+  "BOP", "BOW", "BOY", "BUB", "BUD", "BUG", "BUM", "BUN", "BUS", "BUT",
+  "BUY", "BY", "BYE", "CAB", "CAL", "CAM", "CAN", "CAP", "CAR", "CAT",
+  "CAW", "COD", "COG", "COL", "CON", "COO", "COP", "COT", "COW", "COY",
+  "CRY", "CUB", "CUE", "CUP", "CUR", "CUT", "DAB", "DAD", "DAM", "DAN",
+  "DAR", "DAY", "DEE", "DEL", "DEN", "DES", "DEW", "DID", "DIE", "DIG",
+  "DIN", "DIP", "DO", "DOE", "DOG", "DON", "DOT", "DOW", "DRY", "DUB",
+  "DUD", "DUE", "DUG", "DUN", "EAR", "EAT", "ED", "EEL", "EGG", "EGO",
+  "ELI", "ELK", "ELM", "ELY", "EM", "END", "EST", "ETC", "EVA", "EVE",
+  "EWE", "EYE", "FAD", "FAN", "FAR", "FAT", "FAY", "FED", "FEE", "FEW",
+  "FIB", "FIG", "FIN", "FIR", "FIT", "FLO", "FLY", "FOE", "FOG", "FOR",
+  "FRY", "FUM", "FUN", "FUR", "GAB", "GAD", "GAG", "GAL", "GAM", "GAP",
+  "GAS", "GAY", "GEE", "GEL", "GEM", "GET", "GIG", "GIL", "GIN", "GO",
+  "GOT", "GUM", "GUN", "GUS", "GUT", "GUY", "GYM", "GYP", "HA", "HAD",
+  "HAL", "HAM", "HAN", "HAP", "HAS", "HAT", "HAW", "HAY", "HE", "HEM",
+  "HEN", "HER", "HEW", "HEY", "HI", "HID", "HIM", "HIP", "HIS", "HIT",
+  "HO", "HOB", "HOC", "HOE", "HOG", "HOP", "HOT", "HOW", "HUB", "HUE",
+  "HUG", "HUH", "HUM", "HUT", "I", "ICY", "IDA", "IF", "IKE", "ILL",
+  "INK", "INN", "IO", "ION", "IQ", "IRA", "IRE", "IRK", "IS", "IT",
+  "ITS", "IVY", "JAB", "JAG", "JAM", "JAN", "JAR", "JAW", "JAY", "JET",
+  "JIG", "JIM", "JO", "JOB", "JOE", "JOG", "JOT", "JOY", "JUG", "JUT",
+  "KAY", "KEG", "KEN", "KEY", "KID", "KIM", "KIN", "KIT", "LA", "LAB",
+  "LAC", "LAD", "LAG", "LAM", "LAP", "LAW", "LAY", "LEA", "LED", "LEE",
+  "LEG", "LEN", "LEO", "LET", "LEW", "LID", "LIE", "LIN", "LIP", "LIT",
+  "LO", "LOB", "LOG", "LOP", "LOS", "LOT", "LOU", "LOW", "LOY", "LUG",
+  "LYE", "MA", "MAC", "MAD", "MAE", "MAN", "MAO", "MAP", "MAT", "MAW",
+  "MAY", "ME", "MEG", "MEL", "MEN", "MET", "MEW", "MID", "MIN", "MIT",
+  "MOB", "MOD", "MOE", "MOO", "MOP", "MOS", "MOT", "MOW", "MUD", "MUG",
+  "MUM", "MY", "NAB", "NAG", "NAN", "NAP", "NAT", "NAY", "NE", "NED",
+  "NEE", "NET", "NEW", "NIB", "NIL", "NIP", "NIT", "NO", "NOB", "NOD",
+  "NON", "NOR", "NOT", "NOV", "NOW", "NU", "NUN", "NUT", "O", "OAF",
+  "OAK", "OAR", "OAT", "ODD", "ODE", "OF", "OFF", "OFT", "OH", "OIL",
+  "OK", "OLD", "ON", "ONE", "OR", "ORB", "ORE", "ORR", "OS", "OTT",
+  "OUR", "OUT", "OVA", "OW", "OWE", "OWL", "OWN", "OX", "PA", "PAD",
+  "PAL", "PAM", "PAN", "PAP", "PAR", "PAT", "PAW", "PAY", "PEA", "PEG",
+  "PEN", "PEP", "PER", "PET", "PEW", "PHI", "PI", "PIE", "PIN", "PIT",
+  "PLY", "PO", "POD", "POE", "POP", "POT", "POW", "PRO", "PRY", "PUB",
+  "PUG", "PUN", "PUP", "PUT", "QUO", "RAG", "RAM", "RAN", "RAP", "RAT",
+  "RAW", "RAY", "REB", "RED", "REP", "RET", "RIB", "RID", "RIG", "RIM",
+  "RIO", "RIP", "ROB", "ROD", "ROE", "RON", "ROT", "ROW", "ROY", "RUB",
+  "RUE", "RUG", "RUM", "RUN", "RYE", "SAC", "SAD", "SAG", "SAL", "SAM",
+  "SAN", "SAP", "SAT", "SAW", "SAY", "SEA", "SEC", "SEE", "SEN", "SET",
+  "SEW", "SHE", "SHY", "SIN", "SIP", "SIR", "SIS", "SIT", "SKI", "SKY",
+  "SLY", "SO", "SOB", "SOD", "SON", "SOP", "SOW", "SOY", "SPA", "SPY",
+  "SUB", "SUD", "SUE", "SUM", "SUN", "SUP", "TAB", "TAD", "TAG", "TAN",
+  "TAP", "TAR", "TEA", "TED", "TEE", "TEN", "THE", "THY", "TIC", "TIE",
+  "TIM", "TIN", "TIP", "TO", "TOE", "TOG", "TOM", "TON", "TOO", "TOP",
+  "TOW", "TOY", "TRY", "TUB", "TUG", "TUM", "TUN", "TWO", "UN", "UP",
+  "US", "USE", "VAN", "VAT", "VET", "VIE", "WAD", "WAG", "WAR", "WAS",
+  "WAY", "WE", "WEB", "WED", "WEE", "WET", "WHO", "WHY", "WIN", "WIT",
+  "WOK", "WON", "WOO", "WOW", "WRY", "WU", "YAM", "YAP", "YAW", "YE",
+  "YEA", "YES", "YET", "YOU", "ABED", "ABEL", "ABET", "ABLE", "ABUT",
+  "ACHE", "ACID", "ACME", "ACRE", "ACTA", "ACTS", "ADAM", "ADDS",
+  "ADEN", "AFAR", "AFRO", "AGEE", "AHEM", "AHOY", "AIDA", "AIDE",
+  "AIDS", "AIRY", "AJAR", "AKIN", "ALAN", "ALEC", "ALGA", "ALIA",
+  "ALLY", "ALMA", "ALOE", "ALSO", "ALTO", "ALUM", "ALVA", "AMEN",
+  "AMES", "AMID", "AMMO", "AMOK", "AMOS", "AMRA", "ANDY", "ANEW",
+  "ANNA", "ANNE", "ANTE", "ANTI", "AQUA", "ARAB", "ARCH", "AREA",
+  "ARGO", "ARID", "ARMY", "ARTS", "ARTY", "ASIA", "ASKS", "ATOM",
+  "AUNT", "AURA", "AUTO", "AVER", "AVID", "AVIS", "AVON", "AVOW",
+  "AWAY", "AWRY", "BABE", "BABY", "BACH", "BACK", "BADE", "BAIL",
+  "BAIT", "BAKE", "BALD", "BALE", "BALI", "BALK", "BALL", "BALM",
+  "BAND", "BANE", "BANG", "BANK", "BARB", "BARD", "BARE", "BARK",
+  "BARN", "BARR", "BASE", "BASH", "BASK", "BASS", "BATE", "BATH",
+  "BAWD", "BAWL", "BEAD", "BEAK", "BEAM", "BEAN", "BEAR", "BEAT",
+  "BEAU", "BECK", "BEEF", "BEEN", "BEER",
+  "BEET", "BELA", "BELL", "BELT", "BEND", "BENT", "BERG", "BERN",
+  "BERT", "BESS", "BEST", "BETA", "BETH", "BHOY", "BIAS", "BIDE",
+  "BIEN", "BILE", "BILK", "BILL", "BIND", "BING", "BIRD", "BITE",
+  "BITS", "BLAB", "BLAT", "BLED", "BLEW", "BLOB", "BLOC", "BLOT",
+  "BLOW", "BLUE", "BLUM", "BLUR", "BOAR", "BOAT", "BOCA", "BOCK",
+  "BODE", "BODY", "BOGY", "BOHR", "BOIL", "BOLD", "BOLO", "BOLT",
+  "BOMB", "BONA", "BOND", "BONE", "BONG", "BONN", "BONY", "BOOK",
+  "BOOM", "BOON", "BOOT", "BORE", "BORG", "BORN", "BOSE", "BOSS",
+  "BOTH", "BOUT", "BOWL", "BOYD", "BRAD", "BRAE", "BRAG", "BRAN",
+  "BRAY", "BRED", "BREW", "BRIG", "BRIM", "BROW", "BUCK", "BUDD",
+  "BUFF", "BULB", "BULK", "BULL", "BUNK", "BUNT", "BUOY", "BURG",
+  "BURL", "BURN", "BURR", "BURT", "BURY", "BUSH", "BUSS", "BUST",
+  "BUSY", "BYTE", "CADY", "CAFE", "CAGE", "CAIN", "CAKE", "CALF",
+  "CALL", "CALM", "CAME", "CANE", "CANT", "CARD", "CARE", "CARL",
+  "CARR", "CART", "CASE", "CASH", "CASK", "CAST", "CAVE", "CEIL",
+  "CELL", "CENT", "CERN", "CHAD", "CHAR", "CHAT", "CHAW", "CHEF",
+  "CHEN", "CHEW", "CHIC", "CHIN", "CHOU", "CHOW", "CHUB", "CHUG",
+  "CHUM", "CITE", "CITY", "CLAD", "CLAM", "CLAN", "CLAW", "CLAY",
+  "CLOD", "CLOG", "CLOT", "CLUB", "CLUE", "COAL", "COAT", "COCA",
+  "COCK", "COCO", "CODA", "CODE", "CODY", "COED", "COIL", "COIN",
+  "COKE", "COLA", "COLD", "COLT", "COMA", "COMB", "COME", "COOK",
+  "COOL", "COON", "COOT", "CORD", "CORE", "CORK", "CORN", "COST",
+  "COVE", "COWL", "CRAB", "CRAG", "CRAM", "CRAY", "CREW", "CRIB",
+  "CROW", "CRUD", "CUBA", "CUBE", "CUFF", "CULL", "CULT", "CUNY",
+  "CURB", "CURD", "CURE", "CURL", "CURT", "CUTS", "DADE", "DALE",
+  "DAME", "DANA", "DANE", "DANG", "DANK", "DARE", "DARK", "DARN",
+  "DART", "DASH", "DATA", "DATE", "DAVE", "DAVY", "DAWN", "DAYS",
+  "DEAD", "DEAF", "DEAL", "DEAN", "DEAR", "DEBT", "DECK", "DEED",
+  "DEEM", "DEER", "DEFT", "DEFY", "DELL", "DENT", "DENY", "DESK",
+  "DIAL", "DICE", "DIED", "DIET", "DIME", "DINE", "DING", "DINT",
+  "DIRE", "DIRT", "DISC", "DISH", "DISK", "DIVE", "DOCK", "DOES",
+  "DOLE", "DOLL", "DOLT", "DOME", "DONE", "DOOM", "DOOR", "DORA",
+  "DOSE", "DOTE", "DOUG", "DOUR", "DOVE", "DOWN", "DRAB", "DRAG",
+  "DRAM", "DRAW", "DREW", "DRUB", "DRUG", "DRUM", "DUAL", "DUCK",
+  "DUCT", "DUEL", "DUET", "DUKE", "DULL", "DUMB", "DUNE", "DUNK",
+  "DUSK", "DUST", "DUTY", "EACH", "EARL", "EARN", "EASE", "EAST",
+  "EASY", "EBEN", "ECHO", "EDDY", "EDEN", "EDGE", "EDGY", "EDIT",
+  "EDNA", "EGAN", "ELAN", "ELBA", "ELLA", "ELSE", "EMIL", "EMIT",
+  "EMMA", "ENDS", "ERIC", "EROS", "EVEN", "EVER", "EVIL", "EYED",
+  "FACE", "FACT", "FADE", "FAIL", "FAIN", "FAIR", "FAKE", "FALL",
+  "FAME", "FANG", "FARM", "FAST", "FATE", "FAWN", "FEAR", "FEAT",
+  "FEED", "FEEL", "FEET", "FELL", "FELT", "FEND", "FERN", "FEST",
+  "FEUD", "FIEF", "FIGS", "FILE", "FILL", "FILM", "FIND", "FINE",
+  "FINK", "FIRE", "FIRM", "FISH", "FISK", "FIST", "FITS", "FIVE",
+  "FLAG", "FLAK", "FLAM", "FLAT", "FLAW", "FLEA", "FLED", "FLEW",
+  "FLIT", "FLOC", "FLOG", "FLOW", "FLUB", "FLUE", "FOAL", "FOAM",
+  "FOGY", "FOIL", "FOLD", "FOLK", "FOND", "FONT", "FOOD", "FOOL",
+  "FOOT", "FORD", "FORE", "FORK", "FORM", "FORT", "FOSS", "FOUL",
+  "FOUR", "FOWL", "FRAU", "FRAY", "FRED", "FREE", "FRET", "FREY",
+  "FROG", "FROM", "FUEL", "FULL", "FUME", "FUND", "FUNK", "FURY",
+  "FUSE", "FUSS", "GAFF", "GAGE", "GAIL", "GAIN", "GAIT", "GALA",
+  "GALE", "GALL", "GALT", "GAME", "GANG", "GARB", "GARY", "GASH",
+  "GATE", "GAUL", "GAUR", "GAVE", "GAWK", "GEAR", "GELD", "GENE",
+  "GENT", "GERM", "GETS", "GIBE", "GIFT", "GILD", "GILL", "GILT",
+  "GINA", "GIRD", "GIRL", "GIST", "GIVE", "GLAD", "GLEE", "GLEN",
+  "GLIB", "GLOB", "GLOM", "GLOW", "GLUE", "GLUM", "GLUT", "GOAD",
+  "GOAL", "GOAT", "GOER", "GOES", "GOLD", "GOLF", "GONE", "GONG",
+  "GOOD", "GOOF", "GORE", "GORY", "GOSH", "GOUT", "GOWN", "GRAB",
+  "GRAD", "GRAY", "GREG", "GREW", "GREY", "GRID", "GRIM", "GRIN",
+  "GRIT", "GROW", "GRUB", "GULF", "GULL", "GUNK", "GURU", "GUSH",
+  "GUST", "GWEN", "GWYN", "HAAG", "HAAS", "HACK", "HAIL", "HAIR",
+  "HALE", "HALF", "HALL", "HALO", "HALT", "HAND", "HANG", "HANK",
+  "HANS", "HARD", "HARK", "HARM", "HART", "HASH", "HAST", "HATE",
+  "HATH", "HAUL", "HAVE", "HAWK", "HAYS", "HEAD", "HEAL", "HEAR",
+  "HEAT", "HEBE", "HECK", "HEED", "HEEL", "HEFT", "HELD", "HELL",
+  "HELM", "HERB", "HERD", "HERE", "HERO", "HERS", "HESS", "HEWN",
+  "HICK", "HIDE", "HIGH", "HIKE", "HILL", "HILT", "HIND", "HINT",
+  "HIRE", "HISS", "HIVE", "HOBO", "HOCK", "HOFF", "HOLD", "HOLE",
+  "HOLM", "HOLT", "HOME", "HONE", "HONK", "HOOD", "HOOF", "HOOK",
+  "HOOT", "HORN", "HOSE", "HOST", "HOUR", "HOVE", "HOWE", "HOWL",
+  "HOYT", "HUCK", "HUED", "HUFF", "HUGE", "HUGH", "HUGO", "HULK",
+  "HULL", "HUNK", "HUNT", "HURD", "HURL", "HURT", "HUSH", "HYDE",
+  "HYMN", "IBIS", "ICON", "IDEA", "IDLE", "IFFY", "INCA", "INCH",
+  "INTO", "IONS", "IOTA", "IOWA", "IRIS", "IRMA", "IRON", "ISLE",
+  "ITCH", "ITEM", "IVAN", "JACK", "JADE", "JAIL", "JAKE", "JANE",
+  "JAVA", "JEAN", "JEFF", "JERK", "JESS", "JEST", "JIBE", "JILL",
+  "JILT", "JIVE", "JOAN", "JOBS", "JOCK", "JOEL", "JOEY", "JOHN",
+  "JOIN", "JOKE", "JOLT", "JOVE", "JUDD", "JUDE", "JUDO", "JUDY",
+  "JUJU", "JUKE", "JULY", "JUNE", "JUNK", "JUNO", "JURY", "JUST",
+  "JUTE", "KAHN", "KALE", "KANE", "KANT", "KARL", "KATE", "KEEL",
+  "KEEN", "KENO", "KENT", "KERN", "KERR", "KEYS", "KICK", "KILL",
+  "KIND", "KING", "KIRK", "KISS", "KITE", "KLAN", "KNEE", "KNEW",
+  "KNIT", "KNOB", "KNOT", "KNOW", "KOCH", "KONG", "KUDO", "KURD",
+  "KURT", "KYLE", "LACE", "LACK", "LACY", "LADY", "LAID", "LAIN",
+  "LAIR", "LAKE", "LAMB", "LAME", "LAND", "LANE", "LANG", "LARD",
+  "LARK", "LASS", "LAST", "LATE", "LAUD", "LAVA", "LAWN", "LAWS",
+  "LAYS", "LEAD", "LEAF", "LEAK", "LEAN", "LEAR", "LEEK", "LEER",
+  "LEFT", "LEND", "LENS", "LENT", "LEON", "LESK", "LESS", "LEST",
+  "LETS", "LIAR", "LICE", "LICK", "LIED", "LIEN", "LIES", "LIEU",
+  "LIFE", "LIFT", "LIKE", "LILA", "LILT", "LILY", "LIMA", "LIMB",
+  "LIME", "LIND", "LINE", "LINK", "LINT", "LION", "LISA", "LIST",
+  "LIVE", "LOAD", "LOAF", "LOAM", "LOAN", "LOCK", "LOFT", "LOGE",
+  "LOIS", "LOLA", "LONE", "LONG", "LOOK", "LOON", "LOOT", "LORD",
+  "LORE", "LOSE", "LOSS", "LOST", "LOUD", "LOVE", "LOWE", "LUCK",
+  "LUCY", "LUGE", "LUKE", "LULU", "LUND", "LUNG", "LURA", "LURE",
+  "LURK", "LUSH", "LUST", "LYLE", "LYNN", "LYON", "LYRA", "MACE",
+  "MADE", "MAGI", "MAID", "MAIL", "MAIN", "MAKE", "MALE", "MALI",
+  "MALL", "MALT", "MANA", "MANN", "MANY", "MARC", "MARE", "MARK",
+  "MARS", "MART", "MARY", "MASH", "MASK", "MASS", "MAST", "MATE",
+  "MATH", "MAUL", "MAYO", "MEAD", "MEAL", "MEAN", "MEAT", "MEEK",
+  "MEET", "MELD", "MELT", "MEMO", "MEND", "MENU", "MERT", "MESH",
+  "MESS", "MICE", "MIKE", "MILD", "MILE", "MILK", "MILL", "MILT",
+  "MIMI", "MIND", "MINE", "MINI", "MINK", "MINT", "MIRE", "MISS",
+  "MIST", "MITE", "MITT", "MOAN", "MOAT", "MOCK", "MODE", "MOLD",
+  "MOLE", "MOLL", "MOLT", "MONA", "MONK", "MONT", "MOOD", "MOON",
+  "MOOR", "MOOT", "MORE", "MORN", "MORT", "MOSS", "MOST", "MOTH",
+  "MOVE", "MUCH", "MUCK", "MUDD", "MUFF", "MULE", "MULL", "MURK",
+  "MUSH", "MUST", "MUTE", "MUTT", "MYRA", "MYTH", "NAGY", "NAIL",
+  "NAIR", "NAME", "NARY", "NASH", "NAVE", "NAVY", "NEAL", "NEAR",
+  "NEAT", "NECK", "NEED", "NEIL", "NELL", "NEON", "NERO", "NESS",
+  "NEST", "NEWS", "NEWT", "NIBS", "NICE", "NICK", "NILE", "NINA",
+  "NINE", "NOAH", "NODE", "NOEL", "NOLL", "NONE", "NOOK", "NOON",
+  "NORM", "NOSE", "NOTE", "NOUN", "NOVA", "NUDE", "NULL", "NUMB",
+  "OATH", "OBEY", "OBOE", "ODIN", "OHIO", "OILY", "OINT", "OKAY",
+  "OLAF", "OLDY", "OLGA", "OLIN", "OMAN", "OMEN", "OMIT", "ONCE",
+  "ONES", "ONLY", "ONTO", "ONUS", "ORAL", "ORGY", "OSLO", "OTIS",
+  "OTTO", "OUCH", "OUST", "OUTS", "OVAL", "OVEN", "OVER", "OWLY",
+  "OWNS", "QUAD", "QUIT", "QUOD", "RACE", "RACK", "RACY", "RAFT",
+  "RAGE", "RAID", "RAIL", "RAIN", "RAKE", "RANK", "RANT", "RARE",
+  "RASH", "RATE", "RAVE", "RAYS", "READ", "REAL", "REAM", "REAR",
+  "RECK", "REED", "REEF", "REEK", "REEL", "REID", "REIN", "RENA",
+  "REND", "RENT", "REST", "RICE", "RICH", "RICK", "RIDE", "RIFT",
+  "RILL", "RIME", "RING", "RINK", "RISE", "RISK", "RITE", "ROAD",
+  "ROAM", "ROAR", "ROBE", "ROCK", "RODE", "ROIL", "ROLL", "ROME",
+  "ROOD", "ROOF", "ROOK", "ROOM", "ROOT", "ROSA", "ROSE", "ROSS",
+  "ROSY", "ROTH", "ROUT", "ROVE", "ROWE", "ROWS", "RUBE", "RUBY",
+  "RUDE", "RUDY", "RUIN", "RULE", "RUNG", "RUNS", "RUNT", "RUSE",
+  "RUSH", "RUSK", "RUSS", "RUST", "RUTH", "SACK", "SAFE", "SAGE",
+  "SAID", "SAIL", "SALE", "SALK", "SALT", "SAME", "SAND", "SANE",
+  "SANG", "SANK", "SARA", "SAUL", "SAVE", "SAYS", "SCAN", "SCAR",
+  "SCAT", "SCOT", "SEAL", "SEAM", "SEAR", "SEAT", "SEED", "SEEK",
+  "SEEM", "SEEN", "SEES", "SELF", "SELL", "SEND", "SENT", "SETS",
+  "SEWN", "SHAG", "SHAM", "SHAW", "SHAY", "SHED", "SHIM", "SHIN",
+  "SHOD", "SHOE", "SHOT", "SHOW", "SHUN", "SHUT", "SICK", "SIDE",
+  "SIFT", "SIGH", "SIGN", "SILK", "SILL", "SILO", "SILT", "SINE",
+  "SING", "SINK", "SIRE", "SITE", "SITS", "SITU", "SKAT", "SKEW",
+  "SKID", "SKIM", "SKIN", "SKIT", "SLAB", "SLAM", "SLAT", "SLAY",
+  "SLED", "SLEW", "SLID", "SLIM", "SLIT", "SLOB", "SLOG", "SLOT",
+  "SLOW", "SLUG", "SLUM", "SLUR", "SMOG", "SMUG", "SNAG", "SNOB",
+  "SNOW", "SNUB", "SNUG", "SOAK", "SOAR", "SOCK", "SODA", "SOFA",
+  "SOFT", "SOIL", "SOLD", "SOME", "SONG", "SOON", "SOOT", "SORE",
+  "SORT", "SOUL", "SOUR", "SOWN", "STAB", "STAG", "STAN", "STAR",
+  "STAY", "STEM", "STEW", "STIR", "STOW", "STUB", "STUN", "SUCH",
+  "SUDS", "SUIT", "SULK", "SUMS", "SUNG", "SUNK", "SURE", "SURF",
+  "SWAB", "SWAG", "SWAM", "SWAN", "SWAT", "SWAY", "SWIM", "SWUM",
+  "TACK", "TACT", "TAIL", "TAKE", "TALE", "TALK", "TALL", "TANK",
+  "TASK", "TATE", "TAUT", "TEAL", "TEAM", "TEAR", "TECH", "TEEM",
+  "TEEN", "TEET", "TELL", "TEND", "TENT", "TERM", "TERN", "TESS",
+  "TEST", "THAN", "THAT", "THEE", "THEM", "THEN", "THEY", "THIN",
+  "THIS", "THUD", "THUG", "TICK", "TIDE", "TIDY", "TIED", "TIER",
+  "TILE", "TILL", "TILT", "TIME", "TINA", "TINE", "TINT", "TINY",
+  "TIRE", "TOAD", "TOGO", "TOIL", "TOLD", "TOLL", "TONE", "TONG",
+  "TONY", "TOOK", "TOOL", "TOOT", "TORE", "TORN", "TOTE", "TOUR",
+  "TOUT", "TOWN", "TRAG", "TRAM", "TRAY", "TREE", "TREK", "TRIG",
+  "TRIM", "TRIO", "TROD", "TROT", "TROY", "TRUE", "TUBA", "TUBE",
+  "TUCK", "TUFT", "TUNA", "TUNE", "TUNG", "TURF", "TURN", "TUSK",
+  "TWIG", "TWIN", "TWIT", "ULAN", "UNIT", "URGE", "USED", "USER",
+  "USES", "UTAH", "VAIL", "VAIN", "VALE", "VARY", "VASE", "VAST",
+  "VEAL", "VEDA", "VEIL", "VEIN", "VEND", "VENT", "VERB", "VERY",
+  "VETO", "VICE", "VIEW", "VINE", "VISE", "VOID", "VOLT", "VOTE",
+  "WACK", "WADE", "WAGE", "WAIL", "WAIT", "WAKE", "WALE", "WALK",
+  "WALL", "WALT", "WAND", "WANE", "WANG", "WANT", "WARD", "WARM",
+  "WARN", "WART", "WASH", "WAST", "WATS", "WATT", "WAVE", "WAVY",
+  "WAYS", "WEAK", "WEAL", "WEAN", "WEAR", "WEED", "WEEK", "WEIR",
+  "WELD", "WELL", "WELT", "WENT", "WERE", "WERT", "WEST", "WHAM",
+  "WHAT", "WHEE", "WHEN", "WHET", "WHOA", "WHOM", "WICK", "WIFE",
+  "WILD", "WILL", "WIND", "WINE", "WING", "WINK", "WINO", "WIRE",
+  "WISE", "WISH", "WITH", "WOLF", "WONT", "WOOD", "WOOL", "WORD",
+  "WORE", "WORK", "WORM", "WORN", "WOVE", "WRIT", "WYNN", "YALE",
+  "YANG", "YANK", "YARD", "YARN", "YAWL", "YAWN", "YEAH", "YEAR",
+  "YELL", "YOGA", "YOKE" ]

package/src/Wallet/signer.ts

@@ -0,0 +1,163 @@
+import { bytesToHex } from '@xrplf/isomorphic/utils'
+import { BigNumber } from 'bignumber.js'
+import { decodeAccountID } from 'ripple-address-codec'
+import { decode, encode, encodeForSigning } from 'ripple-binary-codec'
+import { verify } from 'ripple-keypairs'
+
+import { ValidationError } from '../errors'
+import { Signer } from '../models/common'
+import { Transaction, validate } from '../models/transactions'
+
+/**
+ * Takes several transactions with Signer fields (in object or blob form) and creates a
+ * single transaction with all Signers that then gets signed and returned.
+ *
+ * @param transactions - An array of signed Transactions (in object or blob form) to combine into a single signed Transaction.
+ * @returns A single signed Transaction which has all Signers from transactions within it.
+ * @throws ValidationError if:
+ * - There were no transactions given to sign
+ * - The SigningPubKey field is not the empty string in any given transaction
+ * - Any transaction is missing a Signers field.
+ * @category Signing
+ */
+function multisign(transactions: Array<Transaction | string>): string {
+  if (transactions.length === 0) {
+    throw new ValidationError('There were 0 transactions to multisign')
+  }
+
+  const decodedTransactions: Transaction[] = transactions.map(
+    (txOrBlob: string | Transaction) => {
+      return getDecodedTransaction(txOrBlob)
+    },
+  )
+
+  decodedTransactions.forEach((tx) => {
+    /*
+     * This will throw a more clear error for JS users if any of the supplied transactions has incorrect formatting
+     */
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- validate does not accept Transaction type
+    validate(tx as unknown as Record<string, unknown>)
+    if (tx.Signers == null || tx.Signers.length === 0) {
+      throw new ValidationError(
+        "For multisigning all transactions must include a Signers field containing an array of signatures. You may have forgotten to pass the 'forMultisign' parameter when signing.",
+      )
+    }
+
+    if (tx.SigningPubKey !== '') {
+      throw new ValidationError(
+        'SigningPubKey must be an empty string for all transactions when multisigning.',
+      )
+    }
+  })
+
+  validateTransactionEquivalence(decodedTransactions)
+
+  return encode(getTransactionWithAllSigners(decodedTransactions))
+}
+
+/**
+ * Verifies that the given transaction has a valid signature based on public-key encryption.
+ *
+ * @param tx - A transaction to verify the signature of. (Can be in object or encoded string format).
+ * @param [publicKey] Specific public key to use to verify. If not specified the `SigningPublicKey` of tx will be used.
+ * @returns Returns true if tx has a valid signature, and returns false otherwise.
+ * @throws Error when transaction is missing TxnSignature
+ * @throws Error when publicKey is not provided and transaction is missing SigningPubKey
+ * @category Utilities
+ */
+function verifySignature(
+  tx: Transaction | string,
+  publicKey?: string,
+): boolean {
+  const decodedTx: Transaction = getDecodedTransaction(tx)
+  let key = publicKey
+
+  // Need a SignedTransaction class where TxnSignature is not optional.
+  if (typeof decodedTx.TxnSignature !== 'string' || !decodedTx.TxnSignature) {
+    throw new Error('Transaction is missing a signature, TxnSignature')
+  }
+
+  if (!key) {
+    // Need a SignedTransaction class where TxnSignature is not optional.
+    if (
+      typeof decodedTx.SigningPubKey !== 'string' ||
+      !decodedTx.SigningPubKey
+    ) {
+      throw new Error('Transaction is missing a public key, SigningPubKey')
+    }
+    key = decodedTx.SigningPubKey
+  }
+
+  return verify(encodeForSigning(decodedTx), decodedTx.TxnSignature, key)
+}
+
+/**
+ * The transactions should all be equal except for the 'Signers' field.
+ *
+ * @param transactions - An array of Transactions which are expected to be equal other than 'Signers'.
+ * @throws ValidationError if the transactions are not equal in any field other than 'Signers'.
+ */
+function validateTransactionEquivalence(transactions: Transaction[]): void {
+  const exampleTransaction = JSON.stringify({
+    ...transactions[0],
+    Signers: null,
+  })
+  if (
+    transactions
+      .slice(1)
+      .some(
+        (tx) => JSON.stringify({ ...tx, Signers: null }) !== exampleTransaction,
+      )
+  ) {
+    throw new ValidationError(
+      'txJSON is not the same for all signedTransactions',
+    )
+  }
+}
+
+function getTransactionWithAllSigners(
+  transactions: Transaction[],
+): Transaction {
+  // Signers must be sorted in the combined transaction - See compareSigners' documentation for more details
+  const sortedSigners: Signer[] = transactions
+    .flatMap((tx) => tx.Signers ?? [])
+    .sort(compareSigners)
+
+  return { ...transactions[0], Signers: sortedSigners }
+}
+
+/**
+ * If presented in binary form, the Signers array must be sorted based on
+ * the numeric value of the signer addresses, with the lowest value first.
+ * (If submitted as JSON, the submit_multisigned method handles this automatically.)
+ * https://xrpl.org/multi-signing.html.
+ *
+ * @param left - A Signer to compare with.
+ * @param right - A second Signer to compare with.
+ * @returns 1 if left \> right, 0 if left = right, -1 if left \< right, and null if left or right are NaN.
+ */
+function compareSigners(left: Signer, right: Signer): number {
+  return addressToBigNumber(left.Signer.Account).comparedTo(
+    addressToBigNumber(right.Signer.Account),
+  )
+}
+
+const NUM_BITS_IN_HEX = 16
+
+function addressToBigNumber(address: string): BigNumber {
+  const hex = bytesToHex(decodeAccountID(address))
+  return new BigNumber(hex, NUM_BITS_IN_HEX)
+}
+
+function getDecodedTransaction(txOrBlob: Transaction | string): Transaction {
+  if (typeof txOrBlob === 'object') {
+    // We need this to handle X-addresses in multisigning
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- We are casting here to get strong typing
+    return decode(encode(txOrBlob)) as unknown as Transaction
+  }
+
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- We are casting here to get strong typing
+  return decode(txOrBlob) as unknown as Transaction
+}
+
+export { verifySignature, multisign }