Documentation
¶
Index ¶
- type CheckExistenceReceivedExpiredByHash
- type CheckExistenceReceivedExpiredByHashView
- type CheckExistenceReceivedExpiredByHashViewFactory
- type Claim
- type ClaimView
- type ClaimViewFactory
- type FastExchange
- type FastExchangeInitiatorView
- type FastExchangeInitiatorViewFactory
- type FastExchangeResponderView
- type Lock
- type LockAcceptView
- type LockInfo
- type LockView
- type LockViewFactory
- type ReclaimAll
- type ReclaimAllView
- type ReclaimAllViewFactory
- type ReclaimByHash
- type ReclaimByHashView
- type ReclaimByHashViewFactory
- type Scan
- type ScanView
- type ScanViewFactory
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CheckExistenceReceivedExpiredByHash ¶ added in v0.3.0
type CheckExistenceReceivedExpiredByHash struct {
// TMSID identifies the TMS to use to perform the token operation
TMSID token.TMSID
// Wallet is the identifier of the wallet that owns the tokens to reclaim
Wallet string
// Hash is the hash the lookup should refer to
Hash []byte
// Exists if true, enforce that a token exists, false otherwiese
Exists bool
}
CheckExistenceReceivedExpiredByHash contains the input information to reclaim tokens
type CheckExistenceReceivedExpiredByHashView ¶ added in v0.3.0
type CheckExistenceReceivedExpiredByHashView struct {
*CheckExistenceReceivedExpiredByHash
}
CheckExistenceReceivedExpiredByHashView is the view of a party who wants to reclaim all previously locked tokens with an expired timeout
type CheckExistenceReceivedExpiredByHashViewFactory ¶ added in v0.3.0
type CheckExistenceReceivedExpiredByHashViewFactory struct{}
type Claim ¶
type Claim struct {
// TMSID identifies the TMS to use to perform the token operation
TMSID token.TMSID
// Wallet is the identifier of the wallet to use
Wallet string
// PreImage of the hash encoded in the htlc script in the token to be claimed
PreImage []byte
}
Claim contains the input information to claim a token
type ClaimViewFactory ¶
type ClaimViewFactory struct{}
type FastExchange ¶
type FastExchange struct {
// Recipient is the identity of the recipient's FSC node
Recipient view.Identity
// TMSID identifies the TMS to use to perform the token operation
TMSID1 token.TMSID
// Type of tokens to transfer
Type1 token2.Type
// Amount to transfer
Amount1 uint64
TMSID2 token.TMSID
Type2 token2.Type
Amount2 uint64
// ReclamationDeadline is the time after which we can reclaim the funds in case they were not transferred
ReclamationDeadline time.Duration
}
FastExchange contains the input information to fast exchange tokens
type FastExchangeInitiatorView ¶
type FastExchangeInitiatorView struct {
*FastExchange
}
FastExchangeInitiatorView is the view of a party who wants to perform an exchange with a single view
type FastExchangeInitiatorViewFactory ¶
type FastExchangeInitiatorViewFactory struct{}
type FastExchangeResponderView ¶
type FastExchangeResponderView struct{}
type Lock ¶
type Lock struct {
// TMSID identifies the TMS to use to perform the token operation
TMSID token.TMSID
// ReclamationDeadline is the time after which we can reclaim the funds in case they were not transferred
ReclamationDeadline time.Duration
// Wallet is the identifier of the wallet that owns the tokens to transfer
Wallet string
// Type of tokens to transfer
Type token2.Type
// Amount to transfer
Amount uint64
// Recipient is the identity of the recipient's FSC node
Recipient view.Identity
// Hash is the hash to use in the script, if nil, a fresh one is generated
Hash []byte
// HashFunc is the hash function to use in the script
HashFunc crypto.Hash
}
Lock contains the input information to lock a token
type LockAcceptView ¶
type LockAcceptView struct {
}
type LockViewFactory ¶
type LockViewFactory struct{}
type ReclaimAll ¶
type ReclaimAll struct {
// TMSID identifies the TMS to use to perform the token operation
TMSID token.TMSID
// Wallet is the identifier of the wallet that owns the tokens to reclaim
Wallet string
}
ReclaimAll contains the input information to reclaim tokens
type ReclaimAllView ¶
type ReclaimAllView struct {
*ReclaimAll
}
ReclaimAllView is the view of a party who wants to reclaim all previously locked tokens with an expired timeout
type ReclaimAllViewFactory ¶
type ReclaimAllViewFactory struct{}
type ReclaimByHash ¶ added in v0.3.0
type ReclaimByHash struct {
// TMSID identifies the TMS to use to perform the token operation
TMSID token.TMSID
// Wallet is the identifier of the wallet that owns the tokens to reclaim
Wallet string
// Hash is the hash the reclaim should refer to
Hash []byte
}
ReclaimByHash contains the input information to reclaim tokens
type ReclaimByHashView ¶ added in v0.3.0
type ReclaimByHashView struct {
*ReclaimByHash
}
ReclaimByHashView is the view of a party who wants to reclaim all previously locked tokens with an expired timeout
type ReclaimByHashViewFactory ¶ added in v0.3.0
type ReclaimByHashViewFactory struct{}
type Scan ¶
type Scan struct {
// TMSID identifies the TMS to use to perform the token operation
TMSID token.TMSID
// Timeout of the scan
Timeout time.Duration
// Hash is the hash to use in the scan
Hash []byte
// HashFunc is the hash function to use in the scan
HashFunc crypto.Hash
// StartingTransactionID is the transaction id from which to start the scan.
// If empty, the scan starts from the genesis block
StartingTransactionID string
// StopOnLastTx stops the scan if the last transaction is reached.
StopOnLastTx bool
}
Scan contains the input information for a scan of a matching preimage
type ScanViewFactory ¶
type ScanViewFactory struct {
}