Skip to content
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.

Sign up for GitHub

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

txnbuild: Make txnbuild create V1 transactions #2640

Merged
merged 3 commits into from
Jun 1, 2020
Merged

txnbuild: Make txnbuild create V1 transactions #2640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
64ab39c
Make txnbuild create V1 transactions
tamirms Jun 1, 2020
2ae49be
Update changelog
tamirms Jun 1, 2020
951e1f5
Include missing error checks in fee bump examples
tamirms Jun 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
261 changes: 110 additions & 151 deletions clients/horizonclient/examples_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1052,157 +1052,116 @@ func ExampleClient_StreamTransactions() {
}
}

// Action needed in release: horizonclient-v3.2.0
// Uncomment fee bump examples when protocol 13 is enabled
//func convertToV1Tx(tx *txnbuild.Transaction) (*txnbuild.Transaction, error) {
// // Action needed in release: horizonclient-v3.2.0
// // remove manual envelope type configuration because
// // once protocol 13 is enabled txnbuild will generate
// // v1 transaction envelopes by default
// innerTxEnvelope, err := tx.TxEnvelope()
// if err != nil {
// return nil, err
// }
//
// innerTxEnvelope.V1 = &xdr.TransactionV1Envelope{
// Tx: xdr.Transaction{
// SourceAccount: innerTxEnvelope.SourceAccount(),
// Fee: xdr.Uint32(innerTxEnvelope.Fee()),
// SeqNum: xdr.SequenceNumber(innerTxEnvelope.SeqNum()),
// TimeBounds: innerTxEnvelope.V0.Tx.TimeBounds,
// Memo: innerTxEnvelope.Memo(),
// Operations: innerTxEnvelope.Operations(),
// },
// }
// innerTxEnvelope.Type = xdr.EnvelopeTypeEnvelopeTypeTx
// innerTxEnvelope.V0 = nil
// innerTxEnvelopeB64, err := xdr.MarshalBase64(innerTxEnvelope)
// if err != nil {
// return nil, err
// }
//
// parsed, err := txnbuild.TransactionFromXDR(innerTxEnvelopeB64)
// if err != nil {
// return nil, err
// }
// tx, _ = parsed.Transaction()
// return tx, nil
//}
//
//func ExampleClient_SubmitFeeBumpTransaction() {
// kp := keypair.MustParseFull("SDQQUZMIPUP5TSDWH3UJYAKUOP55IJ4KTBXTY7RCOMEFRQGYA6GIR3OD")
// client := horizonclient.DefaultTestNetClient
// ar := horizonclient.AccountRequest{AccountID: kp.Address()}
// sourceAccount, err := client.AccountDetail(ar)
// if err != nil {
// return
// }
//
// op := txnbuild.Payment{
// Destination: kp.Address(),
// Amount: "1",
// Asset: txnbuild.NativeAsset{},
// }
//
// tx, err := txnbuild.NewTransaction(
// txnbuild.TransactionParams{
// SourceAccount: &sourceAccount,
// IncrementSequenceNum: false,
// Operations: []txnbuild.Operation{&op},
// BaseFee: txnbuild.MinBaseFee,
// Timebounds: txnbuild.NewInfiniteTimeout(), // Use a real timeout in production!
// },
// )
// if err != nil {
// fmt.Println(err)
// return
// }
// tx, err = tx.Sign(network.TestNetworkPassphrase, kp)
// if err != nil {
// fmt.Println(err)
// return
// }
//
// tx, err = convertToV1Tx(tx)
// if err != nil {
// fmt.Println(err)
// return
// }
//
// feeBumpKP := keypair.MustParseFull("SA5ZEFDVFZ52GRU7YUGR6EDPBNRU2WLA6IQFQ7S2IH2DG3VFV3DOMV2Q")
// feeBumpTx, err := txnbuild.NewFeeBumpTransaction(txnbuild.FeeBumpTransactionParams{
// Inner: tx,
// FeeAccount: feeBumpKP.Address(),
// BaseFee: txnbuild.MinBaseFee * 2,
// })
// feeBumpTx, err = feeBumpTx.Sign(network.TestNetworkPassphrase, feeBumpKP)
//
// result, err := client.SubmitFeeBumpTransaction(feeBumpTx, horizonclient.SubmitTxOpts{})
// if err != nil {
// fmt.Println(err)
// }
//
// fmt.Println(result)
//}
//
//func ExampleClient_SubmitFeeBumpTransactionWithOptions() {
// kp := keypair.MustParseFull("SDQQUZMIPUP5TSDWH3UJYAKUOP55IJ4KTBXTY7RCOMEFRQGYA6GIR3OD")
// client := horizonclient.DefaultTestNetClient
// ar := horizonclient.AccountRequest{AccountID: kp.Address()}
// sourceAccount, err := client.AccountDetail(ar)
// if err != nil {
// return
// }
//
// op := txnbuild.Payment{
// Destination: kp.Address(),
// Amount: "1",
// Asset: txnbuild.NativeAsset{},
// }
//
// tx, err := txnbuild.NewTransaction(
// txnbuild.TransactionParams{
// SourceAccount: &sourceAccount,
// IncrementSequenceNum: false,
// Operations: []txnbuild.Operation{&op},
// BaseFee: txnbuild.MinBaseFee,
// Timebounds: txnbuild.NewInfiniteTimeout(), // Use a real timeout in production!
// },
// )
// if err != nil {
// fmt.Println(err)
// return
// }
// tx, err = tx.Sign(network.TestNetworkPassphrase, kp)
// if err != nil {
// fmt.Println(err)
// return
// }
//
// tx, err = convertToV1Tx(tx)
// if err != nil {
// fmt.Println(err)
// return
// }
//
// feeBumpKP := keypair.MustParseFull("SA5ZEFDVFZ52GRU7YUGR6EDPBNRU2WLA6IQFQ7S2IH2DG3VFV3DOMV2Q")
// feeBumpTx, err := txnbuild.NewFeeBumpTransaction(txnbuild.FeeBumpTransactionParams{
// Inner: tx,
// FeeAccount: feeBumpKP.Address(),
// BaseFee: txnbuild.MinBaseFee * 2,
// })
// feeBumpTx, err = feeBumpTx.Sign(network.TestNetworkPassphrase, feeBumpKP)
//
// result, err := client.SubmitFeeBumpTransaction(
// feeBumpTx,
// horizonclient.SubmitTxOpts{SkipMemoRequiredCheck: true},
// )
// if err != nil {
// fmt.Println(err)
// }
//
// fmt.Println(result)
//}
func ExampleClient_SubmitFeeBumpTransaction() {
kp := keypair.MustParseFull("SDQQUZMIPUP5TSDWH3UJYAKUOP55IJ4KTBXTY7RCOMEFRQGYA6GIR3OD")
client := horizonclient.DefaultTestNetClient
ar := horizonclient.AccountRequest{AccountID: kp.Address()}
sourceAccount, err := client.AccountDetail(ar)
if err != nil {
return
}

op := txnbuild.Payment{
Destination: kp.Address(),
Amount: "1",
Asset: txnbuild.NativeAsset{},
}

tx, err := txnbuild.NewTransaction(
txnbuild.TransactionParams{
SourceAccount: &sourceAccount,
IncrementSequenceNum: false,
Operations: []txnbuild.Operation{&op},
BaseFee: txnbuild.MinBaseFee,
Timebounds: txnbuild.NewInfiniteTimeout(), // Use a real timeout in production!
},
)
if err != nil {
fmt.Println(err)
return
}
tx, err = tx.Sign(network.TestNetworkPassphrase, kp)
if err != nil {
fmt.Println(err)
return
}

feeBumpKP := keypair.MustParseFull("SA5ZEFDVFZ52GRU7YUGR6EDPBNRU2WLA6IQFQ7S2IH2DG3VFV3DOMV2Q")
feeBumpTx, err := txnbuild.NewFeeBumpTransaction(txnbuild.FeeBumpTransactionParams{
Inner: tx,
FeeAccount: feeBumpKP.Address(),
BaseFee: txnbuild.MinBaseFee * 2,
})
feeBumpTx, err = feeBumpTx.Sign(network.TestNetworkPassphrase, feeBumpKP)
Comment on lines +1090 to +1095
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you skip checking these two errors on purpose? Same question to the below example.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that is mistake, I'll push a fix

if err != nil {
fmt.Println(err)
return
}

result, err := client.SubmitFeeBumpTransaction(feeBumpTx)
if err != nil {
fmt.Println(err)
}

fmt.Println(result)
}

func ExampleClient_SubmitFeeBumpTransactionWithOptions() {
kp := keypair.MustParseFull("SDQQUZMIPUP5TSDWH3UJYAKUOP55IJ4KTBXTY7RCOMEFRQGYA6GIR3OD")
client := horizonclient.DefaultTestNetClient
ar := horizonclient.AccountRequest{AccountID: kp.Address()}
sourceAccount, err := client.AccountDetail(ar)
if err != nil {
return
}

op := txnbuild.Payment{
Destination: kp.Address(),
Amount: "1",
Asset: txnbuild.NativeAsset{},
}

tx, err := txnbuild.NewTransaction(
txnbuild.TransactionParams{
SourceAccount: &sourceAccount,
IncrementSequenceNum: false,
Operations: []txnbuild.Operation{&op},
BaseFee: txnbuild.MinBaseFee,
Timebounds: txnbuild.NewInfiniteTimeout(), // Use a real timeout in production!
},
)
if err != nil {
fmt.Println(err)
return
}
tx, err = tx.Sign(network.TestNetworkPassphrase, kp)
if err != nil {
fmt.Println(err)
return
}

feeBumpKP := keypair.MustParseFull("SA5ZEFDVFZ52GRU7YUGR6EDPBNRU2WLA6IQFQ7S2IH2DG3VFV3DOMV2Q")
feeBumpTx, err := txnbuild.NewFeeBumpTransaction(txnbuild.FeeBumpTransactionParams{
Inner: tx,
FeeAccount: feeBumpKP.Address(),
BaseFee: txnbuild.MinBaseFee * 2,
})
feeBumpTx, err = feeBumpTx.Sign(network.TestNetworkPassphrase, feeBumpKP)
if err != nil {
fmt.Println(err)
return
}

result, err := client.SubmitFeeBumpTransactionWithOptions(
feeBumpTx,
horizonclient.SubmitTxOpts{SkipMemoRequiredCheck: true},
)
if err != nil {
fmt.Println(err)
}

fmt.Println(result)
}

func ExampleClient_SubmitTransaction() {
kp := keypair.MustParseFull("SDQQUZMIPUP5TSDWH3UJYAKUOP55IJ4KTBXTY7RCOMEFRQGYA6GIR3OD")
Expand Down
39 changes: 4 additions & 35 deletions clients/horizonclient/main_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@ import (
"github.com/stellar/go/support/errors"
"github.com/stellar/go/support/http/httptest"
"github.com/stellar/go/txnbuild"
"github.com/stellar/go/xdr"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func TestFixHTTP(t *testing.T) {
Expand Down Expand Up @@ -883,7 +881,7 @@ func TestSubmitTransactionRequest(t *testing.T) {
// successful tx with config.memo_required not found
hmock.On(
"POST",
"https://localhost/transactions?tx=AAAAAAU08yUQ8sHqhY8j9mXWwERfHC%2F3cKFSe%2FspAr0rGtO2AAAAZAAAAAAAAAABAAAAAQAAAAAAAAAAAAAAAAAAAAoAAAAAAAAAAQAAAAAAAAABAAAAAAU08yUQ8sHqhY8j9mXWwERfHC%2F3cKFSe%2FspAr0rGtO2AAAAAAAAAAAF9eEAAAAAAAAAAAErGtO2AAAAQKZUywjRbomZ8k14vOAf4%2Bx5kDYCBgZmXzNoeCQ6%2BFnDrkeP05oJ3DrKywbnmq7tfaxq4kDB%2FFqhMviDBuYf3gc%3D",
"https://localhost/transactions?tx=AAAAAgAAAAAFNPMlEPLB6oWPI%2FZl1sBEXxwv93ChUnv7KQK9KxrTtgAAAGQAAAAAAAAAAQAAAAEAAAAAAAAAAAAAAAAAAAAKAAAAAAAAAAEAAAAAAAAAAQAAAAAFNPMlEPLB6oWPI%2FZl1sBEXxwv93ChUnv7KQK9KxrTtgAAAAAAAAAABfXhAAAAAAAAAAABKxrTtgAAAECmVMsI0W6JmfJNeLzgH%2BPseZA2AgYGZl8zaHgkOvhZw65Hj9OaCdw6yssG55qu7X2sauJAwfxaoTL4gwbmH94H",
).ReturnString(200, txSuccess)

hmock.On(
Expand All @@ -905,32 +903,6 @@ func TestSubmitTransactionRequest(t *testing.T) {
assert.Equal(t, ErrAccountRequiresMemo, errors.Cause(err))
}

func convertToV1Tx(t *testing.T, tx *txnbuild.Transaction) *txnbuild.Transaction {
// Action needed in release: horizonclient-v3.2.0
// remove manual envelope type configuration because
// once protocol 13 is enabled txnbuild will generate
// v1 transaction envelopes by default
innerTxEnvelope, err := tx.TxEnvelope()
require.NoError(t, err)
innerTxEnvelope.V1 = &xdr.TransactionV1Envelope{
Tx: xdr.Transaction{
SourceAccount: innerTxEnvelope.SourceAccount(),
Fee: xdr.Uint32(innerTxEnvelope.Fee()),
SeqNum: xdr.SequenceNumber(innerTxEnvelope.SeqNum()),
TimeBounds: innerTxEnvelope.V0.Tx.TimeBounds,
Memo: innerTxEnvelope.Memo(),
Operations: innerTxEnvelope.Operations(),
},
}
innerTxEnvelope.Type = xdr.EnvelopeTypeEnvelopeTypeTx
innerTxEnvelope.V0 = nil
innerTxEnvelopeB64, err := xdr.MarshalBase64(innerTxEnvelope)
require.NoError(t, err)
parsed, err := txnbuild.TransactionFromXDR(innerTxEnvelopeB64)
tx, _ = parsed.Transaction()
return tx
}

func TestSubmitFeeBumpTransaction(t *testing.T) {
hmock := httptest.NewClient()
client := &Client{
Expand Down Expand Up @@ -961,7 +933,6 @@ func TestSubmitFeeBumpTransaction(t *testing.T) {
tx, err = tx.Sign(network.TestNetworkPassphrase, kp)
assert.NoError(t, err)

tx = convertToV1Tx(t, tx)
feeBumpKP := keypair.MustParseFull("SA5ZEFDVFZ52GRU7YUGR6EDPBNRU2WLA6IQFQ7S2IH2DG3VFV3DOMV2Q")
feeBumpTx, err := txnbuild.NewFeeBumpTransaction(txnbuild.FeeBumpTransactionParams{
Inner: tx,
Expand Down Expand Up @@ -1055,7 +1026,7 @@ func TestSubmitTransactionWithOptionsRequest(t *testing.T) {
// successful tx
hmock.On(
"POST",
"https://localhost/transactions?tx=AAAAAAU08yUQ8sHqhY8j9mXWwERfHC%2F3cKFSe%2FspAr0rGtO2AAAAZAAAAAAAAAABAAAAAQAAAAAAAAAAAAAAAAAAAAoAAAAAAAAAAQAAAAAAAAABAAAAAAU08yUQ8sHqhY8j9mXWwERfHC%2F3cKFSe%2FspAr0rGtO2AAAAAAAAAAAF9eEAAAAAAAAAAAErGtO2AAAAQKZUywjRbomZ8k14vOAf4%2Bx5kDYCBgZmXzNoeCQ6%2BFnDrkeP05oJ3DrKywbnmq7tfaxq4kDB%2FFqhMviDBuYf3gc%3D",
"https://localhost/transactions?tx=AAAAAgAAAAAFNPMlEPLB6oWPI%2FZl1sBEXxwv93ChUnv7KQK9KxrTtgAAAGQAAAAAAAAAAQAAAAEAAAAAAAAAAAAAAAAAAAAKAAAAAAAAAAEAAAAAAAAAAQAAAAAFNPMlEPLB6oWPI%2FZl1sBEXxwv93ChUnv7KQK9KxrTtgAAAAAAAAAABfXhAAAAAAAAAAABKxrTtgAAAECmVMsI0W6JmfJNeLzgH%2BPseZA2AgYGZl8zaHgkOvhZw65Hj9OaCdw6yssG55qu7X2sauJAwfxaoTL4gwbmH94H",
).ReturnString(200, txSuccess)

_, err = client.SubmitTransactionWithOptions(tx, SubmitTxOpts{SkipMemoRequiredCheck: true})
Expand All @@ -1064,7 +1035,7 @@ func TestSubmitTransactionWithOptionsRequest(t *testing.T) {
// successful tx with config.memo_required not found
hmock.On(
"POST",
"https://localhost/transactions?tx=AAAAAAU08yUQ8sHqhY8j9mXWwERfHC%2F3cKFSe%2FspAr0rGtO2AAAAZAAAAAAAAAABAAAAAQAAAAAAAAAAAAAAAAAAAAoAAAAAAAAAAQAAAAAAAAABAAAAAAU08yUQ8sHqhY8j9mXWwERfHC%2F3cKFSe%2FspAr0rGtO2AAAAAAAAAAAF9eEAAAAAAAAAAAErGtO2AAAAQKZUywjRbomZ8k14vOAf4%2Bx5kDYCBgZmXzNoeCQ6%2BFnDrkeP05oJ3DrKywbnmq7tfaxq4kDB%2FFqhMviDBuYf3gc%3D",
"https://localhost/transactions?tx=AAAAAgAAAAAFNPMlEPLB6oWPI%2FZl1sBEXxwv93ChUnv7KQK9KxrTtgAAAGQAAAAAAAAAAQAAAAEAAAAAAAAAAAAAAAAAAAAKAAAAAAAAAAEAAAAAAAAAAQAAAAAFNPMlEPLB6oWPI%2FZl1sBEXxwv93ChUnv7KQK9KxrTtgAAAAAAAAAABfXhAAAAAAAAAAABKxrTtgAAAECmVMsI0W6JmfJNeLzgH%2BPseZA2AgYGZl8zaHgkOvhZw65Hj9OaCdw6yssG55qu7X2sauJAwfxaoTL4gwbmH94H",
).ReturnString(200, txSuccess)

hmock.On(
Expand All @@ -1088,7 +1059,7 @@ func TestSubmitTransactionWithOptionsRequest(t *testing.T) {
// skips memo check if tx includes a memo
hmock.On(
"POST",
"https://localhost/transactions?tx=AAAAAAU08yUQ8sHqhY8j9mXWwERfHC%2F3cKFSe%2FspAr0rGtO2AAAAZAAAAAAAAAACAAAAAQAAAAAAAAAAAAAAAAAAAAoAAAABAAAACkhlbGxvV29ybGQAAAAAAAEAAAAAAAAAAQAAAAAFNPMlEPLB6oWPI%2FZl1sBEXxwv93ChUnv7KQK9KxrTtgAAAAAAAAAABfXhAAAAAAAAAAABKxrTtgAAAEDusMdn4dwEhBtYHIxkvdpPbfVa7CM6HG9vRzWLe8%2FMCtQIT4d0IgleroyT%2FF2EmPpAQQmuDXm4DGR7c%2FeTa9YL",
"https://localhost/transactions?tx=AAAAAgAAAAAFNPMlEPLB6oWPI%2FZl1sBEXxwv93ChUnv7KQK9KxrTtgAAAGQAAAAAAAAAAgAAAAEAAAAAAAAAAAAAAAAAAAAKAAAAAQAAAApIZWxsb1dvcmxkAAAAAAABAAAAAAAAAAEAAAAABTTzJRDyweqFjyP2ZdbARF8cL%2FdwoVJ7%2BykCvSsa07YAAAAAAAAAAAX14QAAAAAAAAAAASsa07YAAABA7rDHZ%2BHcBIQbWByMZL3aT231WuwjOhxvb0c1i3vPzArUCE%2BHdCIJXq6Mk%2FxdhJj6QEEJrg15uAxke3P3k2vWCw%3D%3D",
).ReturnString(200, txSuccess)

tx, err = txnbuild.NewTransaction(
Expand Down Expand Up @@ -1140,7 +1111,6 @@ func TestSubmitFeeBumpTransactionWithOptions(t *testing.T) {
tx, err = tx.Sign(network.TestNetworkPassphrase, kp)
assert.NoError(t, err)

tx = convertToV1Tx(t, tx)
feeBumpKP := keypair.MustParseFull("SA5ZEFDVFZ52GRU7YUGR6EDPBNRU2WLA6IQFQ7S2IH2DG3VFV3DOMV2Q")
feeBumpTx, err := txnbuild.NewFeeBumpTransaction(txnbuild.FeeBumpTransactionParams{
Inner: tx,
Expand Down Expand Up @@ -1221,7 +1191,6 @@ func TestSubmitFeeBumpTransactionWithOptions(t *testing.T) {
)
assert.NoError(t, err)

tx = convertToV1Tx(t, tx)
feeBumpKP = keypair.MustParseFull("SA5ZEFDVFZ52GRU7YUGR6EDPBNRU2WLA6IQFQ7S2IH2DG3VFV3DOMV2Q")
feeBumpTx, err = txnbuild.NewFeeBumpTransaction(txnbuild.FeeBumpTransactionParams{
Inner: tx,
Expand Down
Loading