@bitgo-beta/sdk-core 8.2.1-beta.201 → 8.2.1-beta.2011

package/dist/src/bitgo/safe/derivableEd25519Pub.js

@@ -0,0 +1,156 @@
+"use strict";
+/**
+ * @prettier
+ *
+ * @experimental Encode/decode helpers for the *derivable* form of a safe slot-④
+ * (`ed25519Multisig`) root public key.
+ *
+ * Wallet Safes v1 soft-derives the backup and BitGo co-signer keys of every minted wallet from the
+ * safe's root public keys, and soft derivation needs a chain code. The secp256k1 slot gets one for
+ * free (a BIP32 xpub is `point || chaincode`); a bare Stellar StrKey `G…` has nowhere to put one.
+ * Per TDD Part II-3 §1.3 we therefore concatenate the chain code onto `pub` rather than introduce a
+ * new field — the same shape BitGo already uses for the MPC slots, whose `commonKeychain` is
+ * `pub || chaincode`.
+ *
+ *   pub = <StrKey ed25519 public key> || <chainCode, 64 lowercase hex>
+ *          exactly 56 chars, 'G…'         exactly 64 chars
+ *   total length exactly 120
+ *
+ * StrKey ed25519 public keys are always exactly 56 characters, so the split is a fixed offset. That
+ * offset is a CROSS-REPO contract shared with wallet-platform, `modules/key-card` and WRW; four
+ * independent implementations drifting produces unrecoverable wallets. Every call site — here and in
+ * the other repos — MUST go through these helpers rather than slicing inline.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DERIVABLE_ED25519_PUB_LENGTH = exports.DERIVABLE_ED25519_CHAIN_CODE_LENGTH = exports.DERIVABLE_ED25519_PUB_SPLIT_OFFSET = void 0;
+exports.isValidEd25519StrKeyPublicKey = isValidEd25519StrKeyPublicKey;
+exports.isValidEd25519ChainCode = isValidEd25519ChainCode;
+exports.encodeDerivableEd25519Pub = encodeDerivableEd25519Pub;
+exports.decodeDerivableEd25519Pub = decodeDerivableEd25519Pub;
+exports.isDerivableEd25519Pub = isDerivableEd25519Pub;
+/**
+ * The fixed character offset at which a composite slot-④ pub splits into (StrKey pub, chain code).
+ * Stellar StrKey ed25519 public keys are a fixed 56 characters, so no length prefix or separator is
+ * needed.
+ *
+ * MUST stay identical to the corresponding constant in wallet-platform, `modules/key-card` and WRW:
+ * a divergent offset splits the pub in the wrong place and derives co-signer keys nobody else can
+ * reproduce, permanently bricking the wallets minted with it.
+ */
+exports.DERIVABLE_ED25519_PUB_SPLIT_OFFSET = 56;
+/** Length of the hex-encoded chain code half (32 bytes). */
+exports.DERIVABLE_ED25519_CHAIN_CODE_LENGTH = 64;
+/** Total length of a well-formed composite pub. */
+exports.DERIVABLE_ED25519_PUB_LENGTH = exports.DERIVABLE_ED25519_PUB_SPLIT_OFFSET + exports.DERIVABLE_ED25519_CHAIN_CODE_LENGTH;
+/**
+ * Chain codes are serialized as LOWERCASE hex only. Uppercase and mixed-case are rejected rather
+ * than normalized: accepting both casings would make the composite pub non-canonical, so the same
+ * key could be stored under two distinct strings and equality against a previously-persisted pub
+ * would spuriously fail.
+ */
+const CHAIN_CODE_REGEX = /^[0-9a-f]{64}$/;
+/** StrKey version byte for an ed25519 public key (`G…`). */
+const STRKEY_VERSION_BYTE_ED25519_PUBLIC_KEY = 6 << 3;
+/** Decoded StrKey payload: 1 version byte + 32-byte key + 2-byte checksum. */
+const STRKEY_DECODED_LENGTH = 35;
+const BASE32_ALPHABET = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567';
+const STRKEY_ED25519_PUBLIC_KEY_REGEX = /^G[A-Z2-7]{55}$/;
+/**
+ * Decode an unpadded RFC 4648 base32 string. The caller guarantees the input matched
+ * {@link STRKEY_ED25519_PUBLIC_KEY_REGEX}, so 56 chars × 5 bits = 280 bits = exactly 35 bytes with
+ * no leftover bits — the encoding is unambiguously canonical.
+ */
+function base32Decode(input) {
+    const out = Buffer.alloc((input.length * 5) / 8);
+    let bits = 0;
+    let value = 0;
+    let index = 0;
+    for (const char of input) {
+        value = (value << 5) | BASE32_ALPHABET.indexOf(char);
+        bits += 5;
+        if (bits >= 8) {
+            bits -= 8;
+            out[index++] = (value >>> bits) & 0xff;
+        }
+    }
+    return out;
+}
+/** CRC16-XModem, the checksum Stellar StrKey appends (little-endian) to the versioned payload. */
+function crc16Xmodem(data) {
+    let crc = 0x0000;
+    for (const byte of data) {
+        let code = (crc >>> 8) & 0xff;
+        code ^= byte;
+        code ^= code >>> 4;
+        crc = ((crc << 8) & 0xffff) ^ ((code << 12) & 0xffff) ^ ((code << 5) & 0xffff) ^ code;
+    }
+    return crc & 0xffff;
+}
+/**
+ * Returns true iff `pub` is a valid Stellar StrKey ed25519 public key.
+ *
+ * Implemented here rather than pulled from `stellar-sdk` because `sdk-core` must not depend on a
+ * coin module. The pub half is validated by CHECKSUM, not merely by length and alphabet — a
+ * 56-character `G…` string with a corrupted body is rejected.
+ */
+function isValidEd25519StrKeyPublicKey(pub) {
+    if (!STRKEY_ED25519_PUBLIC_KEY_REGEX.test(pub)) {
+        return false;
+    }
+    const decoded = base32Decode(pub);
+    if (decoded.length !== STRKEY_DECODED_LENGTH || decoded[0] !== STRKEY_VERSION_BYTE_ED25519_PUBLIC_KEY) {
+        return false;
+    }
+    return (crc16Xmodem(decoded.subarray(0, STRKEY_DECODED_LENGTH - 2)) === decoded.readUInt16LE(STRKEY_DECODED_LENGTH - 2));
+}
+/** Returns true iff `chainCode` is exactly 64 lowercase hex characters. */
+function isValidEd25519ChainCode(chainCode) {
+    return CHAIN_CODE_REGEX.test(chainCode);
+}
+/**
+ * Compose a derivable slot-④ root pub from its two halves.
+ *
+ * Throws when either half is malformed: silently emitting a composite whose halves do not round-trip
+ * would persist a root pub from which no correct co-signer key can ever be derived.
+ */
+function encodeDerivableEd25519Pub(pub, chainCode) {
+    if (!isValidEd25519StrKeyPublicKey(pub)) {
+        throw new Error('Invalid derivable ed25519 pub: pub half is not a valid ed25519 public key');
+    }
+    if (!isValidEd25519ChainCode(chainCode)) {
+        throw new Error('Invalid derivable ed25519 pub: chainCode must be 64 lowercase hex characters');
+    }
+    return `${pub}${chainCode}`;
+}
+/**
+ * Split a composite slot-④ root pub back into its two halves.
+ *
+ * Throws unless the input is EXACTLY the composite form. A lenient decode that accepted a bare
+ * 56-character pub would hand callers an empty chain code and derive every co-signer from the same
+ * (zero-length) entropy.
+ */
+function decodeDerivableEd25519Pub(composite) {
+    if (composite.length !== exports.DERIVABLE_ED25519_PUB_LENGTH) {
+        throw new Error(`Invalid derivable ed25519 pub: expected ${exports.DERIVABLE_ED25519_PUB_LENGTH} characters, got ${composite.length}`);
+    }
+    const pub = composite.slice(0, exports.DERIVABLE_ED25519_PUB_SPLIT_OFFSET);
+    const chainCode = composite.slice(exports.DERIVABLE_ED25519_PUB_SPLIT_OFFSET);
+    if (!isValidEd25519StrKeyPublicKey(pub)) {
+        throw new Error('Invalid derivable ed25519 pub: pub half is not a valid ed25519 public key');
+    }
+    if (!isValidEd25519ChainCode(chainCode)) {
+        throw new Error('Invalid derivable ed25519 pub: chainCode must be 64 lowercase hex characters');
+    }
+    return { pub, chainCode };
+}
+/** Returns true iff `composite` is a well-formed derivable slot-④ root pub. */
+function isDerivableEd25519Pub(composite) {
+    try {
+        decodeDerivableEd25519Pub(composite);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"derivableEd25519Pub.js","sourceRoot":"","sources":["../../../../src/bitgo/safe/derivableEd25519Pub.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;;;AA4EH,sEAWC;AAGD,0DAEC;AAQD,8DAQC;AASD,8DAeC;AAGD,sDAOC;AA5ID;;;;;;;;GAQG;AACU,QAAA,kCAAkC,GAAG,EAAE,CAAC;AAErD,4DAA4D;AAC/C,QAAA,mCAAmC,GAAG,EAAE,CAAC;AAEtD,mDAAmD;AACtC,QAAA,4BAA4B,GAAG,0CAAkC,GAAG,2CAAmC,CAAC;AAErH;;;;;GAKG;AACH,MAAM,gBAAgB,GAAG,gBAAgB,CAAC;AAE1C,4DAA4D;AAC5D,MAAM,sCAAsC,GAAG,CAAC,IAAI,CAAC,CAAC;AAEtD,8EAA8E;AAC9E,MAAM,qBAAqB,GAAG,EAAE,CAAC;AAEjC,MAAM,eAAe,GAAG,kCAAkC,CAAC;AAC3D,MAAM,+BAA+B,GAAG,iBAAiB,CAAC;AAE1D;;;;GAIG;AACH,SAAS,YAAY,CAAC,KAAa;IACjC,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACjD,IAAI,IAAI,GAAG,CAAC,CAAC;IACb,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,KAAK,GAAG,CAAC,KAAK,IAAI,CAAC,CAAC,GAAG,eAAe,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACrD,IAAI,IAAI,CAAC,CAAC;QACV,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC;YACd,IAAI,IAAI,CAAC,CAAC;YACV,GAAG,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,KAAK,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC;QACzC,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,kGAAkG;AAClG,SAAS,WAAW,CAAC,IAAY;IAC/B,IAAI,GAAG,GAAG,MAAM,CAAC;IACjB,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;QACxB,IAAI,IAAI,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC;QAC9B,IAAI,IAAI,IAAI,CAAC;QACb,IAAI,IAAI,IAAI,KAAK,CAAC,CAAC;QACnB,GAAG,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC;IACxF,CAAC;IACD,OAAO,GAAG,GAAG,MAAM,CAAC;AACtB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,6BAA6B,CAAC,GAAW;IACvD,IAAI,CAAC,+BAA+B,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/C,OAAO,KAAK,CAAC;IACf,CAAC;IACD,MAAM,OAAO,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;IAClC,IAAI,OAAO,CAAC,MAAM,KAAK,qBAAqB,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,sCAAsC,EAAE,CAAC;QACtG,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,CACL,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,qBAAqB,GAAG,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC,qBAAqB,GAAG,CAAC,CAAC,CAChH,CAAC;AACJ,CAAC;AAED,2EAA2E;AAC3E,SAAgB,uBAAuB,CAAC,SAAiB;IACvD,OAAO,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AAC1C,CAAC;AAED;;;;;GAKG;AACH,SAAgB,yBAAyB,CAAC,GAAW,EAAE,SAAiB;IACtE,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAC;IAC/F,CAAC;IACD,IAAI,CAAC,uBAAuB,CAAC,SAAS,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CAAC,8EAA8E,CAAC,CAAC;IAClG,CAAC;IACD,OAAO,GAAG,GAAG,GAAG,SAAS,EAAE,CAAC;AAC9B,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,yBAAyB,CAAC,SAAiB;IACzD,IAAI,SAAS,CAAC,MAAM,KAAK,oCAA4B,EAAE,CAAC;QACtD,MAAM,IAAI,KAAK,CACb,2CAA2C,oCAA4B,oBAAoB,SAAS,CAAC,MAAM,EAAE,CAC9G,CAAC;IACJ,CAAC;IACD,MAAM,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,0CAAkC,CAAC,CAAC;IACnE,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,0CAAkC,CAAC,CAAC;IACtE,IAAI,CAAC,6BAA6B,CAAC,GAAG,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAC;IAC/F,CAAC;IACD,IAAI,CAAC,uBAAuB,CAAC,SAAS,CAAC,EAAE,CAAC;QACxC,MAAM,IAAI,KAAK,CAAC,8EAA8E,CAAC,CAAC;IAClG,CAAC;IACD,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;AAC5B,CAAC;AAED,+EAA+E;AAC/E,SAAgB,qBAAqB,CAAC,SAAiB;IACrD,IAAI,CAAC;QACH,yBAAyB,CAAC,SAAS,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC","sourcesContent":["/**\n * @prettier\n *\n * @experimental Encode/decode helpers for the *derivable* form of a safe slot-④\n * (`ed25519Multisig`) root public key.\n *\n * Wallet Safes v1 soft-derives the backup and BitGo co-signer keys of every minted wallet from the\n * safe's root public keys, and soft derivation needs a chain code. The secp256k1 slot gets one for\n * free (a BIP32 xpub is `point || chaincode`); a bare Stellar StrKey `G…` has nowhere to put one.\n * Per TDD Part II-3 §1.3 we therefore concatenate the chain code onto `pub` rather than introduce a\n * new field — the same shape BitGo already uses for the MPC slots, whose `commonKeychain` is\n * `pub || chaincode`.\n *\n *   pub = <StrKey ed25519 public key> || <chainCode, 64 lowercase hex>\n *          exactly 56 chars, 'G…'         exactly 64 chars\n *   total length exactly 120\n *\n * StrKey ed25519 public keys are always exactly 56 characters, so the split is a fixed offset. That\n * offset is a CROSS-REPO contract shared with wallet-platform, `modules/key-card` and WRW; four\n * independent implementations drifting produces unrecoverable wallets. Every call site — here and in\n * the other repos — MUST go through these helpers rather than slicing inline.\n */\n\n/**\n * The fixed character offset at which a composite slot-④ pub splits into (StrKey pub, chain code).\n * Stellar StrKey ed25519 public keys are a fixed 56 characters, so no length prefix or separator is\n * needed.\n *\n * MUST stay identical to the corresponding constant in wallet-platform, `modules/key-card` and WRW:\n * a divergent offset splits the pub in the wrong place and derives co-signer keys nobody else can\n * reproduce, permanently bricking the wallets minted with it.\n */\nexport const DERIVABLE_ED25519_PUB_SPLIT_OFFSET = 56;\n\n/** Length of the hex-encoded chain code half (32 bytes). */\nexport const DERIVABLE_ED25519_CHAIN_CODE_LENGTH = 64;\n\n/** Total length of a well-formed composite pub. */\nexport const DERIVABLE_ED25519_PUB_LENGTH = DERIVABLE_ED25519_PUB_SPLIT_OFFSET + DERIVABLE_ED25519_CHAIN_CODE_LENGTH;\n\n/**\n * Chain codes are serialized as LOWERCASE hex only. Uppercase and mixed-case are rejected rather\n * than normalized: accepting both casings would make the composite pub non-canonical, so the same\n * key could be stored under two distinct strings and equality against a previously-persisted pub\n * would spuriously fail.\n */\nconst CHAIN_CODE_REGEX = /^[0-9a-f]{64}$/;\n\n/** StrKey version byte for an ed25519 public key (`G…`). */\nconst STRKEY_VERSION_BYTE_ED25519_PUBLIC_KEY = 6 << 3;\n\n/** Decoded StrKey payload: 1 version byte + 32-byte key + 2-byte checksum. */\nconst STRKEY_DECODED_LENGTH = 35;\n\nconst BASE32_ALPHABET = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ234567';\nconst STRKEY_ED25519_PUBLIC_KEY_REGEX = /^G[A-Z2-7]{55}$/;\n\n/**\n * Decode an unpadded RFC 4648 base32 string. The caller guarantees the input matched\n * {@link STRKEY_ED25519_PUBLIC_KEY_REGEX}, so 56 chars × 5 bits = 280 bits = exactly 35 bytes with\n * no leftover bits — the encoding is unambiguously canonical.\n */\nfunction base32Decode(input: string): Buffer {\n  const out = Buffer.alloc((input.length * 5) / 8);\n  let bits = 0;\n  let value = 0;\n  let index = 0;\n  for (const char of input) {\n    value = (value << 5) | BASE32_ALPHABET.indexOf(char);\n    bits += 5;\n    if (bits >= 8) {\n      bits -= 8;\n      out[index++] = (value >>> bits) & 0xff;\n    }\n  }\n  return out;\n}\n\n/** CRC16-XModem, the checksum Stellar StrKey appends (little-endian) to the versioned payload. */\nfunction crc16Xmodem(data: Buffer): number {\n  let crc = 0x0000;\n  for (const byte of data) {\n    let code = (crc >>> 8) & 0xff;\n    code ^= byte;\n    code ^= code >>> 4;\n    crc = ((crc << 8) & 0xffff) ^ ((code << 12) & 0xffff) ^ ((code << 5) & 0xffff) ^ code;\n  }\n  return crc & 0xffff;\n}\n\n/**\n * Returns true iff `pub` is a valid Stellar StrKey ed25519 public key.\n *\n * Implemented here rather than pulled from `stellar-sdk` because `sdk-core` must not depend on a\n * coin module. The pub half is validated by CHECKSUM, not merely by length and alphabet — a\n * 56-character `G…` string with a corrupted body is rejected.\n */\nexport function isValidEd25519StrKeyPublicKey(pub: string): boolean {\n  if (!STRKEY_ED25519_PUBLIC_KEY_REGEX.test(pub)) {\n    return false;\n  }\n  const decoded = base32Decode(pub);\n  if (decoded.length !== STRKEY_DECODED_LENGTH || decoded[0] !== STRKEY_VERSION_BYTE_ED25519_PUBLIC_KEY) {\n    return false;\n  }\n  return (\n    crc16Xmodem(decoded.subarray(0, STRKEY_DECODED_LENGTH - 2)) === decoded.readUInt16LE(STRKEY_DECODED_LENGTH - 2)\n  );\n}\n\n/** Returns true iff `chainCode` is exactly 64 lowercase hex characters. */\nexport function isValidEd25519ChainCode(chainCode: string): boolean {\n  return CHAIN_CODE_REGEX.test(chainCode);\n}\n\n/**\n * Compose a derivable slot-④ root pub from its two halves.\n *\n * Throws when either half is malformed: silently emitting a composite whose halves do not round-trip\n * would persist a root pub from which no correct co-signer key can ever be derived.\n */\nexport function encodeDerivableEd25519Pub(pub: string, chainCode: string): string {\n  if (!isValidEd25519StrKeyPublicKey(pub)) {\n    throw new Error('Invalid derivable ed25519 pub: pub half is not a valid ed25519 public key');\n  }\n  if (!isValidEd25519ChainCode(chainCode)) {\n    throw new Error('Invalid derivable ed25519 pub: chainCode must be 64 lowercase hex characters');\n  }\n  return `${pub}${chainCode}`;\n}\n\n/**\n * Split a composite slot-④ root pub back into its two halves.\n *\n * Throws unless the input is EXACTLY the composite form. A lenient decode that accepted a bare\n * 56-character pub would hand callers an empty chain code and derive every co-signer from the same\n * (zero-length) entropy.\n */\nexport function decodeDerivableEd25519Pub(composite: string): { pub: string; chainCode: string } {\n  if (composite.length !== DERIVABLE_ED25519_PUB_LENGTH) {\n    throw new Error(\n      `Invalid derivable ed25519 pub: expected ${DERIVABLE_ED25519_PUB_LENGTH} characters, got ${composite.length}`\n    );\n  }\n  const pub = composite.slice(0, DERIVABLE_ED25519_PUB_SPLIT_OFFSET);\n  const chainCode = composite.slice(DERIVABLE_ED25519_PUB_SPLIT_OFFSET);\n  if (!isValidEd25519StrKeyPublicKey(pub)) {\n    throw new Error('Invalid derivable ed25519 pub: pub half is not a valid ed25519 public key');\n  }\n  if (!isValidEd25519ChainCode(chainCode)) {\n    throw new Error('Invalid derivable ed25519 pub: chainCode must be 64 lowercase hex characters');\n  }\n  return { pub, chainCode };\n}\n\n/** Returns true iff `composite` is a well-formed derivable slot-④ root pub. */\nexport function isDerivableEd25519Pub(composite: string): boolean {\n  try {\n    decodeDerivableEd25519Pub(composite);\n    return true;\n  } catch {\n    return false;\n  }\n}\n"]}

package/dist/src/bitgo/safe/iSafe.d.ts

@@ -0,0 +1,87 @@
+/**
+ * @prettier
+ *
+ * @experimental The safe client surface is experimental and may change (including breaking
+ * changes) before the public release.
+ */
+import type { FreezeSafeBody, SafeData, SafePermission, SafeRootKeys, SafeShareData, SafeShareKeychain, SafeShareState } from '@bitgo/public-types';
+import type { Wallet, WalletShare } from '../wallet';
+/** @experimental */
+export interface InitializeSafeOptions {
+    label: string;
+}
+/**
+ * Phase 3 — the client hands back the 12 key ids it created in Phase 2.
+ * @experimental
+ */
+export interface FinalizeSafeOptions {
+    rootKeys: SafeRootKeys;
+}
+/**
+ * Sharing ONE safe wallet with a non-member rides the existing wallet-share handshake (FR-13),
+ * so the result is the existing WalletShare shape.
+ */
+export type WalletShareData = WalletShare;
+export interface CreateSafeWalletOptions {
+    coin: string;
+    label: string;
+    passphrase: string;
+    type?: 'hot';
+    /** `tss` throws until MPC mint lands. Defaults to `onchain`. */
+    multisigType?: 'onchain' | 'tss';
+}
+interface AddSafeMemberBase {
+    permissions: SafePermission[];
+    /** required when 'spend' is included — the 4 root user keys ECDH-re-encrypted to the invitee */
+    keychains?: SafeShareKeychain[];
+    message?: string;
+    /** when true, suppress the invitation email that would otherwise be sent to `email` */
+    disableEmail?: boolean;
+}
+/** Add a member by either `userId` or `email` — exactly one is required. */
+export type AddSafeMemberOptions = (AddSafeMemberBase & {
+    userId: string;
+    email?: never;
+}) | (AddSafeMemberBase & {
+    email: string;
+    userId?: never;
+});
+export interface AddSafeWalletMemberOptions {
+    walletId: string;
+    /** required — sharing re-encrypts the user key, which needs hardened derivation from the passphrase */
+    walletPassphrase: string;
+    email?: string;
+    permissions?: string[];
+    message?: string;
+}
+export type AcceptSafeShareAsSpenderOptions = {
+    safeShareId: string;
+    userPassword: string;
+    newWalletPassphrase?: string;
+};
+export type AcceptSafeShareAsNonSpenderOptions = {
+    safeShareId: string;
+};
+export type AcceptSafeShareOptions = AcceptSafeShareAsSpenderOptions | AcceptSafeShareAsNonSpenderOptions;
+/**
+ * @experimental
+ */
+export interface ISafe {
+    id(): string;
+    enterpriseId(): string;
+    label(): string;
+    status(): SafeData['status'];
+    url(extra?: string): string;
+    createWallet(params: CreateSafeWalletOptions): Promise<Wallet>;
+    addMember(params: AddSafeMemberOptions): Promise<SafeData>;
+    addMemberToWallet(params: AddSafeWalletMemberOptions): Promise<WalletShareData>;
+    listShares(params?: {
+        state?: SafeShareState;
+    }): Promise<SafeShareData[]>;
+    acceptShare(params: AcceptSafeShareOptions): Promise<SafeShareData>;
+    freeze(params?: FreezeSafeBody): Promise<SafeData>;
+    archive(): Promise<SafeData>;
+    toJSON(): SafeData;
+}
+export {};
+//# sourceMappingURL=iSafe.d.ts.map

package/dist/src/bitgo/safe/iSafe.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"iSafe.d.ts","sourceRoot":"","sources":["../../../../src/bitgo/safe/iSafe.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EACV,cAAc,EACd,QAAQ,EACR,cAAc,EACd,YAAY,EACZ,aAAa,EACb,iBAAiB,EACjB,cAAc,EACf,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAErD,oBAAoB;AACpB,MAAM,WAAW,qBAAqB;IACpC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,YAAY,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,WAAW,CAAC;AAI1C,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,KAAK,CAAC;IACb,gEAAgE;IAChE,YAAY,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC;CAClC;AAED,UAAU,iBAAiB;IACzB,WAAW,EAAE,cAAc,EAAE,CAAC;IAC9B,gGAAgG;IAChG,SAAS,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,uFAAuF;IACvF,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,4EAA4E;AAC5E,MAAM,MAAM,oBAAoB,GAC5B,CAAC,iBAAiB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC,GACvD,CAAC,iBAAiB,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC,CAAC;AAE5D,MAAM,WAAW,0BAA0B;IACzC,QAAQ,EAAE,MAAM,CAAC;IACjB,uGAAuG;IACvG,gBAAgB,EAAE,MAAM,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,+BAA+B,GAAG;IAC5C,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B,CAAC;AACF,MAAM,MAAM,kCAAkC,GAAG;IAC/C,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG,+BAA+B,GAAG,kCAAkC,CAAC;AAE1G;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB,EAAE,IAAI,MAAM,CAAC;IACb,YAAY,IAAI,MAAM,CAAC;IACvB,KAAK,IAAI,MAAM,CAAC;IAChB,MAAM,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAC7B,GAAG,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAC5B,YAAY,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAG/D,SAAS,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE3D,iBAAiB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAChF,UAAU,CAAC,MAAM,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,cAAc,CAAA;KAAE,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC,CAAC;IAC1E,WAAW,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC;IACpE,MAAM,CAAC,MAAM,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IACnD,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC7B,MAAM,IAAI,QAAQ,CAAC;CACpB"}

package/dist/src/bitgo/safe/iSafe.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaVNhZmUuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvYml0Z28vc2FmZS9pU2FmZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBAcHJldHRpZXJcbiAqXG4gKiBAZXhwZXJpbWVudGFsIFRoZSBzYWZlIGNsaWVudCBzdXJmYWNlIGlzIGV4cGVyaW1lbnRhbCBhbmQgbWF5IGNoYW5nZSAoaW5jbHVkaW5nIGJyZWFraW5nXG4gKiBjaGFuZ2VzKSBiZWZvcmUgdGhlIHB1YmxpYyByZWxlYXNlLlxuICovXG4vLyBXaXJlL2RhdGEgc2hhcGVzIGFyZSBvd25lZCBieSBAYml0Z28vcHVibGljLXR5cGVzIOKAlCBpbXBvcnQgdGhlbSB3aGVyZSBuZWVkZWQgcmF0aGVyIHRoYW5cbi8vIHJlLWV4cG9ydGluZyBmcm9tIHNkay1jb3JlLlxuaW1wb3J0IHR5cGUge1xuICBGcmVlemVTYWZlQm9keSxcbiAgU2FmZURhdGEsXG4gIFNhZmVQZXJtaXNzaW9uLFxuICBTYWZlUm9vdEtleXMsXG4gIFNhZmVTaGFyZURhdGEsXG4gIFNhZmVTaGFyZUtleWNoYWluLFxuICBTYWZlU2hhcmVTdGF0ZSxcbn0gZnJvbSAnQGJpdGdvL3B1YmxpYy10eXBlcyc7XG5pbXBvcnQgdHlwZSB7IFdhbGxldCwgV2FsbGV0U2hhcmUgfSBmcm9tICcuLi93YWxsZXQnO1xuXG4vKiogQGV4cGVyaW1lbnRhbCAqL1xuZXhwb3J0IGludGVyZmFjZSBJbml0aWFsaXplU2FmZU9wdGlvbnMge1xuICBsYWJlbDogc3RyaW5nO1xufVxuXG4vKipcbiAqIFBoYXNlIDMg4oCUIHRoZSBjbGllbnQgaGFuZHMgYmFjayB0aGUgMTIga2V5IGlkcyBpdCBjcmVhdGVkIGluIFBoYXNlIDIuXG4gKiBAZXhwZXJpbWVudGFsXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgRmluYWxpemVTYWZlT3B0aW9ucyB7XG4gIHJvb3RLZXlzOiBTYWZlUm9vdEtleXM7XG59XG5cbi8qKlxuICogU2hhcmluZyBPTkUgc2FmZSB3YWxsZXQgd2l0aCBhIG5vbi1tZW1iZXIgcmlkZXMgdGhlIGV4aXN0aW5nIHdhbGxldC1zaGFyZSBoYW5kc2hha2UgKEZSLTEzKSxcbiAqIHNvIHRoZSByZXN1bHQgaXMgdGhlIGV4aXN0aW5nIFdhbGxldFNoYXJlIHNoYXBlLlxuICovXG5leHBvcnQgdHlwZSBXYWxsZXRTaGFyZURhdGEgPSBXYWxsZXRTaGFyZTtcblxuLy8gLS0tLSBwZXItc2FmZSBvcGVyYXRpb24gb3B0aW9ucyAtLS0tXG5cbmV4cG9ydCBpbnRlcmZhY2UgQ3JlYXRlU2FmZVdhbGxldE9wdGlvbnMge1xuICBjb2luOiBzdHJpbmc7XG4gIGxhYmVsOiBzdHJpbmc7XG4gIHBhc3NwaHJhc2U6IHN0cmluZztcbiAgdHlwZT86ICdob3QnO1xuICAvKiogYHRzc2AgdGhyb3dzIHVudGlsIE1QQyBtaW50IGxhbmRzLiBEZWZhdWx0cyB0byBgb25jaGFpbmAuICovXG4gIG11bHRpc2lnVHlwZT86ICdvbmNoYWluJyB8ICd0c3MnO1xufVxuXG5pbnRlcmZhY2UgQWRkU2FmZU1lbWJlckJhc2Uge1xuICBwZXJtaXNzaW9uczogU2FmZVBlcm1pc3Npb25bXTtcbiAgLyoqIHJlcXVpcmVkIHdoZW4gJ3NwZW5kJyBpcyBpbmNsdWRlZCDigJQgdGhlIDQgcm9vdCB1c2VyIGtleXMgRUNESC1yZS1lbmNyeXB0ZWQgdG8gdGhlIGludml0ZWUgKi9cbiAga2V5Y2hhaW5zPzogU2FmZVNoYXJlS2V5Y2hhaW5bXTtcbiAgbWVzc2FnZT86IHN0cmluZztcbiAgLyoqIHdoZW4gdHJ1ZSwgc3VwcHJlc3MgdGhlIGludml0YXRpb24gZW1haWwgdGhhdCB3b3VsZCBvdGhlcndpc2UgYmUgc2VudCB0byBgZW1haWxgICovXG4gIGRpc2FibGVFbWFpbD86IGJvb2xlYW47XG59XG5cbi8qKiBBZGQgYSBtZW1iZXIgYnkgZWl0aGVyIGB1c2VySWRgIG9yIGBlbWFpbGAg4oCUIGV4YWN0bHkgb25lIGlzIHJlcXVpcmVkLiAqL1xuZXhwb3J0IHR5cGUgQWRkU2FmZU1lbWJlck9wdGlvbnMgPVxuICB8IChBZGRTYWZlTWVtYmVyQmFzZSAmIHsgdXNlcklkOiBzdHJpbmc7IGVtYWlsPzogbmV2ZXIgfSlcbiAgfCAoQWRkU2FmZU1lbWJlckJhc2UgJiB7IGVtYWlsOiBzdHJpbmc7IHVzZXJJZD86IG5ldmVyIH0pO1xuXG5leHBvcnQgaW50ZXJmYWNlIEFkZFNhZmVXYWxsZXRNZW1iZXJPcHRpb25zIHtcbiAgd2FsbGV0SWQ6IHN0cmluZztcbiAgLyoqIHJlcXVpcmVkIOKAlCBzaGFyaW5nIHJlLWVuY3J5cHRzIHRoZSB1c2VyIGtleSwgd2hpY2ggbmVlZHMgaGFyZGVuZWQgZGVyaXZhdGlvbiBmcm9tIHRoZSBwYXNzcGhyYXNlICovXG4gIHdhbGxldFBhc3NwaHJhc2U6IHN0cmluZztcbiAgZW1haWw/OiBzdHJpbmc7XG4gIHBlcm1pc3Npb25zPzogc3RyaW5nW107XG4gIG1lc3NhZ2U/OiBzdHJpbmc7XG59XG5cbmV4cG9ydCB0eXBlIEFjY2VwdFNhZmVTaGFyZUFzU3BlbmRlck9wdGlvbnMgPSB7XG4gIHNhZmVTaGFyZUlkOiBzdHJpbmc7XG4gIHVzZXJQYXNzd29yZDogc3RyaW5nO1xuICBuZXdXYWxsZXRQYXNzcGhyYXNlPzogc3RyaW5nO1xufTtcbmV4cG9ydCB0eXBlIEFjY2VwdFNhZmVTaGFyZUFzTm9uU3BlbmRlck9wdGlvbnMgPSB7XG4gIHNhZmVTaGFyZUlkOiBzdHJpbmc7XG59O1xuZXhwb3J0IHR5cGUgQWNjZXB0U2FmZVNoYXJlT3B0aW9ucyA9IEFjY2VwdFNhZmVTaGFyZUFzU3BlbmRlck9wdGlvbnMgfCBBY2NlcHRTYWZlU2hhcmVBc05vblNwZW5kZXJPcHRpb25zO1xuXG4vKipcbiAqIEBleHBlcmltZW50YWxcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBJU2FmZSB7XG4gIGlkKCk6IHN0cmluZztcbiAgZW50ZXJwcmlzZUlkKCk6IHN0cmluZztcbiAgbGFiZWwoKTogc3RyaW5nO1xuICBzdGF0dXMoKTogU2FmZURhdGFbJ3N0YXR1cyddO1xuICB1cmwoZXh0cmE/OiBzdHJpbmcpOiBzdHJpbmc7XG4gIGNyZWF0ZVdhbGxldChwYXJhbXM6IENyZWF0ZVNhZmVXYWxsZXRPcHRpb25zKTogUHJvbWlzZTxXYWxsZXQ+O1xuICAvLyB3aG9sZS1zYWZlOiB2aWV3L2FkbWluL3NwZW5kL2RhcHA7IHNwZW5kIG9wZW5zIGEga2V5IHNoYXJlIChhbHNvIGhvdyBhIHNwZW5kZXIgc2VydmljZXMgYVxuICAvLyBzYWZlU2hhcmVSZXF1ZXN0cyBlbnRyeSBpbiBVTVMgb3JncylcbiAgYWRkTWVtYmVyKHBhcmFtczogQWRkU2FmZU1lbWJlck9wdGlvbnMpOiBQcm9taXNlPFNhZmVEYXRhPjtcbiAgLy8gc2hhcmUgT05FIHNhZmUgd2FsbGV0LCBub3QgdGhlIHdob2xlIHNhZmVcbiAgYWRkTWVtYmVyVG9XYWxsZXQocGFyYW1zOiBBZGRTYWZlV2FsbGV0TWVtYmVyT3B0aW9ucyk6IFByb21pc2U8V2FsbGV0U2hhcmVEYXRhPjtcbiAgbGlzdFNoYXJlcyhwYXJhbXM/OiB7IHN0YXRlPzogU2FmZVNoYXJlU3RhdGUgfSk6IFByb21pc2U8U2FmZVNoYXJlRGF0YVtdPjtcbiAgYWNjZXB0U2hhcmUocGFyYW1zOiBBY2NlcHRTYWZlU2hhcmVPcHRpb25zKTogUHJvbWlzZTxTYWZlU2hhcmVEYXRhPjtcbiAgZnJlZXplKHBhcmFtcz86IEZyZWV6ZVNhZmVCb2R5KTogUHJvbWlzZTxTYWZlRGF0YT47XG4gIGFyY2hpdmUoKTogUHJvbWlzZTxTYWZlRGF0YT47XG4gIHRvSlNPTigpOiBTYWZlRGF0YTtcbn1cbiJdfQ==

package/dist/src/bitgo/safe/iSafes.d.ts

@@ -0,0 +1,94 @@
+/**
+ * @prettier
+ *
+ * @experimental The safe client surface is experimental and may change (including breaking
+ * changes) before the public release.
+ */
+import type { InitializeSafeResponse } from '@bitgo/public-types';
+import { FinalizeSafeOptions, InitializeSafeOptions } from './iSafe';
+import { Safe } from './safe';
+/**
+ * Options for safe creation.
+ *
+ * v1 targets the HOT custody model only: the multisig root user/backup keys are generated locally
+ * by the SDK, encrypted with `passphrase`, and registered on BitGo; the MPC roots run the standard
+ * hot ceremonies with the same passphrase. Self-managed cold keys and custodial safes are out of
+ * scope for v1.
+ * @experimental
+ */
+export interface CreateSafeOptions {
+    label: string;
+    passphrase: string;
+}
+/**
+ * Handle returned by `initializeSafe`, threaded into the key ceremonies and finalize.
+ *
+ * `enabledRootSlots` is the server-decided (Flipt, evaluated once at initialize) set of root-key
+ * slots to generate; absent (older WP) falls back to all 4 slots.
+ * @experimental
+ */
+export interface SafeCreationHandle {
+    safeId: string;
+    enabledRootSlots?: InitializeSafeResponse['enabledRootSlots'];
+}
+/**
+ * The minted root key ids produced by `createSafeKeys`, as ordered [user, backup, bitgo]
+ * triplets for the enabled slots — exactly the payload `finalizeSafe` consumes.
+ * @experimental
+ */
+export type SafeKeys = FinalizeSafeOptions;
+/**
+ * @experimental
+ */
+export interface ListSafesOptions {
+    cursor?: string;
+    limit?: number;
+}
+/**
+ * @experimental
+ */
+export interface GetSafeOptions {
+    id: string;
+}
+/**
+ * @experimental
+ */
+export interface ISafes {
+    /**
+     * One-call convenience wrapper chaining the three creation phases:
+     * initialize → createSafeKeys (safeId-tagged ceremonies for the enabled root slots) → finalize.
+     * HOT custody only in v1.
+     * @experimental
+     */
+    generateSafe(params: CreateSafeOptions): Promise<Safe>;
+    /**
+     * Phase 1 — initialize a safe (metadata only, no key material). The server response is
+     * `{ id, status }` plus optional `enabledRootSlots` (no `label`/`enterpriseId`/`creator`/`users`/
+     * `createdAt` yet), so this returns that raw shape rather than a full `Safe`.
+     * @experimental
+     */
+    initializeSafe(params: InitializeSafeOptions): Promise<InitializeSafeResponse>;
+    /**
+     * Phase 2 — run the enabled root key ceremonies tagged with `safeId`; returns the minted key ids.
+     * @experimental
+     */
+    createSafeKeys(params: CreateSafeOptions & SafeCreationHandle): Promise<SafeKeys>;
+    /**
+     * Phase 3 — finalize a safe with the minted root key ids. Idempotent.
+     * @experimental
+     */
+    finalizeSafe(safeId: string, params: FinalizeSafeOptions): Promise<Safe>;
+    /**
+     * Archive a safe. Also the abandonment path for a stuck `initializing` safe.
+     * @experimental
+     */
+    archiveSafe(safeId: string): Promise<Safe>;
+    /** @experimental */
+    list(params?: ListSafesOptions): Promise<{
+        safes: Safe[];
+        nextCursor?: string;
+    }>;
+    /** @experimental */
+    get(params: GetSafeOptions): Promise<Safe>;
+}
+//# sourceMappingURL=iSafes.d.ts.map

package/dist/src/bitgo/safe/iSafes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"iSafes.d.ts","sourceRoot":"","sources":["../../../../src/bitgo/safe/iSafes.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qBAAqB,CAAC;AAClE,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AACrE,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B;;;;;;;;GAQG;AACH,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,gBAAgB,CAAC,EAAE,sBAAsB,CAAC,kBAAkB,CAAC,CAAC;CAC/D;AAED;;;;GAIG;AACH,MAAM,MAAM,QAAQ,GAAG,mBAAmB,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;;;;OAKG;IACH,YAAY,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvD;;;;;OAKG;IACH,cAAc,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAC/E;;;OAGG;IACH,cAAc,CAAC,MAAM,EAAE,iBAAiB,GAAG,kBAAkB,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAClF;;;OAGG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzE;;;OAGG;IACH,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3C,oBAAoB;IACpB,IAAI,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACjF,oBAAoB;IACpB,GAAG,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5C"}

package/dist/src/bitgo/safe/iSafes.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaVNhZmVzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vLi4vc3JjL2JpdGdvL3NhZmUvaVNhZmVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIiLCJzb3VyY2VzQ29udGVudCI6WyIvKipcbiAqIEBwcmV0dGllclxuICpcbiAqIEBleHBlcmltZW50YWwgVGhlIHNhZmUgY2xpZW50IHN1cmZhY2UgaXMgZXhwZXJpbWVudGFsIGFuZCBtYXkgY2hhbmdlIChpbmNsdWRpbmcgYnJlYWtpbmdcbiAqIGNoYW5nZXMpIGJlZm9yZSB0aGUgcHVibGljIHJlbGVhc2UuXG4gKi9cbmltcG9ydCB0eXBlIHsgSW5pdGlhbGl6ZVNhZmVSZXNwb25zZSB9IGZyb20gJ0BiaXRnby9wdWJsaWMtdHlwZXMnO1xuaW1wb3J0IHsgRmluYWxpemVTYWZlT3B0aW9ucywgSW5pdGlhbGl6ZVNhZmVPcHRpb25zIH0gZnJvbSAnLi9pU2FmZSc7XG5pbXBvcnQgeyBTYWZlIH0gZnJvbSAnLi9zYWZlJztcblxuLyoqXG4gKiBPcHRpb25zIGZvciBzYWZlIGNyZWF0aW9uLlxuICpcbiAqIHYxIHRhcmdldHMgdGhlIEhPVCBjdXN0b2R5IG1vZGVsIG9ubHk6IHRoZSBtdWx0aXNpZyByb290IHVzZXIvYmFja3VwIGtleXMgYXJlIGdlbmVyYXRlZCBsb2NhbGx5XG4gKiBieSB0aGUgU0RLLCBlbmNyeXB0ZWQgd2l0aCBgcGFzc3BocmFzZWAsIGFuZCByZWdpc3RlcmVkIG9uIEJpdEdvOyB0aGUgTVBDIHJvb3RzIHJ1biB0aGUgc3RhbmRhcmRcbiAqIGhvdCBjZXJlbW9uaWVzIHdpdGggdGhlIHNhbWUgcGFzc3BocmFzZS4gU2VsZi1tYW5hZ2VkIGNvbGQga2V5cyBhbmQgY3VzdG9kaWFsIHNhZmVzIGFyZSBvdXQgb2ZcbiAqIHNjb3BlIGZvciB2MS5cbiAqIEBleHBlcmltZW50YWxcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBDcmVhdGVTYWZlT3B0aW9ucyB7XG4gIGxhYmVsOiBzdHJpbmc7XG4gIHBhc3NwaHJhc2U6IHN0cmluZzsgLy8gZW5jcnlwdHMgdGhlIGxvY2FsbHktZ2VuZXJhdGVkIG11bHRpc2lnIHVzZXIvYmFja3VwIHBydnM7IHNoYXJlZCB3aXRoIHRoZSBNUEMgY2VyZW1vbmllc1xufVxuXG4vKipcbiAqIEhhbmRsZSByZXR1cm5lZCBieSBgaW5pdGlhbGl6ZVNhZmVgLCB0aHJlYWRlZCBpbnRvIHRoZSBrZXkgY2VyZW1vbmllcyBhbmQgZmluYWxpemUuXG4gKlxuICogYGVuYWJsZWRSb290U2xvdHNgIGlzIHRoZSBzZXJ2ZXItZGVjaWRlZCAoRmxpcHQsIGV2YWx1YXRlZCBvbmNlIGF0IGluaXRpYWxpemUpIHNldCBvZiByb290LWtleVxuICogc2xvdHMgdG8gZ2VuZXJhdGU7IGFic2VudCAob2xkZXIgV1ApIGZhbGxzIGJhY2sgdG8gYWxsIDQgc2xvdHMuXG4gKiBAZXhwZXJpbWVudGFsXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgU2FmZUNyZWF0aW9uSGFuZGxlIHtcbiAgc2FmZUlkOiBzdHJpbmc7XG4gIGVuYWJsZWRSb290U2xvdHM/OiBJbml0aWFsaXplU2FmZVJlc3BvbnNlWydlbmFibGVkUm9vdFNsb3RzJ107XG59XG5cbi8qKlxuICogVGhlIG1pbnRlZCByb290IGtleSBpZHMgcHJvZHVjZWQgYnkgYGNyZWF0ZVNhZmVLZXlzYCwgYXMgb3JkZXJlZCBbdXNlciwgYmFja3VwLCBiaXRnb11cbiAqIHRyaXBsZXRzIGZvciB0aGUgZW5hYmxlZCBzbG90cyDigJQgZXhhY3RseSB0aGUgcGF5bG9hZCBgZmluYWxpemVTYWZlYCBjb25zdW1lcy5cbiAqIEBleHBlcmltZW50YWxcbiAqL1xuZXhwb3J0IHR5cGUgU2FmZUtleXMgPSBGaW5hbGl6ZVNhZmVPcHRpb25zO1xuXG4vKipcbiAqIEBleHBlcmltZW50YWxcbiAqL1xuZXhwb3J0IGludGVyZmFjZSBMaXN0U2FmZXNPcHRpb25zIHtcbiAgY3Vyc29yPzogc3RyaW5nOyAvLyBvcGFxdWUgY3Vyc29yIGZyb20gYSBwcmV2aW91cyByZXNwb25zZSdzIG5leHRDdXJzb3JcbiAgbGltaXQ/OiBudW1iZXI7XG59XG5cbi8qKlxuICogQGV4cGVyaW1lbnRhbFxuICovXG5leHBvcnQgaW50ZXJmYWNlIEdldFNhZmVPcHRpb25zIHtcbiAgaWQ6IHN0cmluZztcbn1cblxuLyoqXG4gKiBAZXhwZXJpbWVudGFsXG4gKi9cbmV4cG9ydCBpbnRlcmZhY2UgSVNhZmVzIHtcbiAgLyoqXG4gICAqIE9uZS1jYWxsIGNvbnZlbmllbmNlIHdyYXBwZXIgY2hhaW5pbmcgdGhlIHRocmVlIGNyZWF0aW9uIHBoYXNlczpcbiAgICogaW5pdGlhbGl6ZSDihpIgY3JlYXRlU2FmZUtleXMgKHNhZmVJZC10YWdnZWQgY2VyZW1vbmllcyBmb3IgdGhlIGVuYWJsZWQgcm9vdCBzbG90cykg4oaSIGZpbmFsaXplLlxuICAgKiBIT1QgY3VzdG9keSBvbmx5IGluIHYxLlxuICAgKiBAZXhwZXJpbWVudGFsXG4gICAqL1xuICBnZW5lcmF0ZVNhZmUocGFyYW1zOiBDcmVhdGVTYWZlT3B0aW9ucyk6IFByb21pc2U8U2FmZT47XG4gIC8qKlxuICAgKiBQaGFzZSAxIOKAlCBpbml0aWFsaXplIGEgc2FmZSAobWV0YWRhdGEgb25seSwgbm8ga2V5IG1hdGVyaWFsKS4gVGhlIHNlcnZlciByZXNwb25zZSBpc1xuICAgKiBgeyBpZCwgc3RhdHVzIH1gIHBsdXMgb3B0aW9uYWwgYGVuYWJsZWRSb290U2xvdHNgIChubyBgbGFiZWxgL2BlbnRlcnByaXNlSWRgL2BjcmVhdG9yYC9gdXNlcnNgL1xuICAgKiBgY3JlYXRlZEF0YCB5ZXQpLCBzbyB0aGlzIHJldHVybnMgdGhhdCByYXcgc2hhcGUgcmF0aGVyIHRoYW4gYSBmdWxsIGBTYWZlYC5cbiAgICogQGV4cGVyaW1lbnRhbFxuICAgKi9cbiAgaW5pdGlhbGl6ZVNhZmUocGFyYW1zOiBJbml0aWFsaXplU2FmZU9wdGlvbnMpOiBQcm9taXNlPEluaXRpYWxpemVTYWZlUmVzcG9uc2U+O1xuICAvKipcbiAgICogUGhhc2UgMiDigJQgcnVuIHRoZSBlbmFibGVkIHJvb3Qga2V5IGNlcmVtb25pZXMgdGFnZ2VkIHdpdGggYHNhZmVJZGA7IHJldHVybnMgdGhlIG1pbnRlZCBrZXkgaWRzLlxuICAgKiBAZXhwZXJpbWVudGFsXG4gICAqL1xuICBjcmVhdGVTYWZlS2V5cyhwYXJhbXM6IENyZWF0ZVNhZmVPcHRpb25zICYgU2FmZUNyZWF0aW9uSGFuZGxlKTogUHJvbWlzZTxTYWZlS2V5cz47XG4gIC8qKlxuICAgKiBQaGFzZSAzIOKAlCBmaW5hbGl6ZSBhIHNhZmUgd2l0aCB0aGUgbWludGVkIHJvb3Qga2V5IGlkcy4gSWRlbXBvdGVudC5cbiAgICogQGV4cGVyaW1lbnRhbFxuICAgKi9cbiAgZmluYWxpemVTYWZlKHNhZmVJZDogc3RyaW5nLCBwYXJhbXM6IEZpbmFsaXplU2FmZU9wdGlvbnMpOiBQcm9taXNlPFNhZmU+O1xuICAvKipcbiAgICogQXJjaGl2ZSBhIHNhZmUuIEFsc28gdGhlIGFiYW5kb25tZW50IHBhdGggZm9yIGEgc3R1Y2sgYGluaXRpYWxpemluZ2Agc2FmZS5cbiAgICogQGV4cGVyaW1lbnRhbFxuICAgKi9cbiAgYXJjaGl2ZVNhZmUoc2FmZUlkOiBzdHJpbmcpOiBQcm9taXNlPFNhZmU+O1xuICAvKiogQGV4cGVyaW1lbnRhbCAqL1xuICBsaXN0KHBhcmFtcz86IExpc3RTYWZlc09wdGlvbnMpOiBQcm9taXNlPHsgc2FmZXM6IFNhZmVbXTsgbmV4dEN1cnNvcj86IHN0cmluZyB9PjtcbiAgLyoqIEBleHBlcmltZW50YWwgKi9cbiAgZ2V0KHBhcmFtczogR2V0U2FmZU9wdGlvbnMpOiBQcm9taXNlPFNhZmU+O1xufVxuIl19

package/dist/src/bitgo/safe/index.d.ts

@@ -0,0 +1,7 @@
+export * from './derivableEd25519Pub';
+export * from './iSafe';
+export * from './iSafes';
+export * from './safe';
+export * from './safeDerivation';
+export * from './safes';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/bitgo/safe/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/bitgo/safe/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,SAAS,CAAC;AACxB,cAAc,UAAU,CAAC;AACzB,cAAc,QAAQ,CAAC;AACvB,cAAc,kBAAkB,CAAC;AACjC,cAAc,SAAS,CAAC"}

package/dist/src/bitgo/safe/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./derivableEd25519Pub"), exports);
+__exportStar(require("./iSafe"), exports);
+__exportStar(require("./iSafes"), exports);
+__exportStar(require("./safe"), exports);
+__exportStar(require("./safeDerivation"), exports);
+__exportStar(require("./safes"), exports);
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvYml0Z28vc2FmZS9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7Ozs7Ozs7O0FBQUEsd0RBQXNDO0FBQ3RDLDBDQUF3QjtBQUN4QiwyQ0FBeUI7QUFDekIseUNBQXVCO0FBQ3ZCLG1EQUFpQztBQUNqQywwQ0FBd0IiLCJzb3VyY2VzQ29udGVudCI6WyJleHBvcnQgKiBmcm9tICcuL2Rlcml2YWJsZUVkMjU1MTlQdWInO1xuZXhwb3J0ICogZnJvbSAnLi9pU2FmZSc7XG5leHBvcnQgKiBmcm9tICcuL2lTYWZlcyc7XG5leHBvcnQgKiBmcm9tICcuL3NhZmUnO1xuZXhwb3J0ICogZnJvbSAnLi9zYWZlRGVyaXZhdGlvbic7XG5leHBvcnQgKiBmcm9tICcuL3NhZmVzJztcbiJdfQ==

package/dist/src/bitgo/safe/safe.d.ts

@@ -0,0 +1,61 @@
+import { FreezeSafeBody, SafeData, SafeShareData, SafeShareState } from '@bitgo/public-types';
+import { BitGoBase } from '../bitgoBase';
+import { Wallet } from '../wallet';
+import { AcceptSafeShareOptions, AddSafeMemberOptions, AddSafeWalletMemberOptions, CreateSafeWalletOptions, ISafe, WalletShareData } from './iSafe';
+/**
+ * @experimental
+ */
+export declare class Safe implements ISafe {
+    private readonly bitgo;
+    readonly _safe: SafeData;
+    constructor(bitgo: BitGoBase, safeData: SafeData);
+    id(): string;
+    enterpriseId(): string;
+    label(): string;
+    status(): SafeData['status'];
+    /**
+     * Enterprise-scoped v2 URL for this safe, e.g. /api/v2/enterprise/:eId/safes/:safeId
+     * @param extra
+     */
+    url(extra?: string): string;
+    /**
+     * Mint a child wallet: peek the sequential index, hardened-derive the user child,
+     * register it public-only, then mint. Backup and BitGo children are soft-derived on the server.
+     */
+    createWallet(params: CreateSafeWalletOptions): Promise<Wallet>;
+    private fetchSafeData;
+    /**
+     * Add a member to the whole safe (view/admin/spend). Spend opens a key share.
+     * Body lands in WCN-1204.
+     */
+    addMember(params: AddSafeMemberOptions): Promise<SafeData>;
+    /**
+     * Share ONE safe wallet with a non-member via the existing wallet-share handshake (FR-13).
+     * Body lands in WCN-1204.
+     */
+    addMemberToWallet(params: AddSafeWalletMemberOptions): Promise<WalletShareData>;
+    /**
+     * List the safe key shares visible to the caller.
+     * Body lands in WCN-1204.
+     */
+    listShares(params?: {
+        state?: SafeShareState;
+    }): Promise<SafeShareData[]>;
+    /**
+     * Accept a safe key share addressed to the caller.
+     * Body lands in WCN-1204.
+     */
+    acceptShare(params: AcceptSafeShareOptions): Promise<SafeShareData>;
+    /**
+     * Freeze the safe — blocks withdrawals on all safe wallets. Safe stays 'active'.
+     * @param params
+     */
+    freeze(params?: FreezeSafeBody): Promise<SafeData>;
+    /**
+     * Archive the safe. Requires every safe wallet to already be archived; also the abandonment
+     * path for a stuck 'initializing' safe.
+     */
+    archive(): Promise<SafeData>;
+    toJSON(): SafeData;
+}
+//# sourceMappingURL=safe.d.ts.map

package/dist/src/bitgo/safe/safe.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"safe.d.ts","sourceRoot":"","sources":["../../../../src/bitgo/safe/safe.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,aAAa,EAAE,cAAc,EAAoB,MAAM,qBAAqB,CAAC;AAGhH,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAKzC,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,OAAO,EACL,sBAAsB,EACtB,oBAAoB,EACpB,0BAA0B,EAC1B,uBAAuB,EACvB,KAAK,EACL,eAAe,EAChB,MAAM,SAAS,CAAC;AA8CjB;;GAEG;AACH,qBAAa,IAAK,YAAW,KAAK;IAChC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAY;IAClC,SAAgB,KAAK,EAAE,QAAQ,CAAC;gBAEpB,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,QAAQ;IAKhD,EAAE,IAAI,MAAM;IAIZ,YAAY,IAAI,MAAM;IAItB,KAAK,IAAI,MAAM;IAIf,MAAM,IAAI,QAAQ,CAAC,QAAQ,CAAC;IAI5B;;;OAGG;IACH,GAAG,CAAC,KAAK,SAAK,GAAG,MAAM;IAIvB;;;OAGG;IACG,YAAY,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,MAAM,CAAC;YAmEtD,aAAa;IAK3B;;;OAGG;IACG,SAAS,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIhE;;;OAGG;IACG,iBAAiB,CAAC,MAAM,EAAE,0BAA0B,GAAG,OAAO,CAAC,eAAe,CAAC;IAIrF;;;OAGG;IACG,UAAU,CAAC,MAAM,GAAE;QAAE,KAAK,CAAC,EAAE,cAAc,CAAA;KAAO,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAInF;;;OAGG;IACG,WAAW,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,aAAa,CAAC;IAIzE;;;OAGG;IACG,MAAM,CAAC,MAAM,GAAE,cAAmB,GAAG,OAAO,CAAC,QAAQ,CAAC;IAK5D;;;OAGG;IACG,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC;IAKlC,MAAM,IAAI,QAAQ;CAGnB"}