package
0.0.0-20250110235132-9a64979de632
Repository: https://github.com/renegade-fi/golang-sdk.git
Documentation: pkg.go.dev
# Functions
BuildBackOfQueueWalletPath builds the path for the BackOfQueueWallet action.
BuildCancelOrderPath builds the path for the CancelOrder action.
BuildCreateOrderPath builds the path for the CreateOrder action.
BuildDepositPath builds the path for the Deposit action.
BuildGetWalletPath builds the path for the GetWallet action.
BuildPayFeesPath builds the path for the PayFees action.
BuildRefreshWalletPath builds the path for the RefreshWallet action.
BuildTaskHistoryPath builds the path for the TaskHistory action.
BuildTaskStatusPath builds the path for the TaskStatus action.
BuildWithdrawPath builds the path for the Withdraw action.
NewAmount creates a new Amount from an int64.
NewExternalOrderBuilder creates a new builder.
ScalarFromUintLimbs converts an array of uint32 limbs to a scalar.
ScalarToUintLimbs converts a scalar to an array of uint32 limbs.
# Constants
AssembleExternalQuotePath is the path to assemble a quote into a settlement transaction.
BackOfQueueWalletPath is the path to fetch the wallet after all tasks in its queue have been processed.
CancelOrderPath is the path for the CancelOrder action.
CreateOrderPath is the path for the CreateOrder action.
CreateWalletPath is the path for the CreateWallet action.
DepositPath is the path for the Deposit action.
--- External Match Endpoints --- // GetExternalMatchBundlePath is the path to fetch an external match bundle.
GetExternalMatchQuotePath is the path to fetch an external match quote.
--- Orderbook Endpoints --- // GetSupportedTokensPath is the path for the GetSupportedTokens action.
--- Wallet Endpoints --- // GetWalletPath is the path for the GetWallet action.
nolint:gosec.
PayFeesPath is the path to enqueue tasks to pay wallet fees.
RefreshWalletPath is the path for the RefreshWallet action.
TaskHistoryPath is the path to fetch the task history for a wallet.
TaskStatusPath is the path to fetch the status of a task.
WithdrawPath is the path for the Withdraw action.
# Structs
ApiBalance is a balance in a Renegade wallet.
ApiExternalAssetTransfer represents a single transfer between the external client and darkpool.
ApiExternalMatchBundle contains a match and a transaction that the client can submit on-chain.
ApiExternalMatchResult is the result of a request to generate an external match.
ApiExternalOrder is an order from outside of the darkpool, generated by a client requesting an external match.
ApiExternalOrderBuilder helps construct ApiExternalOrder with validation.
ApiExternalQuote is a quote from the relayer for an external order.
ApiFee is a fee in the Renegade system, due on a match, balance, etc Contains both a relayer fee and a protocol fee.
ApiHistoricalTask represents a historical task.
ApiKeychain represents a keychain API type that maintains all keys as hex strings.
ApiOrder is an order in a Renegade wallet.
ApiPrivateKeychain represents a private keychain for the API wallet.
ApiPublicKeychain is a public keychain in the Renegade system.
ApiSettlementTransaction is an EVM transaction parameterization for settling an external match.
ApiSignedQuote is a quote from the relayer, signed with the relayer's admin API key This allows a client to submit an authorized quote to the relayer and receive back an assembled settlement transaction at the quoted price.
ApiTaskStatus is the status of a running task ApiTaskStatus represents the status of a task.
ApiToken is a token available on the exchange.
ApiWallet is a wallet in the Renegade system.
AssembleExternalQuoteRequest is a request to assemble an external match quote into a settlement transaction.
CancelOrderRequest is the request body for the CancelOrder action.
CancelOrderResponse is the response body for the CancelOrder action.
CreateOrderRequest is the request body for the CreateOrder action.
CreateOrderResponse is the response body for the CreateOrder action.
CreateWalletRequest is the request body for the CreateWallet action.
CreateWalletResponse is the response body for the CreateWallet action.
DepositRequest is the request body for the Deposit action.
DepositResponse is the response body for the Deposit action.
ExternalMatchRequest is a request to generate an external match.
ExternalMatchResponse is the response body for the ExternalMatch action.
ExternalQuoteRequest is a request to fetch an external match quote.
ExternalQuoteResponse is the response body for the ExternalQuote action.
GetSupportedTokensResponse is the response body for the GetSupportedTokens request.
GetWalletResponse is the response body for a GetWallet request.
LookupWalletRequest is the request body for the LookupWallet action.
LookupWalletResponse is the response body for a LookupWallet request.
PayFeesResponse is the response body for the PayFees action.
RefreshWalletResponse is the response body for a RefreshWallet request.
TaskHistoryResponse is the response body for the TaskHistory endpoint.
TaskResponse is the response body for the Task endpoint.
TimestampedPrice is a price at a given timestamp The price is represented as a string to avoid precision loss.
WalletUpdateAuthorization encapsulates the client generated authorization for wallet updates.
WithdrawRequest is the request body for the Withdraw action.
WithdrawResponse is the response body for the Withdraw action.
# Type aliases
Amount is a big.Int marshalled and unmarshalled as a rust-compatible string.
ScalarLimbs is an array of uint32 limbs.