@iov/bcp Documentation

Index

Enumerations

Classes

Interfaces

Functions

Type aliases

AccountQuery

AccountQuery: AddressQuery | PubkeyQuery

Address

Address: string & As<"address">

A codec specific address encoded as a string

AtomicSwap

AtomicSwap: OpenSwap | ClaimedSwap | AbortedSwap

AtomicSwapQuery

AtomicSwapQuery: AtomicSwapRecipientQuery | AtomicSwapSenderQuery | AtomicSwapIdQuery | AtomicSwapHashQuery

BlockId

BlockId: string & As<"block-id">

A printable block ID in a blockchain-specific format.

In Lisk, this is a uint64 number like 3444561236416494115 and in BNS this is an upper hex encoded 20 byte hash like 6DD2BFCD9CEFE93C64C15439C513BFD61A0225BB. Ethereum uses 0x-prefixed hashes like 0x4bd6efe48bed3ea4fd25678cc81d1ed372bb8c8654c29880889fed66130c6502

BlockInfo

BlockInfo: BlockInfoPending | BlockInfoSucceeded | BlockInfoFailed

Information attached to a signature about its state in a block

ChainId

ChainId: string & As<"chain-id">

Used to differentiate a blockchain. Should be alphanumeric or -_/ and unique

ConfirmedAndSignedTransaction

ConfirmedAndSignedTransaction<T>: ConfirmedTransaction<T> & SignedTransaction<T>

Type parameters

T: LightTransaction

Hash

Hash: Uint8Array & As<"hash">

Nonce

Nonce: number & As<"nonce">

An integer in the safe integer range

PostableBytes

PostableBytes: Uint8Array & As<"postable">

Preimage

Preimage: Uint8Array & As<"preimage">

PubkeyBytes

PubkeyBytes: Uint8Array & As<"pubkey-bytes">

SignableBytes

SignableBytes: Uint8Array & As<"signable">

SignatureBytes

SignatureBytes: Uint8Array & As<"signature">

SwapIdBytes

SwapIdBytes: Uint8Array & As<"swap-id">

SwapTimeout

SwapTimeout: BlockHeightTimeout | TimestampTimeout

SwapTransaction

SwapTransaction: SwapOfferTransaction | SwapClaimTransaction | SwapAbortTransaction

TokenTicker

TokenTicker: string & As<"token-ticker">

TransactionId

TransactionId: string & As<"transaction-id">

A printable transaction ID in a blockchain-specific format.

In Lisk, this is a uint64 number like 3444561236416494115 and in BNS this is an upper hex encoded 20 byte hash like 3A0DB99E82E11DBB9F987EFCD04264305C2CA6F2. Ethereum uses 0x-prefixed hashes like 0xce8145665aa6ce4c7d01aabffbb610efd03de4d84785840d43b000e1b7e785c3

UnsignedTransaction

UnsignedTransaction: LightTransaction & WithCreator

Functions

createTimestampTimeout

createTimestampTimeout(secondsFromNow: number): TimestampTimeout

- Defined in transactions.ts:309
Parameters
- secondsFromNow: number
Returns TimestampTimeout

identityEquals

identityEquals(left: Identity, right: Identity): boolean

- Defined in transactions.ts:67
Compares two objects that conform to the Identity interface for equality. All additional (non-Identity) fields are ignored.

Parameters
- left: Identity
  
  the left hand side of the comparison
- right: Identity
  
  the right hand side of the comparison
Returns boolean

isAbortedSwap

isAbortedSwap(swap: AtomicSwap): boolean

- Defined in atomicswaptypes.ts:144
Parameters
- swap: AtomicSwap
Returns boolean

isAddressQuery

isAddressQuery(query: AccountQuery): boolean

- Defined in connection.ts:149
Parameters
- query: AccountQuery
Returns boolean

isAmount

isAmount(data: unknown): boolean

- Defined in transactions.ts:158
Parameters
- data: unknown
Returns boolean

isAtomicSwapConnection

isAtomicSwapConnection(conn: BlockchainConnection): boolean

- Defined in atomicswaptypes.ts:207
Parameters
- conn: BlockchainConnection
Returns boolean

isAtomicSwapHashQuery

isAtomicSwapHashQuery(query: AtomicSwapQuery): boolean

- Defined in atomicswaptypes.ts:186
a type guard to use in the swap-based queries

Parameters
- query: AtomicSwapQuery
Returns boolean

isAtomicSwapIdQuery

isAtomicSwapIdQuery(query: AtomicSwapQuery): boolean

- Defined in atomicswaptypes.ts:181
a type guard to use in the swap-based queries

Parameters
- query: AtomicSwapQuery
Returns boolean

isAtomicSwapRecipientQuery

isAtomicSwapRecipientQuery(query: AtomicSwapQuery): boolean

- Defined in atomicswaptypes.ts:171
a type guard to use in the swap-based queries

Parameters
- query: AtomicSwapQuery
Returns boolean

isAtomicSwapSenderQuery

isAtomicSwapSenderQuery(query: AtomicSwapQuery): boolean

- Defined in atomicswaptypes.ts:176
a type guard to use in the swap-based queries

Parameters
- query: AtomicSwapQuery
Returns boolean

isBlockHeightTimeout

isBlockHeightTimeout(timeout: SwapTimeout): boolean

- Defined in transactions.ts:296
Parameters
- timeout: SwapTimeout
Returns boolean

isBlockInfoFailed

isBlockInfoFailed(info: BlockInfo): boolean

- Defined in connection.ts:107
Parameters
- info: BlockInfo
Returns boolean

isBlockInfoPending

isBlockInfoPending(info: BlockInfo): boolean

- Defined in connection.ts:99
Parameters
- info: BlockInfo
Returns boolean

isBlockInfoSucceeded

isBlockInfoSucceeded(info: BlockInfo): boolean

- Defined in connection.ts:103
Parameters
- info: BlockInfo
Returns boolean

isClaimedSwap

isClaimedSwap(swap: AtomicSwap): boolean

- Defined in atomicswaptypes.ts:140
Parameters
- swap: AtomicSwap
Returns boolean

isConfirmedTransaction

isConfirmedTransaction<T>(transaction: ConfirmedTransaction<T> | FailedTransaction): boolean

- Defined in transactions.ts:266
Type parameters
- T: LightTransaction
Parameters
- transaction: ConfirmedTransaction<T> | FailedTransaction
Returns boolean

isFailedTransaction

isFailedTransaction<T>(transaction: ConfirmedTransaction<T> | FailedTransaction): boolean

- Defined in transactions.ts:272
Type parameters
- T: LightTransaction
Parameters
- transaction: ConfirmedTransaction<T> | FailedTransaction
Returns boolean

isFee

isFee(data: unknown): boolean

- Defined in transactions.ts:174
Parameters
- data: unknown
Returns boolean

isFullSignature

isFullSignature(data: unknown): boolean

- Defined in transactions.ts:125
Parameters
- data: unknown
Returns boolean

isIdentity

isIdentity(data: unknown): boolean

- Defined in transactions.ts:52
Parameters
- data: unknown
Returns boolean

isLightTransaction

isLightTransaction(data: unknown): boolean

- Defined in transactions.ts:199
Parameters
- data: unknown
Returns boolean

isOpenSwap

isOpenSwap(swap: AtomicSwap): boolean

- Defined in atomicswaptypes.ts:136
Parameters
- swap: AtomicSwap
Returns boolean

isPubkeyBundle

isPubkeyBundle(data: unknown): boolean

- Defined in transactions.ts:17
Parameters
- data: unknown
Returns boolean

isPubkeyQuery

isPubkeyQuery(query: AccountQuery): boolean

- Defined in connection.ts:153
Parameters
- query: AccountQuery
Returns boolean

isSendTransaction

isSendTransaction(transaction: LightTransaction): boolean

- Defined in transactions.ts:313
Parameters
- transaction: LightTransaction
Returns boolean

isSwapAbortTransaction

isSwapAbortTransaction(transaction: LightTransaction): boolean

- Defined in atomicswaptypes.ts:63
Parameters
- transaction: LightTransaction
Returns boolean

isSwapClaimTransaction

isSwapClaimTransaction(transaction: LightTransaction): boolean

- Defined in atomicswaptypes.ts:59
Parameters
- transaction: LightTransaction
Returns boolean

isSwapOfferTransaction

isSwapOfferTransaction(transaction: LightTransaction): boolean

- Defined in atomicswaptypes.ts:55
Parameters
- transaction: LightTransaction
Returns boolean

isSwapProcessStateAborted

isSwapProcessStateAborted(state: SwapProcessState): boolean

- Defined in atomicswaptypes.ts:91
Parameters
- state: SwapProcessState
Returns boolean

isSwapProcessStateClaimed

isSwapProcessStateClaimed(state: SwapProcessState): boolean

- Defined in atomicswaptypes.ts:87
Parameters
- state: SwapProcessState
Returns boolean

isSwapProcessStateOpen

isSwapProcessStateOpen(state: SwapProcessState): boolean

- Defined in atomicswaptypes.ts:83
Parameters
- state: SwapProcessState
Returns boolean

isSwapTransaction

isSwapTransaction(transaction: LightTransaction): boolean

- Defined in atomicswaptypes.ts:67
Parameters
- transaction: LightTransaction
Returns boolean

isTimestampTimeout

isTimestampTimeout(timeout: SwapTimeout): boolean

- Defined in transactions.ts:305
Parameters
- timeout: SwapTimeout
Returns boolean

isUnsignedTransaction

isUnsignedTransaction(data: unknown): boolean

- Defined in transactions.ts:216
Parameters
- data: unknown
Returns boolean

pubkeyBundleEquals

pubkeyBundleEquals(left: PubkeyBundle, right: PubkeyBundle): boolean

- Defined in transactions.ts:35
Compares two objects that conform to the PubkeyBundle interface for equality.

This can also be used to compare pairs of derived types in which case all non-PubkeyBundle fields are ignored.

Parameters
- left: PubkeyBundle
  
  the left hand side of the comparison
- right: PubkeyBundle
  
  the right hand side of the comparison
Returns boolean

swapIdEquals

swapIdEquals(left: SwapId, right: SwapId): boolean

- Defined in transactions.ts:84
Parameters
- left: SwapId
- right: SwapId
Returns boolean

Index

Enumerations

Classes

Interfaces

Type aliases

Functions

Type aliases

AccountQuery

Address

AtomicSwap

AtomicSwapQuery

BlockId

BlockInfo

ChainId

ConfirmedAndSignedTransaction

Type parameters

T: LightTransaction

Hash

Nonce

PostableBytes

Preimage

PubkeyBytes

SignableBytes

SignatureBytes

SwapIdBytes

SwapTimeout

SwapTransaction

TokenTicker

TransactionId

UnsignedTransaction

Functions

createTimestampTimeout

Parameters

secondsFromNow: number

Returns TimestampTimeout

identityEquals

Parameters

left: Identity

right: Identity

Returns boolean

isAbortedSwap

Parameters

swap: AtomicSwap

Returns boolean

isAddressQuery

Parameters

query: AccountQuery

Returns boolean

isAmount

Parameters

data: unknown

Returns boolean

isAtomicSwapConnection

Parameters

conn: BlockchainConnection

Returns boolean

isAtomicSwapHashQuery

Parameters

query: AtomicSwapQuery

Returns boolean

isAtomicSwapIdQuery

Parameters

query: AtomicSwapQuery

Returns boolean

isAtomicSwapRecipientQuery

Parameters

query: AtomicSwapQuery

Returns boolean

isAtomicSwapSenderQuery

Parameters

query: AtomicSwapQuery

Returns boolean

isBlockHeightTimeout

Parameters

timeout: SwapTimeout

Returns boolean

isBlockInfoFailed

Parameters

info: BlockInfo

Returns boolean