optional simulate & wallet, editable TransactionBuilder

[chadoh]

• Remove TimeoutInfinite, instead allowing people to set a timeoutInSeconds when they initialize an AssembledTransaction. Default: 10.

• No more wallet parameter. Instead, you pass:

  • publicKey – Will be used to construct the Account object that is used as the source of the transaction. Can be undefined, which means the null account will be used. Can be a string or, to ease operation with Freighter and other async-key-lookup in browser wallets, a promise of a string.

  • signTransaction: matches the signTransaction signature from Freighter. Can be left blank when you initialize the ContractClient and only provided at the time that you call signAndSend({ signTransaction: (...) => { ... } })

  • signAuthEntry: matches the signAuthEntry signature from Freighter. Can also be left initially blank, but is needed if/when you call signAuthEntries.

• You can now pass simulate: false when first creating your transaction to skip simulation. You can then modify the transaction using the TransactionBuilder at tx.raw before manually calling simulate. Example:

  const tx = await myContract.myMethod(
    { args: 'for', my: 'method', ... },
    { simulate: false }
  );
  tx.raw.addMemo(Memo.text('Nice memo, friend!'))
  await tx.simulate();
  

• Make .simulation getter public

• Error types are now collected under AssembledTransaction.Errors and
  SentTransaction.Errors.

• Move ContractClient, AssembledTransaction to separate entrypoints, so that they are not included in the global API or bundle size, but can still be packaged together with all the related stellar-sdk logic.

• Export ExampleNodeWallet from its own entrypoint, rather than hiding this logic entirely in the tests. @kalepail found this useful enough that he thought it would be worth exporting so other people can use it in their Node apps.

[Shaptic]

To move the discussion from here over:

Do you think this is important enough to bring to people's attention that we should uglify every method call in this way, or do you think there's a good-enough default?

Honestly? Yes. I'm open to opinions from users but from a security standpoint, this should be an explicit choice every time. Also from a consistency standpoint, you have to call setTimebounds/setTimeout on your TransactionBuilder no matter what and intentionally opt-in to TimeoutInfinite if you decide to make that (bad) choice.

[chadoh]

I want to make sure we're on the same page—this change removes the TimeoutInfinite default. People would need to opt into that. The default is now ten seconds.

If you already understood that, sorry for over-explaining. If that's new information, does it change your opinion?

[Shaptic]

Ahh thanks for clarifying - I guess I missed that. I don't think there should be any default at all.

[chadoh]

That's a huge change from current TS Bindings behavior and I'd like to hold off on it.

[Shaptic]

works for me 👍 then a non-inf default is better

[socket-security]

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert	Package	Note	Source
Non OSI license	npm/caniuse-lite@1.0.30001587	License: CC-BY-4.0	package.json

View full report↗︎

Next steps

What is a non OSI license?

(Experimental) Package has a non-OSI-approved license.

Consider the terms of the license for your given use case.

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/foo@1.0.0 or ignore all packages with @SocketSecurity ignore-all

• @SocketSecurity ignore npm/caniuse-lite@1.0.30001587

[chadoh]

@Shaptic I still don't have write access to this repository—could you merge if you approve? @kalepail you might also be able to merge?

[kalepail]

I don't feel comfortable merging as I'm not reviewing code as much as functionality. I'll leave that for @Shaptic

[socket-security]

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@babel/cli@7.23.9	Transitive: environment, eval, filesystem, network, shell, unsafe	+85	12.5 MB	nicolo-ribaudo
npm/@babel/core@7.23.9	environment, filesystem, unsafe Transitive: shell	+52	10.8 MB	nicolo-ribaudo
npm/@babel/eslint-parser@7.23.10	unsafe Transitive: environment, eval, filesystem, shell	+147	21.7 MB	nicolo-ribaudo
npm/@babel/helper-create-class-features-plugin@7.23.10	Transitive: environment, filesystem, shell, unsafe	+58	11.2 MB	nicolo-ribaudo
npm/@babel/parser@7.23.9	None	0	1.88 MB	nicolo-ribaudo
npm/@babel/preset-env@7.23.9	environment Transitive: filesystem, shell, unsafe	+161	15.3 MB	nicolo-ribaudo
npm/@babel/template@7.23.9	Transitive: environment	+15	4.59 MB	nicolo-ribaudo
npm/@babel/types@7.23.9	environment	+3	2.49 MB	nicolo-ribaudo
npm/@definitelytyped/dtslint@0.1.5	environment, filesystem Transitive: eval, network, shell, unsafe	+320	449 MB	definitelytyped-publisher
npm/@jridgewell/trace-mapping@0.3.22	None	+2	265 kB	jridgewell
npm/@stellar/stellar-base@11.0.0	Transitive: environment, filesystem	+12	9.3 MB	stellar-npm-ci
npm/@types/eslint@8.56.2	None	+2	243 kB	types
npm/@types/node@20.11.17	None	+1	4.07 MB	types
npm/@typescript-eslint/parser@6.21.0	Transitive: environment, eval, filesystem, shell, unsafe	+114	13.7 MB	jameshenry
npm/@typescript-eslint/types@6.21.0	None	0	156 kB	jameshenry
npm/@typescript-eslint/typescript-estree@6.21.0	Transitive: environment, filesystem	+33	2.67 MB	jameshenry
npm/@typescript-eslint/utils@6.21.0	Transitive: environment, eval, filesystem, shell, unsafe	+116	14.1 MB	jameshenry
npm/array-buffer-byte-length@1.0.1	Transitive: eval	+12	245 kB	ljharb
npm/available-typed-arrays@1.0.6	None	0	20.4 kB	ljharb
npm/axios@1.6.7	network Transitive: environment, filesystem	+8	2.21 MB	jasonsaayman
npm/browserslist@4.22.3	environment, filesystem Transitive: shell	+6	2.37 MB	ai
npm/call-bind@1.0.6	Transitive: eval	+10	214 kB	ljharb
npm/chai@4.4.1	None	+7	923 kB	keithamus
npm/chokidar@3.6.0	environment, filesystem	+14	531 kB	paulmillr
npm/core-js-compat@3.35.1	Transitive: environment, filesystem, shell	+7	3.06 MB	zloirock
npm/define-data-property@1.1.3	Transitive: eval	+8	173 kB	ljharb
npm/es-errors@1.3.0	None	0	12.3 kB	ljharb
npm/follow-redirects@1.15.5	network	0	29.4 kB	rubenverborgh
npm/get-intrinsic@1.2.4	eval	+5	124 kB	ljharb
npm/has-tostringtag@1.0.2	None	+1	38.2 kB	ljharb
npm/ignore@5.3.1	None	0	51.5 kB	kael
npm/is-array-buffer@3.0.4	Transitive: eval	+11	232 kB	ljharb
npm/is-typed-array@1.1.13	Transitive: eval	+16	359 kB	ljharb
npm/json-schema-faker@0.5.5	environment Transitive: eval, filesystem, network, unsafe	+9	4.44 MB	pateketrueke
npm/karma-webpack@5.0.1	filesystem Transitive: environment, eval, network, shell, unsafe	+90	21.5 MB	evilebottnawi
npm/lint-staged@15.2.2	Transitive: environment, filesystem, shell	+53	2.47 MB	okonet
npm/mocha@10.3.0	environment, eval, filesystem	+62	4.29 MB	joshuakgoldberg
npm/prettier@3.2.5	environment, filesystem, unsafe	0	8.39 MB	prettier-bot
npm/webpack@5.90.1	environment, filesystem, network, unsafe Transitive: eval, shell	+76	19.5 MB	evilebottnawi
npm/which-typed-array@1.1.14	Transitive: eval	+15	336 kB	ljharb

🚮 Removed packages: npm/@babel/cli@7.23.4, npm/@babel/core@7.23.7, npm/@babel/eslint-parser@7.23.3, npm/@babel/helper-create-class-features-plugin@7.23.7, npm/@babel/parser@7.23.6, npm/@babel/preset-env@7.23.8, npm/@babel/types@7.23.6, npm/@definitelytyped/dtslint@0.1.2, npm/@jridgewell/trace-mapping@0.3.20, npm/@stellar/stellar-base@10.0.1, npm/@types/eslint@8.56.1, npm/@types/node@20.10.8, npm/@typescript-eslint/parser@6.18.1, npm/@typescript-eslint/types@6.18.1, npm/@typescript-eslint/typescript-estree@6.18.1, npm/@typescript-eslint/utils@6.18.1, npm/axios@1.6.5, npm/browserslist@4.22.2, npm/call-bind@1.0.5, npm/chai@4.4.0, npm/core-js-compat@3.35.0, npm/define-data-property@1.1.1, npm/follow-redirects@1.15.4, npm/get-intrinsic@1.2.2, npm/ignore@5.3.0, npm/is-array-buffer@3.0.2, npm/is-typed-array@1.1.12, npm/json-schema-faker@0.5.4, npm/karma-webpack@5.0.0, npm/lint-staged@15.2.0, npm/mocha@10.2.0, npm/prettier@3.1.1, npm/utility-types@3.10.0, npm/webpack@5.89.0, npm/which-typed-array@1.1.13

View full report↗︎

[Shaptic]

@chadoh lmk if you'd rather I merge this and you resolve feedback in a later PR! doesn't matter to me

[chadoh]

@Shaptic ok, I addressed all your feedback here. I think this is ready to merge to bindings. I'll then open a PR from bindings back to master—I think it's probably good enough to get it merged! I really want to remove the stale logic that's hard-coded into TS Bindings and rely on this instead.

[Shaptic]

This is turning into a really strong set of tools! Thanks for bearing with all of the back-and-forth on the design 👏

[chadoh]

Thanks, @Shaptic! You'll have to merge, as I do not have permission.