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 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 | 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 35x 25x 35x 3x 3x 35x 8x 8x 7x 6x 2x 35x 35x 96x 96x 96x 43x 12x 35x 6x 6x 6x 35x 35x 10x 10x 35x 7x 7x 7x 7x 23x 54x 23x 12x 23x 5x 7x 2x 5x 35x 3x 3x 3x 1x 2x 2x 35x 10x 35x 35x 12x 11x 1x 1x 10x 35x 12x 12x 11x 1x 10x 2x 35x 3x 3x 3x 3x 3x 35x 32x 32x 35x 20x 1x 1x 1x 1x 1x 3x 3x 3x 3x 3x 3x 3x 16x 16x 16x 16x 16x 5x 2x 3x 18x 1x 10x 10x 8x 8x 8x 8x 13x 13x 13x 13x 8x 4x 1x 3x 4x 3x 3x 3x 5x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 1x 1x 1x 1x 1x 1x 2x 2x 2x 2x 3x 2x 11x 11x 11x 11x 11x 7x 5x 12x 7x 7x 11x 18x 18x 18x 18x 1x 18x 16x 16x 1x 2x 2x 14x 14x 14x 14x 14x 14x 14x 14x 3x 11x 1x 11x 9x 9x 1x 8x 1x 7x 7x 2x 2x 9x 2x 2x 8x 8x 6x 1x 6x 4x 4x 4x 3x 1x 1x 1x 2x 2x 35x 35x 20x 4x 4x 4x 4x 3x 3x 1x 1x 35x 20x | import { APIErrorCode, ApiError, Bytes, Cbor, Cip30DataSignature, Cip95WalletApi, DataSignError, DataSignErrorCode, Paginate, SenderContext, TxSendError, TxSendErrorCode, TxSignError, TxSignErrorCode, WalletApi, WalletApiExtension, WithSenderContext } from '@cardano-sdk/dapp-connector'; import { Cardano, Serialization, coalesceValueQuantities } from '@cardano-sdk/core'; import { HexBlob, ManagedFreeableScope } from '@cardano-sdk/util'; import { InputSelectionError, InputSelectionFailure } from '@cardano-sdk/input-selection'; import { Logger } from 'ts-log'; import { MessageSender } from '@cardano-sdk/key-management'; import { Observable, firstValueFrom, from, map, mergeMap, race, throwError } from 'rxjs'; import { ObservableWallet } from './types'; import { requiresForeignSignatures } from './services'; import uniq from 'lodash/uniq.js'; export type Cip30WalletDependencies = { logger: Logger; }; export enum Cip30ConfirmationCallbackType { SignData = 'sign_data', SignTx = 'sign_tx', SubmitTx = 'submit_tx', GetCollateral = 'get_collateral' } export type SignDataCallbackParams = { type: Cip30ConfirmationCallbackType.SignData; sender: MessageSender; data: { addr: Cardano.PaymentAddress | Cardano.DRepID; payload: HexBlob; }; }; export type SignTxCallbackParams = { sender: MessageSender; type: Cip30ConfirmationCallbackType.SignTx; data: Cardano.Tx; }; export type SubmitTxCallbackParams = { type: Cip30ConfirmationCallbackType.SubmitTx; data: Cardano.Tx; }; // Optional callback export type GetCollateralCallbackParams = { sender: MessageSender; type: Cip30ConfirmationCallbackType.GetCollateral; data: { amount: Cardano.Lovelace; utxos: Cardano.Utxo[]; }; }; type GetCollateralCallback = (args: GetCollateralCallbackParams) => Promise<Cardano.Utxo[]>; export type SignConfirmationOk = { cancel$: Observable<void> }; export type SignConfirmationResult = SignConfirmationOk | false; const signOrCancel = <T>(result: Promise<T>, { cancel$ }: SignConfirmationOk, createError: () => Error) => firstValueFrom(race(from(result), cancel$.pipe(mergeMap(() => throwError(createError))))); export type CallbackConfirmation = { signData: (args: SignDataCallbackParams) => Promise<SignConfirmationResult>; signTx: (args: SignTxCallbackParams) => Promise<SignConfirmationResult>; submitTx: (args: SubmitTxCallbackParams) => Promise<boolean>; getCollateral?: GetCollateralCallback; }; const mapCallbackFailure = (err: unknown, logger: Logger): false => { logger.error(err); return false; }; const processTxInput = (input: string) => { try { const cbor = Serialization.TxCBOR(input); const tx = Serialization.TxCBOR.deserialize(cbor); return { cbor, tx }; } catch { throw new ApiError(APIErrorCode.InvalidRequest, "Couldn't parse transaction. Expecting hex-encoded CBOR string."); } }; const MAX_COLLATERAL_AMOUNT = 5_000_000n; const compareUtxos = (utxo: Cardano.Utxo, comparedTo: Cardano.Utxo) => { const currentCoin = utxo[1].value.coins; const comparedToCoin = comparedTo[1].value.coins; if (currentCoin < comparedToCoin) return -1; if (currentCoin > comparedToCoin) return 1; return 0; }; const cardanoAddressToCbor = (address: Cardano.PaymentAddress | Cardano.RewardAccount): Cbor => { const addr = Cardano.Address.fromString(address); Iif (!addr) { throw new ApiError(APIErrorCode.InternalError, `could not transform address ${address} to CBOR`); } return addr.toBytes(); }; const formatUnknownError = (error: unknown): string => (error as Error)?.message || 'Unknown error'; const parseValueCbor = (value: Cbor) => { try { return Serialization.Value.fromCbor(value as unknown as HexBlob); } catch { throw new ApiError(APIErrorCode.InvalidRequest, 'could not parse Value'); } }; const dumbSelection = (utxos: Cardano.Utxo[], target: Cardano.Value) => { const selectedUtxos: Cardano.Utxo[] = []; const filterAmountAssets = [...(target.assets?.entries() || [])]; let foundEnough = false; for (const utxo of utxos) { selectedUtxos.push(utxo); const selectedValue = coalesceValueQuantities(selectedUtxos.map(([_, { value }]) => value)); foundEnough = selectedValue.coins >= target.coins && filterAmountAssets.every( ([assetId, requestedQuantity]) => (selectedValue.assets?.get(assetId) || 0n) >= requestedQuantity ); if (foundEnough) { break; } } if (!foundEnough) { return null; } return selectedUtxos; }; const walletSelection = async (target: Cardano.Value, wallet: ObservableWallet) => { try { /** * Getting UTxOs to meet a required amount is a complex operation, * which is handled by input selection capabilities. By initializing * a transaction we're able to utilise the internal configuration and * algorithm to make this selection, using a wallet address to * satisfy the interface only. */ const addresses = await firstValueFrom(wallet.addresses$); const { inputSelection } = await wallet.initializeTx({ outputs: new Set([{ address: addresses[0].address, value: target }]) }); return [...inputSelection.inputs]; } catch (error) { if (error instanceof InputSelectionError && error.failure === InputSelectionFailure.UtxoBalanceInsufficient) { return null; } const message = formatUnknownError(error); throw new ApiError(APIErrorCode.InternalError, message); } }; /** * Select utxo via either default wallet's default input selection algorithm, * or 'dumb selection', which should preserve the order of utxos for pagination. */ const selectUtxo = async (wallet: ObservableWallet, filterAmount: Cardano.Value, useDumbSelection: boolean) => useDumbSelection ? dumbSelection(await firstValueFrom(wallet.utxo.available$), filterAmount) : await walletSelection(filterAmount, wallet); /** Returns an array of UTxOs that do not contain assets */ const getUtxosWithoutAssets = (utxos: Cardano.Utxo[]): Cardano.Utxo[] => utxos.filter((utxo) => !utxo[1].value.assets); const getFilterAsBigNum = (amount: Cbor): bigint => { const reader = new Serialization.CborReader(HexBlob(amount)); if ( reader.peekState() === Serialization.CborReaderState.Tag && reader.peekTag() === Serialization.CborTag.UnsignedBigNum ) { reader.readTag(); return BigInt(`0x${HexBlob.fromBytes(reader.readByteString())}`).valueOf(); } return reader.readInt(); }; const getFilterAmount = (amount: Cbor): bigint => { try { const filterAmount = getFilterAsBigNum(amount); if (filterAmount > MAX_COLLATERAL_AMOUNT) { throw new ApiError(APIErrorCode.InvalidRequest, 'requested amount is too big'); } return filterAmount; } catch (error) { throw new ApiError(APIErrorCode.InternalError, formatUnknownError(error)); } }; /** * getCollateralCallback * * @param sender The sender of the request * @param amount ADA collateral required in lovelaces * @param availableUtxos available UTxOs * @param callback Callback to execute to attempt setting new collateral * @param logger The logger instance * @returns Promise<Cbor[]> or null */ const getCollateralCallback = async ( sender: MessageSender, amount: Cardano.Lovelace, availableUtxos: Cardano.Utxo[], callback: GetCollateralCallback, logger: Logger ) => { Iif (availableUtxos.length === 0) return null; const availableUtxosWithoutAssets = getUtxosWithoutAssets(availableUtxos); try { // Send the amount and filtered available UTxOs to the callback // Client can then choose to mark a UTxO set as unspendable const newCollateral = await callback({ data: { amount, utxos: availableUtxosWithoutAssets }, sender, type: Cip30ConfirmationCallbackType.GetCollateral }); return newCollateral.map((core) => Serialization.TransactionUnspentOutput.fromCore(core).toCbor()); } catch (error) { logger.error(error); Iif (error instanceof ApiError) { throw error; } throw new ApiError(APIErrorCode.InternalError, formatUnknownError(error)); } }; const getSortedUtxos = async (observableUtxos: Observable<Cardano.Utxo[]>): Promise<Cardano.Utxo[]> => { const utxos = await firstValueFrom(observableUtxos); return utxos.sort(compareUtxos); }; const baseCip30WalletApi = ( wallet$: Observable<ObservableWallet>, confirmationCallback: CallbackConfirmation, { logger }: Cip30WalletDependencies ) => ({ getBalance: async (): Promise<Cbor> => { logger.debug('getting balance'); try { const wallet = await firstValueFrom(wallet$); const value = await firstValueFrom(wallet.balance.utxo.available$); return Serialization.Value.fromCore(value).toCbor(); } catch (error) { logger.error(error); throw error; } }, getChangeAddress: async (): Promise<Cbor> => { logger.debug('getting changeAddress'); try { const wallet = await firstValueFrom(wallet$); const addresses = await firstValueFrom(wallet.addresses$); const address = addresses[0].address; Iif (!address) { logger.error('could not get change address'); throw new ApiError(APIErrorCode.InternalError, 'could not get change address'); } else { return cardanoAddressToCbor(address); } } catch (error) { logger.error(error); Iif (error instanceof ApiError) { throw error; } throw new ApiError(APIErrorCode.InternalError, formatUnknownError(error)); } }, // eslint-disable-next-line max-statements, sonarjs/cognitive-complexity,complexity getCollateral: async ( { sender }: SenderContext, { amount = new Serialization.Value(MAX_COLLATERAL_AMOUNT).toCbor() }: { amount?: Cbor } = {} ): Promise< Cbor[] | null // eslint-disable-next-line sonarjs/cognitive-complexity, max-statements > => { logger.debug('getting collateral'); const wallet = await firstValueFrom(wallet$); let unspendables = await getSortedUtxos(wallet.utxo.unspendable$); const available = await getSortedUtxos(wallet.utxo.available$); // No available unspendable UTxO if (unspendables.length === 0) { if (available.length > 0 && !!confirmationCallback.getCollateral) { // available UTxOs could be set as collateral based on user preference return await getCollateralCallback( sender, getFilterAmount(amount), available, confirmationCallback.getCollateral, logger ); } return null; } if (unspendables.some((utxo) => utxo[1].value.assets && utxo[1].value.assets.size > 0)) { throw new ApiError(APIErrorCode.Refused, 'unspendable UTxOs must not contain assets when used as collateral'); } if (amount) { const filterAmount = getFilterAmount(amount); try { const utxos = []; let totalCoins = 0n; for (const utxo of unspendables) { const coin = utxo[1].value.coins; totalCoins += coin; utxos.push(utxo); if (totalCoins >= filterAmount) break; } if (totalCoins < filterAmount) { // if no collateral available by amount in unspendables, return callback if provided to set unspendables and return in the callback if (available.length > 0 && !!confirmationCallback.getCollateral) { return await getCollateralCallback( sender, filterAmount, available, confirmationCallback.getCollateral, logger ); } throw new ApiError(APIErrorCode.Refused, 'not enough coins in configured collateral UTxOs'); } unspendables = utxos; } catch (error) { logger.error(error); if (error instanceof ApiError) { throw error; } throw new ApiError(APIErrorCode.InternalError, formatUnknownError(error)); } } return unspendables.map((core) => Serialization.TransactionUnspentOutput.fromCore(core).toCbor()); }, getExtensions: async (): Promise<WalletApiExtension[]> => { logger.debug('getting enabled extensions'); return Promise.resolve([{ cip: 95 }]); }, getNetworkId: async (): Promise<Cardano.NetworkId> => { logger.debug('getting networkId'); const wallet = await firstValueFrom(wallet$); const genesisParameters = await firstValueFrom(wallet.genesisParameters$); return genesisParameters.networkId; }, getRewardAddresses: async (): Promise<Cbor[]> => { logger.debug('getting reward addresses'); try { const wallet = await firstValueFrom(wallet$); const walletAddresses = await firstValueFrom(wallet.addresses$); const rewardAccounts = uniq(walletAddresses.map((address) => address.rewardAccount)); Iif (!rewardAccounts || rewardAccounts.length === 0) { throw new ApiError(APIErrorCode.InternalError, 'could not get reward address'); } else { return rewardAccounts.map((rewardAccount) => cardanoAddressToCbor(rewardAccount)); } } catch (error) { logger.error(error); Iif (error instanceof ApiError) { throw error; } throw new ApiError(APIErrorCode.InternalError, formatUnknownError(error)); } }, getUnusedAddresses: async (): Promise<Cbor[]> => { logger.debug('getting unused addresses'); const wallet = await firstValueFrom(wallet$); const addresses = await wallet.getNextUnusedAddress(); return addresses.map((groupAddresses) => cardanoAddressToCbor(groupAddresses.address)); }, getUsedAddresses: async (): Promise<Cbor[]> => { logger.debug('getting used addresses'); const wallet = await firstValueFrom(wallet$); const trackedAddresses = await firstValueFrom(wallet.addresses$); const unusedAddresses = await wallet.getNextUnusedAddress(); const addresses = trackedAddresses.filter((address) => !unusedAddresses.includes(address)); return addresses.map((groupAddresses) => cardanoAddressToCbor(groupAddresses.address)); }, getUtxos: async (_: SenderContext, amount?: Cbor, paginate?: Paginate): Promise<Cbor[] | null> => { const scope = new ManagedFreeableScope(); try { const wallet = await firstValueFrom(wallet$); let utxos = amount ? await selectUtxo(wallet, parseValueCbor(amount).toCore(), !!paginate) : await firstValueFrom(wallet.utxo.available$); if (!utxos) return null; if (paginate) { utxos = utxos.slice(paginate.page * paginate.limit, paginate.page * paginate.limit + paginate.limit); } const cbor = utxos.map((core) => Serialization.TransactionUnspentOutput.fromCore(core).toCbor()); scope.dispose(); return cbor; } finally { scope.dispose(); } }, signData: async ( { sender }: SenderContext, addr: Cardano.PaymentAddress | Cardano.DRepID | Bytes, payload: Bytes ): Promise<Cip30DataSignature> => { logger.debug('signData'); const hexBlobPayload = HexBlob(payload); const signWith = Cardano.DRepID.isValid(addr) ? Cardano.DRepID(addr) : Cardano.PaymentAddress(addr); const confirmationResult = await confirmationCallback .signData({ data: { addr: signWith, payload: hexBlobPayload }, sender, type: Cip30ConfirmationCallbackType.SignData }) .catch((error) => mapCallbackFailure(error, logger)); if (confirmationResult) { const wallet = await firstValueFrom(wallet$); return signOrCancel( wallet.signData({ payload: hexBlobPayload, sender, signWith }), confirmationResult, () => new DataSignError(DataSignErrorCode.UserDeclined, 'user declined signing') ); } logger.debug('sign data declined'); throw new DataSignError(DataSignErrorCode.UserDeclined, 'user declined signing'); }, signTx: async ({ sender }: SenderContext, tx: Cbor, partialSign?: Boolean): Promise<Cbor> => { const scope = new ManagedFreeableScope(); logger.debug('signTx', tx); const txCbor = Serialization.TxCBOR(tx); const txDecoded = Serialization.Transaction.fromCbor(txCbor); const wallet = await firstValueFrom(wallet$); const coreTx = txDecoded.toCore(); const needsForeignSignature = await requiresForeignSignatures(coreTx, wallet); // If partialSign is false and the wallet could not sign the entire transaction if (!partialSign && needsForeignSignature) throw new TxSignError( TxSignErrorCode.ProofGeneration, 'The wallet does not have the secret key associated with some of the inputs or certificates.' ); const confirmationResult = await confirmationCallback .signTx({ data: coreTx, sender, type: Cip30ConfirmationCallbackType.SignTx }) .catch((error) => mapCallbackFailure(error, logger)); if (confirmationResult) { try { const { witness: { signatures } } = await signOrCancel( wallet.finalizeTx({ signingContext: { sender }, tx: txCbor }), confirmationResult, () => new TxSignError(TxSignErrorCode.UserDeclined, 'user declined signing tx') ); // If partialSign is true, the wallet only tries to sign what it can. However, if // signatures size is 0 then throw. if (partialSign && signatures.size === 0) { throw new TxSignError( TxSignErrorCode.ProofGeneration, 'The wallet does not have the secret key associated with any of the inputs and certificates.' ); } const cbor = Serialization.TransactionWitnessSet.fromCore({ signatures }).toCbor(); return Promise.resolve(cbor); } catch (error) { if (error instanceof TxSignError) { throw error; } else E{ logger.error(error); const message = formatUnknownError(error); throw new TxSignError(TxSignErrorCode.UserDeclined, message); } } finally { scope.dispose(); } } else { scope.dispose(); throw new TxSignError(TxSignErrorCode.UserDeclined, 'user declined signing tx'); } }, submitTx: async (_: SenderContext, input: Cbor): Promise<string> => { logger.debug('submitting tx'); const { cbor, tx } = processTxInput(input); const shouldProceed = await confirmationCallback .submitTx({ data: tx, type: Cip30ConfirmationCallbackType.SubmitTx }) .catch((error) => mapCallbackFailure(error, logger)); if (shouldProceed) { try { const wallet = await firstValueFrom(wallet$); await wallet.submitTx(cbor); return tx.id; } catch (error) { logger.error(error); const info = error instanceof Error ? error.message : 'unknown'; throw new TxSendError(TxSendErrorCode.Failure, info); } } else { logger.debug('transaction refused'); throw new TxSendError(TxSendErrorCode.Refused, 'transaction refused'); } } }); const getPubStakeKeys = async ( wallet$: Observable<ObservableWallet>, filter: Cardano.StakeCredentialStatus.Registered | Cardano.StakeCredentialStatus.Unregistered ) => { const wallet = await firstValueFrom(wallet$); return firstValueFrom( wallet.publicStakeKeys$.pipe( map((keys) => keys.filter(({ credentialStatus }) => { const status = credentialStatus === Cardano.StakeCredentialStatus.Registered || credentialStatus === Cardano.StakeCredentialStatus.Registering ? Cardano.StakeCredentialStatus.Registered : Cardano.StakeCredentialStatus.Unregistered; return filter === status; }) ), map((keys) => keys.map(({ publicStakeKey }) => publicStakeKey)) ) ); }; const extendedCip95WalletApi = ( wallet$: Observable<ObservableWallet>, { logger }: Cip30WalletDependencies ): Cip95WalletApi => ({ getPubDRepKey: async () => { logger.debug('getting public DRep key'); try { const wallet = await firstValueFrom(wallet$); const dReKey = await wallet.governance.getPubDRepKey(); Iif (!dReKey) throw new Error('Shared wallet does not support DRep key'); return dReKey; } catch (error) { logger.error(error); throw new ApiError(APIErrorCode.InternalError, formatUnknownError(error)); } }, getRegisteredPubStakeKeys: async () => { logger.debug('getting registered public stake keys'); try { return await getPubStakeKeys(wallet$, Cardano.StakeCredentialStatus.Registered); } catch (error) { logger.error(error); throw new ApiError(APIErrorCode.InternalError, formatUnknownError(error)); } }, getUnregisteredPubStakeKeys: async () => { logger.debug('getting unregistered public stake keys'); try { return await getPubStakeKeys(wallet$, Cardano.StakeCredentialStatus.Unregistered); } catch (error) { logger.error(error); throw new ApiError(APIErrorCode.InternalError, formatUnknownError(error)); } } }); export const createWalletApi = ( wallet$: Observable<ObservableWallet>, confirmationCallback: CallbackConfirmation, { logger }: Cip30WalletDependencies ): WithSenderContext<WalletApi> => ({ ...baseCip30WalletApi(wallet$, confirmationCallback, { logger }), ...extendedCip95WalletApi(wallet$, { logger }) }); |