Hooks -> Callbacks

Close #16

Author: bartekn

config-example.toml

@@ -21,6 +21,6 @@ url = "root:@/gateway_test?parseTime=true"
 authorizing_seed = "SDMRITVCFY6IIK6H5DXIVUOL342YFVE3VFOGVF3D7XXHGITPX4ABMYXR" # GCAW3TYUYGCNODKO4QKMD6PSH5GP3KES4GWGVFCKZ6DD6EJUDUQ77BO
 receiving_account_id = "GAJBUSUTGTS3MAU2KP6MWJFJACDN4ZJ5YCET23U6XYZZ7WUD2OYQQUR2"
 
-[hooks]
+[callbacks]
 receive = "http://localhost:8002/receive"
 error = "http://localhost:8002/error"

readme_bridge.md

@@ -40,9 +40,9 @@ The `config_bridge.toml` file must be present in a working directory. Config fil
   * `base_seed` - The secret seed of the account used to send payments. If left blank you will need to pass it in calls to `/payment`. 
   * `authorizing_seed` - The secret seed of the public key that is able to submit `allow_trust` operations on the issuing account.
   * `issuing_account_id` - The account ID of the issuing account.
-  * `receiving_account_id` - The account ID that receives incoming payments. The `receive hook` will be called when a payment is received by this account.
-* `hooks`
-  * `receive` - URL of the webhook where requests will be sent when a new payment is sent to the receiving account. The bridge server will keep calling the receive hook indefinitely until 200 OK status is returned by it. **WARNING** The bridge server can send multiple requests to this webhook for a single payment! You need to be prepared for it. See: [Security](#security).
+  * `receiving_account_id` - The account ID that receives incoming payments. The `callbacks.receive` will be called when a payment is received by this account.
+* `callbacks`
+  * `receive` - URL of the webhook where requests will be sent when a new payment is sent to the receiving account. The bridge server will keep calling the receive callback indefinitely until 200 OK status is returned by it. **WARNING** The bridge server can send multiple requests to this webhook for a single payment! You need to be prepared for it. See: [Security](#security).
   * `error` - URL of the webhook where requests will be sent when there is an error with an incoming payment
 * `log_format` - set to `json` for JSON logs
 
@@ -347,18 +347,18 @@ It will return [`SubmitTransactionResponse`](./blob/master/src/github.com/stella
 * [`AllowTrustTrustNotRequired`](./blob/master/src/github.com/stellar/gateway/protocols/bridge/authorize.go)
 * [`AllowTrustCantRevoke`](./blob/master/src/github.com/stellar/gateway/protocols/bridge/authorize.go)
 
-## Hooks
+## Callbacks
 
 The Bridge server listens for payment operations to the account specified by `accounts.receiving_account_id`. Every time 
-a payment arrives it will send a HTTP POST request to `hooks.receive`.
+a payment arrives it will send a HTTP POST request to `callbacks.receive`.
 
 `Content-Type` of requests data will be `application/x-www-form-urlencoded`.
 
-### `hooks.receive`
+### `callbacks.receive`
 
-The POST request with following parameters will be sent to this hook when a payment arrives.
+The POST request with following parameters will be sent to this callback when a payment arrives.
 
-> **Warning!** This hook can be called multiple times. Please check `id` parameter and respond with `200 OK` in case of duplicate payment.
+> **Warning!** This callback can be called multiple times. Please check `id` parameter and respond with `200 OK` in case of duplicate payment.
 
 #### Request
 
@@ -381,8 +381,8 @@ Respond with `200 OK` when processing succeeded. Any other status code will be c
 * This server must be set up in an isolated environment (ex. AWS VPC). Please make sure your firewall is properly configured 
 and accepts connections from a trusted IPs only. You can also set the `api_key` config parameter but it's not recommended. 
 If you don't set this properly, an unauthorized person will be able to submit transactions from your accounts!
-* Make sure the `hooks` you provide only accept connections from the bridge server IP.
-* Remember that `hooks.receive` may be called multiple times with the same payment. Check `id` parameter and ignore 
+* Make sure the `callbacks` you provide only accept connections from the bridge server IP.
+* Remember that `callbacks.receive` may be called multiple times with the same payment. Check `id` parameter and ignore 
 requests with the same value (just send `200 OK` response).
 
 ## Building

src/github.com/stellar/gateway/bridge/app.go

@@ -115,8 +115,8 @@ func NewApp(config config.Config, migrateFlag bool) (app *App, err error) {
 
 	if config.Accounts.ReceivingAccountID == "" {
 		log.Warning("No accounts.receiving_account_id param. Skipping...")
-	} else if config.Hooks.Receive == "" {
-		log.Warning("No hooks.receive param. Skipping...")
+	} else if config.Callbacks.Receive == "" {
+		log.Warning("No callbacks.receive param. Skipping...")
 	} else {
 		paymentListener, err = listener.NewPaymentListener(&config, entityManager, &h, repository, time.Now)
 		if err != nil {

src/github.com/stellar/gateway/bridge/config/config.go

@@ -21,7 +21,7 @@ type Config struct {
 		URL  string
 	}
 	Accounts
-	Hooks
+	Callbacks
 }
 
 // Asset represents credit asset
@@ -38,8 +38,8 @@ type Accounts struct {
 	ReceivingAccountID string `mapstructure:"receiving_account_id"`
 }
 
-// Hooks contains values of `hooks` config group
-type Hooks struct {
+// Callbacks contains values of `callbacks` config group
+type Callbacks struct {
 	Receive string
 	Error   string
 }
@@ -123,18 +123,18 @@ func (c *Config) Validate() (err error) {
 		}
 	}
 
-	if c.Hooks.Receive != "" {
-		_, err = url.Parse(c.Hooks.Receive)
+	if c.Callbacks.Receive != "" {
+		_, err = url.Parse(c.Callbacks.Receive)
 		if err != nil {
-			err = errors.New("Cannot parse hooks.receive param")
+			err = errors.New("Cannot parse callbacks.receive param")
 			return
 		}
 	}
 
-	if c.Hooks.Error != "" {
-		_, err = url.Parse(c.Hooks.Error)
+	if c.Callbacks.Error != "" {
+		_, err = url.Parse(c.Callbacks.Error)
 		if err != nil {
-			err = errors.New("Cannot parse hooks.error param")
+			err = errors.New("Cannot parse callbacks.error param")
 			return
 		}
 	}

src/github.com/stellar/gateway/listener/payment_listener.go

@@ -29,7 +29,7 @@ type PaymentListener struct {
 	now           func() time.Time
 }
 
-const hookTimeout = 10 * time.Second
+const callbackTimeout = 10 * time.Second
 
 // NewPaymentListener creates a new PaymentListener
 func NewPaymentListener(
@@ -40,7 +40,7 @@ func NewPaymentListener(
 	now func() time.Time,
 ) (pl PaymentListener, err error) {
 	pl.client = &http.Client{
-		Timeout: hookTimeout,
+		Timeout: callbackTimeout,
 	}
 	pl.config = config
 	pl.entityManager = entityManager
@@ -192,7 +192,7 @@ func (pl PaymentListener) onPayment(payment horizon.PaymentResponse) (err error)
 	}
 
 	resp, err := pl.client.PostForm(
-		pl.config.Hooks.Receive,
+		pl.config.Callbacks.Receive,
 		url.Values{
 			"id":         {payment.ID},
 			"from":       {payment.From},
@@ -204,23 +204,23 @@ func (pl PaymentListener) onPayment(payment horizon.PaymentResponse) (err error)
 		},
 	)
 	if err != nil {
-		pl.log.Error("Error sending request to receive hook")
+		pl.log.Error("Error sending request to receive callback")
 		return err
 	}
 
 	if resp.StatusCode != 200 {
 		defer resp.Body.Close()
 		body, err := ioutil.ReadAll(resp.Body)
 		if err != nil {
-			pl.log.Error("Error reading receive hook response")
+			pl.log.Error("Error reading receive callback response")
 			return err
 		}
 
 		pl.log.WithFields(logrus.Fields{
 			"status": resp.StatusCode,
 			"body":   string(body),
-		}).Error("Error response from receive hook")
-		return errors.New("Error response from receive hook")
+		}).Error("Error response from receive callback")
+		return errors.New("Error response from receive callback")
 	}
 
 	dbPayment.Status = "Success"

src/github.com/stellar/gateway/listener/payment_listener_test.go

@@ -30,8 +30,8 @@ func TestPaymentListener(t *testing.T) {
 			IssuingAccountID:   "GATKP6ZQM5CSLECPMTAC5226PE367QALCPM6AFHTSULPPZMT62OOPMQB",
 			ReceivingAccountID: "GATKP6ZQM5CSLECPMTAC5226PE367QALCPM6AFHTSULPPZMT62OOPMQB",
 		},
-		Hooks: config.Hooks{
-			Receive: "http://receive_hook",
+		Callbacks: config.Callbacks{
+			Receive: "http://receive_callback",
 		},
 	}
 
@@ -148,7 +148,7 @@ func TestPaymentListener(t *testing.T) {
 			})
 		})
 
-		Convey("When receive hook returns error", func() {
+		Convey("When receive callback returns error", func() {
 			operation.Type = "payment"
 			operation.To = "GATKP6ZQM5CSLECPMTAC5226PE367QALCPM6AFHTSULPPZMT62OOPMQB"
 			operation.AssetCode = "USD"
@@ -161,7 +161,7 @@ func TestPaymentListener(t *testing.T) {
 
 			mockHTTPClient.On(
 				"PostForm",
-				"http://receive_hook",
+				"http://receive_callback",
 				url.Values{
 					"id":         {"1"},
 					"from":       {"GBIHSMPXC2KJ3NJVHEYTG3KCHYEUQRT45X6AWYWXMAXZOAX4F5LFZYYQ"},
@@ -184,7 +184,7 @@ func TestPaymentListener(t *testing.T) {
 			})
 		})
 
-		Convey("When receive hook returns success", func() {
+		Convey("When receive callback returns success", func() {
 			operation.Type = "payment"
 			operation.To = "GATKP6ZQM5CSLECPMTAC5226PE367QALCPM6AFHTSULPPZMT62OOPMQB"
 			operation.AssetCode = "USD"
@@ -200,7 +200,7 @@ func TestPaymentListener(t *testing.T) {
 
 			mockHTTPClient.On(
 				"PostForm",
-				"http://receive_hook",
+				"http://receive_callback",
 				url.Values{
 					"id":         {"1"},
 					"from":       {"GBIHSMPXC2KJ3NJVHEYTG3KCHYEUQRT45X6AWYWXMAXZOAX4F5LFZYYQ"},
@@ -223,7 +223,7 @@ func TestPaymentListener(t *testing.T) {
 			})
 		})
 
-		Convey("When receive hook returns success (no memo)", func() {
+		Convey("When receive callback returns success (no memo)", func() {
 			operation.Type = "payment"
 			operation.To = "GATKP6ZQM5CSLECPMTAC5226PE367QALCPM6AFHTSULPPZMT62OOPMQB"
 			operation.AssetCode = "USD"
@@ -237,7 +237,7 @@ func TestPaymentListener(t *testing.T) {
 
 			mockHTTPClient.On(
 				"PostForm",
-				"http://receive_hook",
+				"http://receive_callback",
 				url.Values{
 					"id":         {"1"},
 					"from":       {"GBIHSMPXC2KJ3NJVHEYTG3KCHYEUQRT45X6AWYWXMAXZOAX4F5LFZYYQ"},
@@ -260,7 +260,7 @@ func TestPaymentListener(t *testing.T) {
 			})
 		})
 
-		Convey("When receive hook returns success and compliance server is connected", func() {
+		Convey("When receive callback returns success and compliance server is connected", func() {
 			paymentListener.config.Compliance = "http://compliance"
 
 			operation.Type = "payment"
@@ -287,7 +287,7 @@ func TestPaymentListener(t *testing.T) {
 
 			mockHTTPClient.On(
 				"PostForm",
-				"http://receive_hook",
+				"http://receive_callback",
 				url.Values{
 					"id":         {"1"},
 					"from":       {"GBIHSMPXC2KJ3NJVHEYTG3KCHYEUQRT45X6AWYWXMAXZOAX4F5LFZYYQ"},

src/github.com/stellar/gateway/protocols/compliance/doc.go

@@ -64,7 +64,7 @@ When you want to use compliance protocol when receiving payments...
        |          □<-----------------------------------□                                    |
        |          □                                    |                                    |
        |          □~~~ - Bridge server will send       |                                    |
-       |          □      a receive hook with           |                                    |
+       |          □      a receive callback with       |                                    |
        |          □      `extra_memo` preimage         |                                    |
        |          □                                    |                                    |
        |          |                                    |                                    |