-
Notifications
You must be signed in to change notification settings - Fork 138
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add support for CAP0015 (FeeBump). #321
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Only nitpicks
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some minor comments. Also we need to support all error codes, see https://github.com/stellar/stellar-protocol/blob/master/core/cap-0015.md
* Fix hash generation with v1 or v0 transactions. * Fix transaction envelope for TransactionV1Envelope. * Add hidden flag to allow building v1 tx with tx builder. * Add Transaction.buildFeeBumpTransaction * Change v1 feature flag name. * Add docs for new methods. * Fix ts types. * Start fee and source from tx. * Add innerFee and innerSignatures. * Fix test and make all related args a string. * Add tests against expected xdr. * Move buildFeeBumpTransaction to TransactionBuilder class. * Fix ts tests. * Calculate fee from baseFee. * Move helper back to transaction. * Validate minFee. * Show received envelope type. * Fix dependency cycle. * Move buildFeeBumpTransaction to transaction builder. * Add second condition for minimum base base. * Fix types. * Add comment. * Simplify minBase fee check. * Receive a Transaction instead of a xdr.TransactionV1Envelope. * Fix type for buildFeeBumpTransaction. * Fix typo for _envelopeType. * Remove unused import * Use builder to generate innerTx. * Fix test. * Add test for invalid envelopeType. * Validate transaction envelope to be of type v1.
This version brings protocol 13 support with backwards compatibility support for protocol 12. ### Add - Add `TransactionBuilder.buildFeeBumpTransaction` which makes it easy to create `FeeBumpTransaction` ([#321](#321)). - Adds a feature flag which allow consumers of this library to create V1 (protocol 13) transactions using the `TransactionBuilder` ([#321](#321)). - Add support for [CAP0027](https://github.com/stellar/stellar-protocol/blob/master/core/cap-0027.md): First-class multiplexed accounts ([#325](#325)). - Add `Keypair.xdrMuxedAccount` which creates a new `xdr.MuxedAccount`([#325](#325)). - Add `FeeBumpTransaction` which makes it easy to work with fee bump transactions ([#328](#328)). - Add `TransactionBuilder.fromXDR` which receives an xdr envelope and return a `Transaction` or `FeeBumpTransaction` ([#328](#328)). ### Update - Update XDR definitions with protocol 13 ([#317](#317)). - Extend `Transaction` to work with `TransactionV1Envelope` and `TransactionV0Envelope` ([#317](#317)). - Add backward compatibility support for [CAP0018](https://github.com/stellar/stellar-protocol/blob/f01c9354aaab1e8ca97a25cf888829749cadf36a/core/cap-0018.md) ([#317](#317)). - Update operations builder to support multiplexed accounts ([#337](#337)). This allows you to specify an `M` account as the destination or source: ``` var destination = 'MAAAAAAAAAAAAAB7BQ2L7E5NBWMXDUCMZSIPOBKRDSBYVLMXGSSKF6YNPIB7Y77ITLVL6'; var amount = '1000.0000000'; var asset = new StellarBase.Asset( 'USDUSD', 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7' ); var source = 'MAAAAAAAAAAAAAB7BQ2L7E5NBWMXDUCMZSIPOBKRDSBYVLMXGSSKF6YNPIB7Y77ITLVL6'; StellarBase.Operation.payment({ destination, asset, amount, source }); ``` **To use multiplexed accounts you need an instance of Stellar running on Protocol 13 or higher** ### Breaking changes - `Transaction.toEnvelope()` returns a protocol 13 `xdr.TransactionEnvelope` which is an `xdr.Union` ([#317](#317)). If you have code that looks like this `transaction.toEnvelope().tx` you have two options: - You can grab the value wrapped by the union, calling `value()` like `transaction.toEnvelope().value().tx`. - You can check which is the discriminant by using `switch()` and then call `v0()`, `v1()`, or `feeBump()`. - The return value from `Transaction.fee` changed from `number` to `string`. This brings support for `Int64` values ([#321](#321)). - The const `BASE_FEE` changed from `number` to `string` ([#321](#321)). - The option `fee` passed to `new TransactionBuilder({fee: ..})` changed from `number` to `string` ([#321](#321)). - The following fields, which were previously an `xdr.AccountID` are now a `xdr.MuxedAccount` ([#325](#325)): - `PaymentOp.destination` - `PathPaymentStrictReceiveOp.destination` - `PathPaymentStrictSendOp.destination` - `Operation.sourceAccount` - `Operation.destination` (for `ACCOUNT_MERGE`) - `Transaction.sourceAccount` - `FeeBumpTransaction.feeSource` You can get the string representation by calling `StrKey.encodeMuxedAccount` which will return a `G..` or `M..` account. - Remove the following deprecated functions ([#331](#331)): - `Operation.manageOffer` - `Operation.createPassiveOffer` - `Operation.pathPayment` - `Keypair.fromBase58Seed` - Remove the `Network` class ([#331](#331)). - Remove `vendor/base58.js` ([#331](#331)).
What
Add support for CAP0015.
Why
Protocol 13 introduces a new kind of transaction which allows other accounts to pay the fee for a given transaction.
This pull request adds a new helper functions which makes it easy for consumers of this library to create a fee bump transaction.
This PR:
.buildFeeBumpTransaction
toTransactionBuilder
which makes it easy to createFeeBumpTransaction
.Transaction
class which allows consumer to know if the transaction is aFeeBump
transaction or not.TransactionBuilder
.Fixes #319
How to create FeeBump transactions?
Assuming you have a valid version of stellar-core and Horizon running with protocol 13, you can use the following example to create a fee bump transaction (replace keypairs):
Breaking changes
fee
inTransaction
instances changed fromnumber
tostring
.BASE_FEE
changed fromnumber
tostring
.fee
passed tonew TransactionBuilder({fee: ..})
changed fromnumber
tostring