package
0.0.0-20241107232724-79d6e46a31ca
Repository: https://github.com/stellar/stellar-disbursement-platform-backend.git
Documentation: pkg.go.dev

# Functions

NewClient creates a new instance of Circle Client.
No description provided by the author
NewMockClient creates a new instance of MockClient.
NewMockClientConfigModel creates a new instance of MockClientConfigModel.
NewMockService creates a new instance of MockService.
No description provided by the author
ParseStellarAsset returns the Stellar asset for the given Circle currency code, or an error if the currency is not supported in the SDP.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
means success.
No description provided by the author
No description provided by the author

# Variables

AllowedAssetsMap is a map of Circle currency codes to Stellar assets, for each network type.
No description provided by the author
No description provided by the author

# Structs

AccountConfiguration represents the configuration settings of an account.
APIError represents the error response from Circle APIs.
APIErrorDetail represents the detailed error information.
Balance represents the amount and currency of a balance or transfer.
Balances represents the available and unsettled balances for different currencies.
Client provides methods to interact with the Circle API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ConfigurationResponse represents the response containing account configuration.
ListBusinessBalancesResponse represents the response containing business balances.
MockClient is an autogenerated mock type for the ClientInterface type.
MockClientConfigModel is an autogenerated mock type for the ClientConfigModelInterface type.
MockService is an autogenerated mock type for the ServiceInterface type.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Transfer represents a transfer of funds from a Circle Endpoint to another.
TransferAccount represents the source or destination of the transfer.
TransferRequest represents the request to create a new transfer.
TransferResponse represents the response from the Circle APIs.
WalletConfig represents the wallet configuration with details such as the master wallet ID.

# Interfaces

go:generate mockery --name=ClientConfigModelInterface --case=underscore --structname=MockClientConfigModel --filename=client_config_mock.go --inpackage.
ClientInterface defines the interface for interacting with the Circle API.
ServiceInterface defines the interface for Circle related SDP operations.

# Type aliases

ClientFactory is a function that creates a ClientInterface.
Environment holds the possible environments for the Circle API.
TransferAccountType represents the type of the source or destination of the transfer.
No description provided by the author
No description provided by the author