All files / src Wallet.ts

78.1% Statements 107/137
44.44% Branches 12/27
75.75% Functions 25/33
80.3% Lines 106/132

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 36657x                                                                                                                     57x   57x                     67x 67x 67x 67x   67x 67x 67x   67x 67x                 11x     11x                                         4x     4x     2x     2x     10x     10x     8x     8x     10x     10x       6x 6x                 30x 4x   30x 30x 30x               12x 12x 11x 11x       8x       27x 20x 20x 20x 19x 1x   19x       9x 9x 8x 8x               2x 2x 2x 1x 1x   1x                   1x 1x                       1x 1x 1x 1x       1x 1x 1x 1x                                                       12x 12x   8x 8x 8x   8x   8x 3x 3x 3x 3x   3x 3x 5x 4x     8x       2x 2x   2x   2x       5x 5x   3x   1x       8x 8x   8x   8x       1x 1x   1x   1x                                 2x 2x 2x       4x 4x 3x       2x 2x 1x       1x 1x      
import {
  Beef,
  BeefParty,
  Utils,
  WalletInterface,
  ProtoWallet,
  TrustSelf,
  OriginatorDomainNameStringUnder250Bytes,
  ListActionsArgs,
  ListActionsResult,
  CreateActionArgs,
  CreateActionResult,
  ListOutputsArgs,
  ListOutputsResult,
  ListCertificatesArgs,
  ListCertificatesResult,
  AcquireCertificateArgs,
  AcquireCertificateResult,
  RelinquishCertificateArgs,
  RelinquishCertificateResult,
  ProveCertificateArgs,
  ProveCertificateResult,
  DiscoverByIdentityKeyArgs,
  DiscoverCertificatesResult,
  DiscoverByAttributesArgs,
  RelinquishOutputArgs,
  RelinquishOutputResult,
  AuthenticatedResult,
  GetHeightResult,
  GetHeaderResult,
  GetHeaderArgs,
  GetNetworkResult,
  GetVersionResult,
  CreateHmacArgs,
  CreateHmacResult,
  CreateSignatureArgs,
  CreateSignatureResult,
  GetPublicKeyArgs,
  GetPublicKeyResult,
  RevealCounterpartyKeyLinkageArgs,
  RevealCounterpartyKeyLinkageResult,
  RevealSpecificKeyLinkageArgs,
  RevealSpecificKeyLinkageResult,
  VerifyHmacArgs,
  VerifyHmacResult,
  VerifySignatureArgs,
  VerifySignatureResult,
  WalletDecryptArgs,
  WalletDecryptResult,
  WalletEncryptArgs,
  WalletEncryptResult,
  AbortActionArgs,
  AbortActionResult,
  SignActionResult,
  SignActionArgs,
  InternalizeActionArgs,
  InternalizeActionResult,
  PubKeyHex
} from '@bsv/sdk'
import { sdk, toWalletNetwork, Monitor } from './index.client'
 
export class Wallet implements WalletInterface {
  signer: sdk.WalletSigner
  services?: sdk.WalletServices
  monitor?: Monitor
 
  beef: BeefParty
  trustSelf?: TrustSelf
  userParty: string
  proto: ProtoWallet
 
  constructor(signer: sdk.WalletSigner, services?: sdk.WalletServices, monitor?: Monitor) {
    this.proto = new ProtoWallet(signer.keyDeriver)
    this.signer = signer
    this.services = services
    this.monitor = monitor
 
    this.userParty = `user ${signer.getClientChangeKeyPair().publicKey}`
    this.beef = new BeefParty([this.userParty])
    this.trustSelf = 'known'
 
    if (services) {
      signer.setServices(services)
    }
  }
 
  async getIdentityKey(): Promise<PubKeyHex> {
    return (await this.getPublicKey({ identityKey: true })).publicKey
  }
 
  getPublicKey(args: GetPublicKeyArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<GetPublicKeyResult> {
    Iif (args.privileged) {
      // TODO
    }
    return this.proto.getPublicKey(args)
  }
  revealCounterpartyKeyLinkage(args: RevealCounterpartyKeyLinkageArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<RevealCounterpartyKeyLinkageResult> {
    Iif (args.privileged) {
      // TODO
    }
    return this.proto.revealCounterpartyKeyLinkage(args)
  }
  revealSpecificKeyLinkage(args: RevealSpecificKeyLinkageArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<RevealSpecificKeyLinkageResult> {
    Iif (args.privileged) {
      // TODO
    }
    return this.proto.revealSpecificKeyLinkage(args)
  }
  encrypt(args: WalletEncryptArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<WalletEncryptResult> {
    Iif (args.privileged) {
      // TODO
    }
    return this.proto.encrypt(args)
  }
  decrypt(args: WalletDecryptArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<WalletDecryptResult> {
    Iif (args.privileged) {
      // TODO
    }
    return this.proto.decrypt(args)
  }
  createHmac(args: CreateHmacArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<CreateHmacResult> {
    Iif (args.privileged) {
      // TODO
    }
    return this.proto.createHmac(args)
  }
  verifyHmac(args: VerifyHmacArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<VerifyHmacResult> {
    Iif (args.privileged) {
      // TODO
    }
    return this.proto.verifyHmac(args)
  }
  createSignature(args: CreateSignatureArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<CreateSignatureResult> {
    Iif (args.privileged) {
      // TODO
    }
    return this.proto.createSignature(args)
  }
  verifySignature(args: VerifySignatureArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<VerifySignatureResult> {
    Iif (args.privileged) {
      // TODO
    }
    return this.proto.verifySignature(args)
  }
 
  getServices(): sdk.WalletServices {
    Iif (!this.services) throw new sdk.WERR_INVALID_PARAMETER('services', 'valid in constructor arguments to be retreived here.')
    return this.services
  }
 
  /**
   * @returns the full list of txids whose validity this wallet claims to know.
   *
   * @param newKnownTxids Optional. Additional new txids known to be valid by the caller to be merged.
   */
  getKnownTxids(newKnownTxids?: string[]): string[] {
    if (newKnownTxids) {
      for (const txid of newKnownTxids) this.beef.mergeTxidOnly(txid)
    }
    const r = this.beef.sortTxs()
    const knownTxids = r.valid.concat(r.txidOnly)
    return knownTxids
  }
 
  //////////////////
  // List Methods
  //////////////////
 
  async listActions(args: ListActionsArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<ListActionsResult> {
    sdk.validateOriginator(originator)
    sdk.validateListActionsArgs(args)
    const r = await this.signer.listActions(args)
    return r
  }
 
  get storageParty(): string {
    return `storage ${this.signer.getStorageIdentity().storageIdentityKey}`
  }
 
  async listOutputs(args: ListOutputsArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<ListOutputsResult> {
    sdk.validateOriginator(originator)
    sdk.validateListOutputsArgs(args)
    const knownTxids = this.getKnownTxids()
    const r = await this.signer.listOutputs(args, knownTxids)
    if (r.BEEF) {
      this.beef.mergeBeefFromParty(this.storageParty, r.BEEF)
    }
    return r
  }
 
  async listCertificates(args: ListCertificatesArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<ListCertificatesResult> {
    sdk.validateOriginator(originator)
    sdk.validateListCertificatesArgs(args)
    const r = await this.signer.listCertificates(args)
    return r
  }
 
  //////////////////
  // Certificates
  //////////////////
 
  async acquireCertificate(args: AcquireCertificateArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<AcquireCertificateResult> {
    sdk.validateOriginator(originator)
    if (args.acquisitionProtocol === 'direct') {
      const vargs = sdk.validateAcquireDirectCertificateArgs(args)
      vargs.subject = (await this.getPublicKey({ identityKey: true, privileged: args.privileged, privilegedReason: args.privilegedReason })).publicKey
      try {
        // Confirm that the information received adds up to a usable certificate...
        await sdk.CertOps.fromCounterparty(this, {
          certificate: { ...vargs },
          keyring: vargs.keyringForSubject,
          counterparty: vargs.keyringRevealer === 'certifier' ? vargs.certifier : vargs.keyringRevealer
        })
      } catch (eu: unknown) {
        const e = sdk.WalletError.fromUnknown(eu)
        throw new sdk.WERR_INVALID_PARAMETER('args', `valid encrypted and signed certificate and keyring from revealer. ${e.name}: ${e.message}`)
      }
 
      const r = await this.signer.acquireDirectCertificate(args)
      return r
    }
 
    Iif (args.acquisitionProtocol === 'issuance') {
      const vargs = await sdk.validateAcquireCertificateArgs(args)
      throw new sdk.WERR_NOT_IMPLEMENTED()
    }
 
    throw new sdk.WERR_INVALID_PARAMETER('acquisitionProtocol', `valid. ${args.acquisitionProtocol} is unrecognized.`)
  }
 
  async relinquishCertificate(args: RelinquishCertificateArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<RelinquishCertificateResult> {
    sdk.validateOriginator(originator)
    sdk.validateRelinquishCertificateArgs(args)
    const r = await this.signer.relinquishCertificate(args)
    return r
  }
 
  async proveCertificate(args: ProveCertificateArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<ProveCertificateResult> {
    originator = sdk.validateOriginator(originator)
    sdk.validateProveCertificateArgs(args)
    const r = await this.signer.proveCertificate(args)
    return r
  }
 
  async discoverByIdentityKey(args: DiscoverByIdentityKeyArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<DiscoverCertificatesResult> {
    sdk.validateOriginator(originator)
    sdk.validateDiscoverByIdentityKeyArgs(args)
 
    // TODO: Probably does not get dispatched to signer?
    const r = await this.signer.discoverByIdentityKey(args)
 
    return r
  }
 
  async discoverByAttributes(args: DiscoverByAttributesArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<DiscoverCertificatesResult> {
    sdk.validateOriginator(originator)
    sdk.validateDiscoverByAttributesArgs(args)
 
    // TODO: Probably does not get dispatched to signer?
    const r = await this.signer.discoverByAttributes(args)
 
    return r
  }
 
  //////////////////
  // Actions
  //////////////////
 
  async createAction(args: CreateActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<CreateActionResult> {
    sdk.validateOriginator(originator)
    sdk.validateCreateActionArgs(args)
 
    Iif (!args.options) args.options = {}
    args.options.trustSelf ||= this.trustSelf
    args.options.knownTxids = this.getKnownTxids(args.options.knownTxids)
 
    const r = await this.signer.createAction(args)
 
    if (r.signableTransaction) {
      const st = r.signableTransaction
      const ab = Beef.fromBinary(st.tx)
      Iif (!ab.atomicTxid) throw new sdk.WERR_INTERNAL('Missing atomicTxid in signableTransaction result')
      Iif (ab.txs.length < 1 || ab.txs[ab.txs.length - 1].txid !== ab.atomicTxid) throw new sdk.WERR_INTERNAL('atomicTxid does not match txid of last AtomicBEEF transaction')
      // Remove the new, partially constructed transaction from beef as it will never be a valid transaction.
      ab.txs.slice(ab.txs.length - 1)
      this.beef.mergeBeefFromParty(this.storageParty, ab)
    } else if (r.tx) {
      this.beef.mergeBeefFromParty(this.storageParty, r.tx)
    }
 
    return r
  }
 
  async signAction(args: SignActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<SignActionResult> {
    sdk.validateOriginator(originator)
    sdk.validateSignActionArgs(args)
 
    const r = await this.signer.signAction(args)
 
    return r
  }
 
  async abortAction(args: AbortActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<AbortActionResult> {
    sdk.validateOriginator(originator)
    const vargs = sdk.validateAbortActionArgs(args)
 
    const r = await this.signer.abortAction(vargs)
 
    return r
  }
 
  async internalizeAction(args: InternalizeActionArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<InternalizeActionResult> {
    sdk.validateOriginator(originator)
    sdk.validateInternalizeActionArgs(args)
 
    const r = await this.signer.internalizeAction(args)
 
    return r
  }
 
  async relinquishOutput(args: RelinquishOutputArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<RelinquishOutputResult> {
    sdk.validateOriginator(originator)
    sdk.validateRelinquishOutputArgs(args)
 
    const r = await this.signer.relinquishOutput(args)
 
    return r
  }
 
  async isAuthenticated(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<AuthenticatedResult> {
    sdk.validateOriginator(originator)
    const r: { authenticated: true } = {
      authenticated: true
    }
    return r
  }
 
  async waitForAuthentication(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<AuthenticatedResult> {
    sdk.validateOriginator(originator)
    return { authenticated: true }
  }
 
  async getHeight(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<GetHeightResult> {
    sdk.validateOriginator(originator)
    const height = await this.getServices().getHeight()
    return { height }
  }
 
  async getHeaderForHeight(args: GetHeaderArgs, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<GetHeaderResult> {
    sdk.validateOriginator(originator)
    const serializedHeader = await this.getServices().getHeaderForHeight(args.height)
    return { header: Utils.toHex(serializedHeader) }
  }
 
  async getNetwork(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<GetNetworkResult> {
    sdk.validateOriginator(originator)
    const chain = await this.signer.getChain()
    return { network: toWalletNetwork(chain) }
  }
 
  async getVersion(args: {}, originator?: OriginatorDomainNameStringUnder250Bytes): Promise<GetVersionResult> {
    sdk.validateOriginator(originator)
    return { version: 'wallet-brc100-1.0.0' }
  }
}