Skip to content
This repository has been archived by the owner on Oct 21, 2024. It is now read-only.

Commit

Permalink
refactor(BUX-222): name changes
Browse files Browse the repository at this point in the history
  • Loading branch information
kuba-4chain committed Sep 26, 2023
1 parent 4b9c6ce commit 7dd7d90
Show file tree
Hide file tree
Showing 6 changed files with 85 additions and 85 deletions.
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -348,28 +348,28 @@ If you pass the context without a timeout, the client will instantly return a su
### Mock Responses Constants
In order to test the Mock Client, you may often need to check if the response from the client is correct. Therefore, some useful constants are exposed from `mock_consts` package.
In order to test the Mock Client, you may often need to check if the response from the client is correct. Therefore, some useful constants are exposed from `fixtures` package.
```go
const (
MockedProviderMain = "https://mocked_arc_api_url.com/arc"
MockedProviderSecondary = "https://secondary_mocked_arc_api_url.com/arc"
MockedMaxScriptSizePolicy = 100000000
MockedMaxTxSigOpsCountPolicy = 4294967295
MockedMaxTxSizePolicy = 100000000
MockedMaxTxSizePolicySecondary = 220000000
MockedMiningFeeBytes = 1000
MockedSatoshisPerBytes = 1
MockedSatoshisPerBytesSecondary = 2
MockedTimestamp = "2023-09-05T17:03:49.537230128Z"
MockedTimestampSecondary = "2023-09-05T17:05:29.736256927Z"
MockedTxResponseStatus = 200
MockedTxResponseTitle = "OK"
MockedTxStatus = "SEEN_ON_NETWORK"
MockedTxBlockHash = "123123"
MockedTxBlockHashSecondary = "123123"
MockedTxBlockHeight = 123456
MockedTxBlockHeightSecondary = 123456
MockedTxExtraInfo = ""
ProviderMain = "https://mocked_arc_api_url.com/arc"
ProviderSecondary = "https://secondary_mocked_arc_api_url.com/arc"
MaxScriptSizePolicy = 100000000
MaxTxSigOpsCountPolicy = 4294967295
MaxTxSizePolicy = 100000000
MaxTxSizePolicySecondary = 220000000
MiningFeeBytes = 1000
SatoshisPerBytes = 1
SatoshisPerBytesSecondary = 2
Timestamp = "2023-09-05T17:03:49.537230128Z"
TimestampSecondary = "2023-09-05T17:05:29.736256927Z"
TxResponseStatus = 200
TxResponseTitle = "OK"
TxStatus = "SEEN_ON_NETWORK"
TxBlockHash = "123123"
TxBlockHashSecondary = "123123"
TxBlockHeight = 123456
TxBlockHeightSecondary = 123456
TxExtraInfo = ""
)
```
23 changes: 23 additions & 0 deletions broadcast/broadcast-client-mock/fixtures/fixtures.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
package fixtures

const (
ProviderMain = "https://mocked_arc_api_url.com/arc"
ProviderSecondary = "https://secondary_mocked_arc_api_url.com/arc"
MaxScriptSizePolicy = 100000000
MaxTxSigOpsCountPolicy = 4294967295
MaxTxSizePolicy = 100000000
MaxTxSizePolicySecondary = 220000000
MiningFeeBytes = 1000
SatoshisPerBytes = 1
SatoshisPerBytesSecondary = 2
Timestamp = "2023-09-05T17:03:49.537230128Z"
TimestampSecondary = "2023-09-05T17:05:29.736256927Z"
TxResponseStatus = 200
TxResponseTitle = "OK"
TxStatus = "SEEN_ON_NETWORK"
TxBlockHash = "0000000000000000019a575e0ea4d9bbe251dd24c473a0d8407935973151f282"
TxBlockHashSecondary = "0000000000000000045c969f3acd5db37896aba95f91389f2d191496bf15584b"
TxBlockHeight = 800182
TxBlockHeightSecondary = 799439
TxExtraInfo = ""
)
23 changes: 0 additions & 23 deletions broadcast/broadcast-client-mock/mock-consts/mock_consts.go

This file was deleted.

10 changes: 5 additions & 5 deletions broadcast/internal/arc/mocks/arc_client_mock_success.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@ import (
"context"

broadcast_api "github.com/bitcoin-sv/go-broadcast-client/broadcast"
mock_consts "github.com/bitcoin-sv/go-broadcast-client/broadcast/broadcast-client-mock/mock-consts"
"github.com/bitcoin-sv/go-broadcast-client/broadcast/broadcast-client-mock/fixtures"
)

type ArcClientMock struct{}

// GetFeeQuote returns a successful FeeQuote response.
func (*ArcClientMock) GetFeeQuote(ctx context.Context) ([]*broadcast_api.FeeQuote, error) {
quote1 := &broadcast_api.FeeQuote{
BaseResponse: broadcast_api.BaseResponse{Miner: mock_consts.MockedProviderMain},
BaseResponse: broadcast_api.BaseResponse{Miner: fixtures.ProviderMain},
MiningFee: policy1.Policy.MiningFee,
Timestamp: policy1.Timestamp,
}

quote2 := &broadcast_api.FeeQuote{
BaseResponse: broadcast_api.BaseResponse{Miner: mock_consts.MockedProviderSecondary},
BaseResponse: broadcast_api.BaseResponse{Miner: fixtures.ProviderSecondary},
MiningFee: policy2.Policy.MiningFee,
Timestamp: policy2.Timestamp,
}
Expand Down Expand Up @@ -47,15 +47,15 @@ func (*ArcClientMock) QueryTransaction(ctx context.Context, txID string) (*broad
// SubmitTransaction returns a successful SubmitTxResponse.
func (*ArcClientMock) SubmitTransaction(ctx context.Context, tx *broadcast_api.Transaction, opts ...broadcast_api.TransactionOptFunc) (*broadcast_api.SubmitTxResponse, error) {
return &broadcast_api.SubmitTxResponse{
BaseResponse: broadcast_api.BaseResponse{Miner: mock_consts.MockedProviderMain},
BaseResponse: broadcast_api.BaseResponse{Miner: fixtures.ProviderMain},
SubmittedTx: submittedTx,
}, nil
}

// SubmitBatchTransactions returns a successful SubmitBatchTxResponse.
func (*ArcClientMock) SubmitBatchTransactions(ctx context.Context, tx []*broadcast_api.Transaction, opts ...broadcast_api.TransactionOptFunc) (*broadcast_api.SubmitBatchTxResponse, error) {
return &broadcast_api.SubmitBatchTxResponse{
BaseResponse: broadcast_api.BaseResponse{Miner: mock_consts.MockedProviderMain},
BaseResponse: broadcast_api.BaseResponse{Miner: fixtures.ProviderMain},
Transactions: []*broadcast_api.SubmittedTx{
submittedTx,
submittedTxSecondary,
Expand Down
10 changes: 5 additions & 5 deletions broadcast/internal/arc/mocks/arc_client_mock_timeout.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"time"

broadcast_api "github.com/bitcoin-sv/go-broadcast-client/broadcast"
mock_consts "github.com/bitcoin-sv/go-broadcast-client/broadcast/broadcast-client-mock/mock-consts"
"github.com/bitcoin-sv/go-broadcast-client/broadcast/broadcast-client-mock/fixtures"
)

type ArcClientMockTimeout struct{}
Expand All @@ -17,13 +17,13 @@ func (*ArcClientMockTimeout) GetFeeQuote(ctx context.Context) ([]*broadcast_api.
}

quote1 := &broadcast_api.FeeQuote{
BaseResponse: broadcast_api.BaseResponse{Miner: mock_consts.MockedProviderMain},
BaseResponse: broadcast_api.BaseResponse{Miner: fixtures.ProviderMain},
MiningFee: policy1.Policy.MiningFee,
Timestamp: policy1.Timestamp,
}

quote2 := &broadcast_api.FeeQuote{
BaseResponse: broadcast_api.BaseResponse{Miner: mock_consts.MockedProviderSecondary},
BaseResponse: broadcast_api.BaseResponse{Miner: fixtures.ProviderSecondary},
MiningFee: policy2.Policy.MiningFee,
Timestamp: policy2.Timestamp,
}
Expand Down Expand Up @@ -64,7 +64,7 @@ func (*ArcClientMockTimeout) SubmitTransaction(ctx context.Context, tx *broadcas
}

return &broadcast_api.SubmitTxResponse{
BaseResponse: broadcast_api.BaseResponse{Miner: mock_consts.MockedProviderMain},
BaseResponse: broadcast_api.BaseResponse{Miner: fixtures.ProviderMain},
SubmittedTx: submittedTx,
}, nil
}
Expand All @@ -76,7 +76,7 @@ func (*ArcClientMockTimeout) SubmitBatchTransactions(ctx context.Context, tx []*
}

return &broadcast_api.SubmitBatchTxResponse{
BaseResponse: broadcast_api.BaseResponse{Miner: mock_consts.MockedProviderMain},
BaseResponse: broadcast_api.BaseResponse{Miner: fixtures.ProviderMain},
Transactions: []*broadcast_api.SubmittedTx{
submittedTx,
submittedTxSecondary,
Expand Down
64 changes: 32 additions & 32 deletions broadcast/internal/arc/mocks/consts.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,64 +2,64 @@ package mocks

import (
broadcast_api "github.com/bitcoin-sv/go-broadcast-client/broadcast"
mock_consts "github.com/bitcoin-sv/go-broadcast-client/broadcast/broadcast-client-mock/mock-consts"
"github.com/bitcoin-sv/go-broadcast-client/broadcast/broadcast-client-mock/fixtures"
)

var (
policy1 = &broadcast_api.PolicyQuoteResponse{
BaseResponse: broadcast_api.BaseResponse{Miner: mock_consts.MockedProviderMain},
BaseResponse: broadcast_api.BaseResponse{Miner: fixtures.ProviderMain},
Policy: broadcast_api.PolicyResponse{
MaxScriptSizePolicy: mock_consts.MockedMaxScriptSizePolicy,
MaxTxSigOpsCountPolicy: mock_consts.MockedMaxTxSigOpsCountPolicy,
MaxTxSizePolicy: mock_consts.MockedMaxTxSizePolicy,
MaxScriptSizePolicy: fixtures.MaxScriptSizePolicy,
MaxTxSigOpsCountPolicy: fixtures.MaxTxSigOpsCountPolicy,
MaxTxSizePolicy: fixtures.MaxTxSizePolicy,
MiningFee: broadcast_api.MiningFeeResponse{
Bytes: mock_consts.MockedMiningFeeBytes,
Satoshis: mock_consts.MockedSatoshisPerBytes,
Bytes: fixtures.MiningFeeBytes,
Satoshis: fixtures.SatoshisPerBytes,
},
},
Timestamp: mock_consts.MockedTimestamp,
Timestamp: fixtures.Timestamp,
}

policy2 = &broadcast_api.PolicyQuoteResponse{
BaseResponse: broadcast_api.BaseResponse{Miner: mock_consts.MockedProviderSecondary},
BaseResponse: broadcast_api.BaseResponse{Miner: fixtures.ProviderSecondary},
Policy: broadcast_api.PolicyResponse{
MaxScriptSizePolicy: mock_consts.MockedMaxScriptSizePolicy,
MaxTxSigOpsCountPolicy: mock_consts.MockedMaxTxSigOpsCountPolicy,
MaxTxSizePolicy: mock_consts.MockedMaxTxSizePolicySecondary,
MaxScriptSizePolicy: fixtures.MaxScriptSizePolicy,
MaxTxSigOpsCountPolicy: fixtures.MaxTxSigOpsCountPolicy,
MaxTxSizePolicy: fixtures.MaxTxSizePolicySecondary,
MiningFee: broadcast_api.MiningFeeResponse{
Bytes: mock_consts.MockedMiningFeeBytes,
Satoshis: mock_consts.MockedSatoshisPerBytesSecondary,
Bytes: fixtures.MiningFeeBytes,
Satoshis: fixtures.SatoshisPerBytesSecondary,
},
},
Timestamp: mock_consts.MockedTimestampSecondary,
Timestamp: fixtures.TimestampSecondary,
}

submittedTx = &broadcast_api.SubmittedTx{
Status: mock_consts.MockedTxResponseStatus,
Title: mock_consts.MockedTxResponseTitle,
TxStatus: mock_consts.MockedTxStatus,
BlockHash: mock_consts.MockedTxBlockHash,
BlockHeight: mock_consts.MockedTxBlockHeight,
ExtraInfo: mock_consts.MockedTxExtraInfo,
Status: fixtures.TxResponseStatus,
Title: fixtures.TxResponseTitle,
TxStatus: fixtures.TxStatus,
BlockHash: fixtures.TxBlockHash,
BlockHeight: fixtures.TxBlockHeight,
ExtraInfo: fixtures.TxExtraInfo,
}

submittedTxSecondary = &broadcast_api.SubmittedTx{
Status: mock_consts.MockedTxResponseStatus,
Title: mock_consts.MockedTxResponseTitle,
TxStatus: mock_consts.MockedTxStatus,
BlockHash: mock_consts.MockedTxBlockHashSecondary,
BlockHeight: mock_consts.MockedTxBlockHeightSecondary,
ExtraInfo: mock_consts.MockedTxExtraInfo,
Status: fixtures.TxResponseStatus,
Title: fixtures.TxResponseTitle,
TxStatus: fixtures.TxStatus,
BlockHash: fixtures.TxBlockHashSecondary,
BlockHeight: fixtures.TxBlockHeightSecondary,
ExtraInfo: fixtures.TxExtraInfo,
}
)

func queryTx(txID string) *broadcast_api.QueryTxResponse {
return &broadcast_api.QueryTxResponse{
BaseResponse: broadcast_api.BaseResponse{Miner: mock_consts.MockedProviderMain},
Timestamp: mock_consts.MockedTimestamp,
TxStatus: mock_consts.MockedTxStatus,
BlockHash: mock_consts.MockedTxBlockHash,
BlockHeight: mock_consts.MockedTxBlockHeight,
BaseResponse: broadcast_api.BaseResponse{Miner: fixtures.ProviderMain},
Timestamp: fixtures.Timestamp,
TxStatus: fixtures.TxStatus,
BlockHash: fixtures.TxBlockHash,
BlockHeight: fixtures.TxBlockHeight,
TxID: txID,
}
}

0 comments on commit 7dd7d90

Please sign in to comment.