-
Notifications
You must be signed in to change notification settings - Fork 31
/
sign_settlement.go
516 lines (452 loc) · 14.3 KB
/
sign_settlement.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
package vault
import (
"context"
"encoding/json"
"errors"
"io/ioutil"
"os"
"path/filepath"
"strings"
"time"
rootcmd "github.com/brave-intl/bat-go/cmd"
cmdutils "github.com/brave-intl/bat-go/cmd"
"github.com/brave-intl/bat-go/libs/altcurrency"
"github.com/brave-intl/bat-go/libs/clients/bitflyer"
"github.com/brave-intl/bat-go/libs/clients/gemini"
appctx "github.com/brave-intl/bat-go/libs/context"
"github.com/brave-intl/bat-go/libs/custodian"
"github.com/brave-intl/bat-go/libs/wallet"
"github.com/brave-intl/bat-go/libs/wallet/provider/uphold"
settlement "github.com/brave-intl/bat-go/tools/settlement"
bitflyersettlement "github.com/brave-intl/bat-go/tools/settlement/bitflyer"
settlementcmd "github.com/brave-intl/bat-go/tools/settlement/cmd"
geminisettlement "github.com/brave-intl/bat-go/tools/settlement/gemini"
upholdsettlement "github.com/brave-intl/bat-go/tools/settlement/uphold"
vaultsigner "github.com/brave-intl/bat-go/tools/vault/signer"
"github.com/shopspring/decimal"
"github.com/spf13/cobra"
"github.com/spf13/viper"
)
var (
// SignSettlementCmd signs a settlement file's transactions
SignSettlementCmd = &cobra.Command{
Use: "sign-settlement INPUT_FILE...",
Short: "sign settlement files using vault held secrets",
Run: rootcmd.Perform("sign settlement", SignSettlement),
}
// the combination of provider + transaction type gives you the key
// under which the vault secrets are located by default
providerTransactionTypes = map[string][]string{
"uphold": {"contribution", "referral", "adsDirectDeposit"},
"paypal": {"default"},
"gemini": {"contribution", "referral", "adsDirectDeposit"},
"bitflyer": {"default"},
}
artifactGenerators = map[string]func(
context.Context,
string,
*vaultsigner.WrappedClient,
string,
[]custodian.Transaction,
) error{
"uphold": createUpholdArtifact,
"gemini": createGeminiArtifact,
"paypal": createPaypalArtifact,
"bitflyer": createBitflyerArtifact,
}
)
func init() {
VaultCmd.AddCommand(
SignSettlementCmd,
)
signSettlementBuilder := cmdutils.NewFlagBuilder(SignSettlementCmd)
// in -> the file to parse and sign according to each provider's setup. default: contributions.json
signSettlementBuilder.Flag().String("in", "contributions.json",
"( legacy compatibility ) input file path").
Bind("in")
signSettlementBuilder.Flag().BoolP("merge-custodial", "m", false, "If present, combine multiple addresses which share a walletProviderID into a single transaction.")
providers := []string{}
for k := range providerTransactionTypes {
providers = append(providers, k)
}
// providers -> the providers to parse out of the file and parse. default: uphold paypal gemini
signSettlementBuilder.Flag().StringSlice("providers", providers,
"providers to parse out of the given input files").
Bind("providers")
// jpyRate -> the providers to parse out of the file and parse. default: uphold paypal gemini
signSettlementBuilder.Flag().Float64("jpyrate", 0.0,
"jpyrate to use for paypal payouts").
Bind("jpyrate")
signSettlementBuilder.Flag().String("config", "config.yaml",
"the default path to a configuration file").
Bind("config").
Env("CONFIG")
signSettlementBuilder.Flag().String("out", "",
"the output directory for prepared files ( defaults to current working directory )").
Bind("out")
signSettlementBuilder.Flag().Bool("merge", false,
"when multiple input files are passed, merge all transactions and output one file per provider / transaction type ").
Bind("merge")
signSettlementBuilder.Flag().String("bitflyer-client-token", "",
"the token to be sent for auth on bitflyer").
Bind("bitflyer-client-token").
Env("BITFLYER_TOKEN")
signSettlementBuilder.Flag().String("bitflyer-client-id", "",
"tells bitflyer what the client id is during token generation").
Bind("bitflyer-client-id").
Env("BITFLYER_CLIENT_ID")
signSettlementBuilder.Flag().String("bitflyer-client-secret", "",
"tells bitflyer what the client secret during token generation").
Bind("bitflyer-client-secret").
Env("BITFLYER_CLIENT_SECRET")
signSettlementBuilder.Flag().Bool("exclude-limited", false,
"in order to avoid not knowing what the payout amount will be because of transfer limits").
Bind("exclude-limited")
signSettlementBuilder.Flag().Int("chunk-size", 0,
"how many transfers to combine per request, 0 indicates the default value").
Bind("chunk-size")
}
// SignSettlement runs the signing of a settlement
func SignSettlement(command *cobra.Command, args []string) error {
inputFiles := args
ReadConfig(command)
providers, err := command.Flags().GetStringSlice("providers")
if err != nil {
return err
}
inputFile, err := command.Flags().GetString("in")
if err != nil {
return err
}
if len(inputFiles) == 0 {
inputFiles = []string{inputFile}
}
outDir, err := command.Flags().GetString("out")
if err != nil {
return err
}
merge, err := command.Flags().GetBool("merge")
if err != nil {
return err
}
mergeCustodial, err := command.Flags().GetBool("merge-custodial")
if err != nil {
return err
}
logger, err := appctx.GetLogger(command.Context())
if err != nil {
return err
}
if len(outDir) > 0 {
logger.Info().Str("outDir", outDir).Msg("creating output directory")
err := os.MkdirAll(outDir, os.ModePerm)
if err != nil {
return err
}
}
var mergedSettlements []settlement.AntifraudTransaction
for _, inputFile := range inputFiles {
sublog := logger.With().Str("inputFile", inputFile).Logger()
sublog.Info().Msg("reading settlement file")
// append -signed to the filename
outBaseFile := strings.TrimSuffix(filepath.Base(inputFile), filepath.Ext(inputFile)) + "-signed.json"
// all settlements file
settlementJSON, err := ioutil.ReadFile(inputFile)
if err != nil {
return err
}
var antifraudSettlements []settlement.AntifraudTransaction
err = json.Unmarshal(settlementJSON, &antifraudSettlements)
if err != nil {
return err
}
sublog.Info().Int("len(antifraudSettlements)", len(antifraudSettlements)).Msg("deserialized settlement file")
mergedSettlements = append(mergedSettlements, antifraudSettlements...)
if merge {
sublog.Info().Int("len(mergedSettlements)", len(mergedSettlements)).Msg("merged settlements")
} else {
return processSettlements(
sublog.WithContext(
context.WithValue(
command.Context(),
appctx.MergeCustodialCTXKey,
mergeCustodial,
),
),
providers,
outDir,
outBaseFile,
antifraudSettlements,
)
}
}
err = settlement.CheckForDuplicates(mergedSettlements)
if err != nil {
return err
}
if merge {
logger.Info().Int("len(mergedSettlements)", len(mergedSettlements)).Msg("processing merged settlements")
return processSettlements(command.Context(), providers, outDir, "merged-signed.json", mergedSettlements)
}
return nil
}
func processSettlements(ctx context.Context, providers []string, outDir string, outBaseFile string, antifraudSettlements []settlement.AntifraudTransaction) error {
logger, err := appctx.GetLogger(ctx)
if err != nil {
return err
}
settlementsByProviderAndWalletKey, err := divideSettlementsByWallet(ctx, antifraudSettlements)
if err != nil {
return err
}
logLine := logger.Info()
for _, provider := range providers {
for _, txType := range providerTransactionTypes[provider] {
walletKey := provider + "-" + txType
logLine = logLine.Int(walletKey, len(settlementsByProviderAndWalletKey[walletKey]))
}
}
logLine.Msg("split settlements by provider and transaction type")
wrappedClient, err := vaultsigner.Connect()
if err != nil {
return err
}
for _, provider := range providers {
for _, txType := range providerTransactionTypes[provider] {
walletKey := provider + "-" + txType
settlements := settlementsByProviderAndWalletKey[walletKey]
if len(settlements) == 0 {
continue
}
output := filepath.Join(outDir, walletKey+"-"+outBaseFile)
secretKey := Config.GetWalletKey(walletKey)
sublog := logger.With().
Str("provider", provider).
Str("txType", txType).
Str("output", output).
Int("settlements", len(settlements)).
Logger()
sublog.Info().Str("wallet", secretKey).Msg("attempting to sign settlements")
err := artifactGenerators[provider](
sublog.WithContext(ctx),
output,
wrappedClient,
secretKey,
settlements,
)
if err != nil {
return err
}
sublog.Info().Msg("created artifact")
}
}
return nil
}
func divideSettlementsByWallet(ctx context.Context, antifraudTxs []settlement.AntifraudTransaction) (map[string][]custodian.Transaction, error) {
settlementTransactionsByWallet := make(map[string][]custodian.Transaction)
logger, err := appctx.GetLogger(ctx)
if err != nil {
return settlementTransactionsByWallet, err
}
for _, antifraudTx := range antifraudTxs {
tx, err := antifraudTx.ToTransaction()
if err != nil {
logger.Warn().Err(err).Str("channel", tx.Channel).Msg("skipping transaction as it failed to validate")
continue
}
provider := tx.WalletProvider
wallet := tx.Type
if len(providerTransactionTypes[provider]) == 1 {
// might as well go into one (default)
wallet = providerTransactionTypes[provider][0]
}
// which secret values to use to sign (paypal-default, uphold-referral, gemini-contribution)
walletKey := provider + "-" + wallet
// append to the nested structure
settlementTransactionsByWallet[walletKey] = append(
settlementTransactionsByWallet[walletKey],
tx,
)
}
return settlementTransactionsByWallet, nil
}
func createUpholdArtifact(
ctx context.Context,
outputFile string,
wrappedClient *vaultsigner.WrappedClient,
walletKey string,
upholdOnlySettlements []custodian.Transaction,
) error {
var transactionSet []custodian.Transaction = upholdOnlySettlements
response, err := wrappedClient.Client.Logical().Read("wallets/" + walletKey)
if err != nil {
return err
}
providerID, ok := response.Data["providerId"]
if !ok {
return errors.New("invalid wallet name")
}
// Ensure that there is only one payment for a given Uphold wallet by combining
// multiples if they exist.
mergeCustodialRaw := ctx.Value(appctx.MergeCustodialCTXKey)
mergeCustodial, ok := mergeCustodialRaw.(bool)
if ok && mergeCustodial == true {
transactionSet = upholdsettlement.FlattenPaymentsByWalletProviderID(
&upholdOnlySettlements,
)
}
signer, err := wrappedClient.GenerateEd25519Signer(walletKey)
if err != nil {
return err
}
var info wallet.Info
info.PublicKey = signer.String()
info.Provider = "uphold"
info.ProviderID = providerID.(string)
{
tmp := altcurrency.BAT
info.AltCurrency = &tmp
}
settlementWallet := &uphold.Wallet{Info: info, PrivKey: signer, PubKey: signer}
err = settlement.PrepareTransactions(settlementWallet, transactionSet, "payout", &uphold.Beneficiary{Relationship: "business"})
if err != nil {
return err
}
state := settlement.State{WalletInfo: settlementWallet.Info, Transactions: transactionSet}
out, err := json.MarshalIndent(state, "", " ")
if err != nil {
return err
}
err = ioutil.WriteFile(outputFile, out, 0400)
if err != nil {
return err
}
return nil
}
// NewRefreshTokenPayloadFromViper creates the payload to refresh a bitflyer token from viper
func NewRefreshTokenPayloadFromViper() *bitflyer.TokenPayload {
vpr := viper.GetViper()
clientID := vpr.GetString("bitflyer-client-id")
clientSecret := vpr.GetString("bitflyer-client-secret")
extraClientSecret := vpr.GetString("bitflyer-extra-client-secret")
return &bitflyer.TokenPayload{
GrantType: "client_credentials",
ClientID: clientID,
ClientSecret: clientSecret,
ExtraClientSecret: extraClientSecret,
}
}
func createBitflyerArtifact(
ctx context.Context,
outputFile string,
wrappedClient *vaultsigner.WrappedClient,
walletKey string,
bitflyerOnlySettlements []custodian.Transaction,
) error {
bitflyerClient, err := bitflyer.New()
if err != nil {
return err
}
refreshTokenPayload := NewRefreshTokenPayloadFromViper()
_, err = bitflyerClient.RefreshToken(ctx, *refreshTokenPayload)
if err != nil {
return err
}
vpr := viper.GetViper()
exclude := vpr.GetBool("exclude-limited")
sourceFrom := vpr.GetString("bitflyer-source-from")
preparedTransactions, err := bitflyersettlement.PrepareRequests(
ctx,
bitflyerClient,
bitflyerOnlySettlements,
exclude,
sourceFrom,
)
if err != nil {
return err
}
out, err := json.MarshalIndent(preparedTransactions, "", " ")
if err != nil {
return err
}
err = ioutil.WriteFile(outputFile, out, 0400)
if err != nil {
return err
}
return nil
}
func createGeminiArtifact(
ctx context.Context,
outputFile string,
wrappedClient *vaultsigner.WrappedClient,
walletKey string,
geminiOnlySettlements []custodian.Transaction,
) error {
response, err := wrappedClient.Client.Logical().Read("wallets/" + walletKey)
if err != nil {
return err
}
oauthClientID := response.Data["clientid"].(string)
// group transactions (500 at a time)
privatePayloads, err := geminisettlement.TransformTransactions(ctx, oauthClientID, geminiOnlySettlements)
if err != nil {
return err
}
// leave enough space to increment nonce
<-time.After(time.Microsecond)
privateRequests, err := signGeminiRequests(
wrappedClient,
walletKey,
privatePayloads,
)
if err != nil {
return err
}
// serialize requests to be sent in next step
out, err := json.MarshalIndent(privateRequests, "", " ")
if err != nil {
return err
}
err = ioutil.WriteFile(outputFile, out, 0400)
if err != nil {
return err
}
return nil
}
func signGeminiRequests(
wrappedClient *vaultsigner.WrappedClient,
walletKey string,
privateRequests *[][]gemini.PayoutPayload,
) (*[]gemini.PrivateRequestSequence, error) {
response, err := wrappedClient.Client.Logical().Read("wallets/" + walletKey)
if err != nil {
return nil, err
}
clientID := response.Data["clientid"].(string)
clientKey := response.Data["clientkey"].(string)
hmacSecret, err := wrappedClient.GetHmacSecret(walletKey)
if err != nil {
return nil, err
}
return geminisettlement.SignRequests(
clientID,
clientKey,
hmacSecret,
privateRequests,
)
}
func createPaypalArtifact(
ctx context.Context,
outputFile string,
client *vaultsigner.WrappedClient,
walletKey string,
paypalOnlySettlements []custodian.Transaction,
) error {
return settlementcmd.PaypalTransformForMassPay(
ctx,
&paypalOnlySettlements,
"JPY",
decimal.NewFromFloat(viper.GetFloat64("jpyrate")),
outputFile,
)
}