<!-- The default pull request template is for types feat, fix, or refactor. For other templates, add one of the following parameters to the url: - template=docs.md - template=other.md --> ## Description Closes: #8700 <!-- Add a description of the changes that this PR introduces and the files that are the most critical to review. --> --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [x] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] provided a link to the relevant issue or specification - [x] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [x] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [x] added a changelog entry to `CHANGELOG.md` - [x] included comments for [documenting Go code](https://blog.golang.org/godoc) - [x] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
64 lines
2.0 KiB
Go
64 lines
2.0 KiB
Go
package rest
|
|
|
|
import (
|
|
"encoding/base64"
|
|
"fmt"
|
|
"io/ioutil"
|
|
"net/http"
|
|
|
|
"github.com/cosmos/cosmos-sdk/client"
|
|
clientrest "github.com/cosmos/cosmos-sdk/client/rest"
|
|
"github.com/cosmos/cosmos-sdk/client/tx"
|
|
"github.com/cosmos/cosmos-sdk/types/rest"
|
|
"github.com/cosmos/cosmos-sdk/x/auth/migrations/legacytx"
|
|
)
|
|
|
|
// EncodeResp defines a tx encoding response.
|
|
type EncodeResp struct {
|
|
Tx string `json:"tx" yaml:"tx"`
|
|
}
|
|
|
|
// ErrEncodeDecode is the error to show when encoding/decoding txs that are not
|
|
// amino-serializable (e.g. IBC txs).
|
|
var ErrEncodeDecode error = fmt.Errorf("this endpoint does not support txs that are not serializable"+
|
|
" via Amino, such as txs that contain IBC `Msg`s. For more info, please refer to our"+
|
|
" REST migration guide at %s", clientrest.DeprecationURL)
|
|
|
|
// EncodeTxRequestHandlerFn returns the encode tx REST handler. In particular,
|
|
// it takes a json-formatted transaction, encodes it to the Amino wire protocol,
|
|
// and responds with base64-encoded bytes.
|
|
func EncodeTxRequestHandlerFn(clientCtx client.Context) http.HandlerFunc {
|
|
return func(w http.ResponseWriter, r *http.Request) {
|
|
var req legacytx.StdTx
|
|
|
|
body, err := ioutil.ReadAll(r.Body)
|
|
if rest.CheckBadRequestError(w, err) {
|
|
return
|
|
}
|
|
|
|
// NOTE: amino is used intentionally here, don't migrate it
|
|
err = clientCtx.LegacyAmino.UnmarshalJSON(body, &req)
|
|
// If there's an unmarshalling error, we assume that it's because we're
|
|
// using amino to unmarshal a non-amino tx.
|
|
if err != nil {
|
|
if rest.CheckBadRequestError(w, ErrEncodeDecode) {
|
|
return
|
|
}
|
|
}
|
|
|
|
// re-encode it in the chain's native binary format
|
|
txBytes, err := tx.ConvertAndEncodeStdTx(clientCtx.TxConfig, req)
|
|
if rest.CheckInternalServerError(w, err) {
|
|
return
|
|
}
|
|
|
|
// base64 encode the encoded tx bytes
|
|
txBytesBase64 := base64.StdEncoding.EncodeToString(txBytes)
|
|
|
|
response := EncodeResp{Tx: txBytesBase64}
|
|
|
|
// NOTE: amino is set intentionally here, don't migrate it
|
|
rest.PostProcessResponseBare(w, clientCtx, response)
|
|
}
|
|
}
|