swapchain documentation
Index
Enumerations
Classes
Interfaces
- ACCSConfig
- ACCSFields
- BTCAddress
- BTSAddress
- BitcoinAPI
- BitcoinAPIConstructor
- HTLCConfig
- HTLCConfigBTC
- Order
- Secret
Type aliases
Functions
- Accept
- App
- ComponentPage
- FilterButton
- Form
- Input
- Label
- LandingPage
- Modal
- Navbar
- Orderbook
- OrderbookPage
- Propose
- Protip
- RadioButton
- Row
- Spinner
- SubmitButton
- Table
- TradingPage
- errorHandler
- fakeKey
- getAddress
- getBTCAddress
- getBTSAddress
- getSecret
- getUserInput
- hash
- isValidBitcoinPrivateKey
- isValidBitcoinPublicKey
- isValidBitsharesPrivateKey
- orderFactory
- toPublicKey
- witnessStackToScriptWitness
Object literals
Type aliases
Props
Ƭ Props: object
Defined in components/forms/RadioButton.tsx:3
Defined in components/forms/Label.tsx:3
Defined in components/forms/Input.tsx:3
Defined in components/forms/SubmitButton.tsx:3
Defined in components/forms/Form.tsx:2
Defined in components/util/Spinner.tsx:5
Defined in components/util/Protip.tsx:5
Defined in components/util/ComponentPage.tsx:3
Defined in components/orderbook/Row.tsx:4
Defined in components/orderbook/Table.tsx:8
Defined in components/util/Modal.tsx:3
Defined in components/orderbook/FilterButton.tsx:3
Defined in components/orderbook/Orderbook.tsx:75
Type declaration:
- orders: Order[]
Optional bg
• bg? : undefined | string
Defined in components/util/ComponentPage.tsx:6
children
• children: any
Defined in components/util/ComponentPage.tsx:5
footer
• footer: ReactElement
Defined in components/forms/Form.tsx:4
main
• main: ReactElement
Defined in components/forms/Form.tsx:3
network
• network: Network
Defined in components/util/Protip.tsx:6
Optional title
• title? : undefined | string
Defined in components/util/ComponentPage.tsx:4
Functions
Const Accept
▸ Accept(): Element‹›
Defined in components/pages/Accept.tsx:23
Returns: Element‹›
Const App
▸ App(): Element‹›
Defined in App.tsx:11
Returns: Element‹›
Const ComponentPage
▸ ComponentPage(props: Props): Element‹›
Defined in components/util/ComponentPage.tsx:9
Parameters:
| Name | Type |
|---|---|
props | Props |
Returns: Element‹›
Const FilterButton
▸ FilterButton(props: Props): Element‹›
Defined in components/orderbook/FilterButton.tsx:8
Parameters:
| Name | Type |
|---|---|
props | Props |
Returns: Element‹›
Const Form
▸ Form(props: Props): Element‹›
Defined in components/forms/Form.tsx:7
Parameters:
| Name | Type |
|---|---|
props | Props |
Returns: Element‹›
Const Input
▸ Input(props: Props): Element‹›
Defined in components/forms/Input.tsx:14
Parameters:
| Name | Type |
|---|---|
props | Props |
Returns: Element‹›
Const Label
▸ Label(props: Props): Element‹›
Defined in components/forms/Label.tsx:7
Parameters:
| Name | Type |
|---|---|
props | Props |
Returns: Element‹›
Const LandingPage
▸ LandingPage(): Element‹›
Defined in components/pages/LandingPage.tsx:4
Returns: Element‹›
Const Modal
▸ Modal(props: Props): Element‹›
Defined in components/util/Modal.tsx:10
Parameters:
| Name | Type |
|---|---|
props | Props |
Returns: Element‹›
Const Navbar
▸ Navbar(): Element‹›
Defined in components/Navbar/Navbar.tsx:6
Returns: Element‹›
Const Orderbook
▸ Orderbook(props: Props): Element‹›
Defined in components/orderbook/Orderbook.tsx:79
Parameters:
| Name | Type |
|---|---|
props | Props |
Returns: Element‹›
Const OrderbookPage
▸ OrderbookPage(): Element‹›
Defined in components/pages/OrderbookPage.tsx:4
Returns: Element‹›
Const Propose
▸ Propose(): Element‹›
Defined in components/pages/Propose.tsx:22
Returns: Element‹›
Const Protip
▸ Protip(props: Props): Element‹›
Defined in components/util/Protip.tsx:9
Parameters:
| Name | Type |
|---|---|
props | Props |
Returns: Element‹›
Const RadioButton
▸ RadioButton(props: Props): Element‹›
Defined in components/forms/RadioButton.tsx:12
Parameters:
| Name | Type |
|---|---|
props | Props |
Returns: Element‹›
Const Row
▸ Row(props: Props): Element‹›
Defined in components/orderbook/Row.tsx:9
Parameters:
| Name | Type |
|---|---|
props | Props |
Returns: Element‹›
Const Spinner
▸ Spinner(props: Props): Element‹›
Defined in components/util/Spinner.tsx:9
Parameters:
| Name | Type |
|---|---|
props | Props |
Returns: Element‹›
Const SubmitButton
▸ SubmitButton(props: Props): Element‹›
Defined in components/forms/SubmitButton.tsx:9
Parameters:
| Name | Type |
|---|---|
props | Props |
Returns: Element‹›
Const Table
▸ Table(props: Props): Element‹›
Defined in components/orderbook/Table.tsx:13
Parameters:
| Name | Type |
|---|---|
props | Props |
Returns: Element‹›
Const TradingPage
▸ TradingPage(): Element‹›
Defined in components/pages/TradingPage.tsx:9
Returns: Element‹›
errorHandler
▸ errorHandler(message: string): void
Defined in cli/getUserInput.ts:257
An errorhandler for errors in CLI.
Parameters:
| Name | Type | Description |
|---|---|---|
message | string | The message to print. |
Returns: void
Const fakeKey
▸ fakeKey(length: number, network?: undefined | string): string
Defined in pkg/util/util.ts:3
Parameters:
| Name | Type |
|---|---|
length | number |
network? | undefined | string |
Returns: string
getAddress
▸ getAddress(processArgv: string[]): void
Defined in pkg/address/getAddress.ts:8
Get address pair and print to stdout
Parameters:
| Name | Type | Description |
|---|---|---|
processArgv | string[] | The argument array. |
Returns: void
getBTCAddress
▸ getBTCAddress(network: string): BTCAddress
Defined in pkg/address/address.ts:29
A function for generating a random Bitcoin address with its corresponding private key
Parameters:
| Name | Type | Description |
|---|---|---|
network | string | A string with the requested network type. |
Returns: BTCAddress
A BTCAddress interface with a privatekey/address pair.
getBTSAddress
▸ getBTSAddress(network: string): BTSAddress
Defined in pkg/address/address.ts:63
A function for generating a random Bitshares address (PublicKey) with its corresponding private key
Parameters:
| Name | Type | Description |
|---|---|---|
network | string | A string with the requested network type. |
Returns: BTSAddress
An Address interface with a private key and address.
getSecret
▸ getSecret(): Secret
Defined in pkg/secret/secret.ts:18
A function for generating and hashing a crypto random string with a length of 32. The length of the secret can not be changed!
Returns: Secret
An Secret object.
getUserInput
▸ getUserInput(): Promise‹ACCSFields›
Defined in cli/getUserInput.ts:13
Get user input from JSON config file or stdin and store everything in a fields object.
Returns: Promise‹ACCSFields›
The raw user input fields object.
Const hash
▸ hash(s: string): string
Defined in pkg/util/util.ts:14
Parameters:
| Name | Type |
|---|---|
s | string |
Returns: string
isValidBitcoinPrivateKey
▸ isValidBitcoinPrivateKey(privateKey: string, network: string): boolean
Defined in pkg/address/validator.ts:1
Parameters:
| Name | Type |
|---|---|
privateKey | string |
network | string |
Returns: boolean
isValidBitcoinPublicKey
▸ isValidBitcoinPublicKey(publicKey: string): boolean
Defined in pkg/address/validator.ts:17
Parameters:
| Name | Type |
|---|---|
publicKey | string |
Returns: boolean
isValidBitsharesPrivateKey
▸ isValidBitsharesPrivateKey(privateKey: string): boolean
Defined in pkg/address/validator.ts:21
Parameters:
| Name | Type |
|---|---|
privateKey | string |
Returns: boolean
Const orderFactory
▸ orderFactory(count: number): Order[]
Defined in components/orderbook/Orderbook.tsx:46
Parameters:
| Name | Type |
|---|---|
count | number |
Returns: Order[]
Const toPublicKey
▸ toPublicKey(privateKey: string): string
Defined in pkg/util/util.ts:18
Parameters:
| Name | Type |
|---|---|
privateKey | string |
Returns: string
witnessStackToScriptWitness
▸ witnessStackToScriptWitness(witness: Buffer[]): Buffer
Defined in pkg/bitcoin/htlc/witnessStack.ts:10
Helperfunction to serialize the final witness script
Parameters:
| Name | Type | Description |
|---|---|---|
witness | Buffer[] |
Returns: Buffer
Object literals
Const status
▪ status: object
Defined in components/orderbook/Orderbook.tsx:14
▪ active: object
Defined in components/orderbook/Orderbook.tsx:15
color: string = "teal"
label: string = "active"
▪ expired: object
Defined in components/orderbook/Orderbook.tsx:23
color: string = "gray"
label: string = "expired"
▪ fulfilled: object
Defined in components/orderbook/Orderbook.tsx:19
color: string = "gray"
label: string = "fulfilled"