@arkade-os/sdk Documentation - v0.3.11
Preparing search index...
ArkProvider
Interface ArkProvider
interface
ArkProvider
{
confirmRegistration
(
intentId
:
string
)
:
Promise
<
void
>
;
deleteIntent
(
intent
:
SignedIntent
<
DeleteMessage
>
)
:
Promise
<
void
>
;
finalizeTx
(
arkTxid
:
string
,
finalCheckpointTxs
:
string
[]
)
:
Promise
<
void
>
;
getEventStream
(
signal
:
AbortSignal
,
topics
:
string
[]
,
)
:
AsyncIterableIterator
<
SettlementEvent
>
;
getInfo
()
:
Promise
<
ArkInfo
>
;
getPendingTxs
(
intent
:
SignedIntent
<
GetPendingTxMessage
>
,
)
:
Promise
<
PendingTx
[]
>
;
getTransactionsStream
(
signal
:
AbortSignal
,
)
:
AsyncIterableIterator
<
{
arkTx
?:
TxNotification
;
commitmentTx
?:
TxNotification
}
,
>
;
registerIntent
(
intent
:
SignedIntent
<
RegisterMessage
>
)
:
Promise
<
string
>
;
submitSignedForfeitTxs
(
signedForfeitTxs
:
string
[]
,
signedCommitmentTx
?:
string
,
)
:
Promise
<
void
>
;
submitTreeNonces
(
batchId
:
string
,
pubkey
:
string
,
nonces
:
TreeNonces
,
)
:
Promise
<
void
>
;
submitTreeSignatures
(
batchId
:
string
,
pubkey
:
string
,
signatures
:
TreePartialSigs
,
)
:
Promise
<
void
>
;
submitTx
(
signedArkTx
:
string
,
checkpointTxs
:
string
[]
,
)
:
Promise
<
{
arkTxid
:
string
;
finalArkTx
:
string
;
signedCheckpointTxs
:
string
[]
}
,
>
;
}
Implemented by
RestArkProvider
Index
Methods
confirm
Registration
delete
Intent
finalize
Tx
get
Event
Stream
get
Info
get
Pending
Txs
get
Transactions
Stream
register
Intent
submit
Signed
Forfeit
Txs
submit
Tree
Nonces
submit
Tree
Signatures
submit
Tx
Methods
confirm
Registration
confirmRegistration
(
intentId
:
string
)
:
Promise
<
void
>
Parameters
intentId
:
string
Returns
Promise
<
void
>
delete
Intent
deleteIntent
(
intent
:
SignedIntent
<
DeleteMessage
>
)
:
Promise
<
void
>
Parameters
intent
:
SignedIntent
<
DeleteMessage
>
Returns
Promise
<
void
>
finalize
Tx
finalizeTx
(
arkTxid
:
string
,
finalCheckpointTxs
:
string
[]
)
:
Promise
<
void
>
Parameters
arkTxid
:
string
finalCheckpointTxs
:
string
[]
Returns
Promise
<
void
>
get
Event
Stream
getEventStream
(
signal
:
AbortSignal
,
topics
:
string
[]
,
)
:
AsyncIterableIterator
<
SettlementEvent
>
Parameters
signal
:
AbortSignal
topics
:
string
[]
Returns
AsyncIterableIterator
<
SettlementEvent
>
get
Info
getInfo
()
:
Promise
<
ArkInfo
>
Returns
Promise
<
ArkInfo
>
get
Pending
Txs
getPendingTxs
(
intent
:
SignedIntent
<
GetPendingTxMessage
>
)
:
Promise
<
PendingTx
[]
>
Parameters
intent
:
SignedIntent
<
GetPendingTxMessage
>
Returns
Promise
<
PendingTx
[]
>
get
Transactions
Stream
getTransactionsStream
(
signal
:
AbortSignal
,
)
:
AsyncIterableIterator
<
{
arkTx
?:
TxNotification
;
commitmentTx
?:
TxNotification
}
,
>
Parameters
signal
:
AbortSignal
Returns
AsyncIterableIterator
<
{
arkTx
?:
TxNotification
;
commitmentTx
?:
TxNotification
}
>
register
Intent
registerIntent
(
intent
:
SignedIntent
<
RegisterMessage
>
)
:
Promise
<
string
>
Parameters
intent
:
SignedIntent
<
RegisterMessage
>
Returns
Promise
<
string
>
submit
Signed
Forfeit
Txs
submitSignedForfeitTxs
(
signedForfeitTxs
:
string
[]
,
signedCommitmentTx
?:
string
,
)
:
Promise
<
void
>
Parameters
signedForfeitTxs
:
string
[]
Optional
signedCommitmentTx
:
string
Returns
Promise
<
void
>
submit
Tree
Nonces
submitTreeNonces
(
batchId
:
string
,
pubkey
:
string
,
nonces
:
TreeNonces
,
)
:
Promise
<
void
>
Parameters
batchId
:
string
pubkey
:
string
nonces
:
TreeNonces
Returns
Promise
<
void
>
submit
Tree
Signatures
submitTreeSignatures
(
batchId
:
string
,
pubkey
:
string
,
signatures
:
TreePartialSigs
,
)
:
Promise
<
void
>
Parameters
batchId
:
string
pubkey
:
string
signatures
:
TreePartialSigs
Returns
Promise
<
void
>
submit
Tx
submitTx
(
signedArkTx
:
string
,
checkpointTxs
:
string
[]
,
)
:
Promise
<
{
arkTxid
:
string
;
finalArkTx
:
string
;
signedCheckpointTxs
:
string
[]
}
,
>
Parameters
signedArkTx
:
string
checkpointTxs
:
string
[]
Returns
Promise
<
{
arkTxid
:
string
;
finalArkTx
:
string
;
signedCheckpointTxs
:
string
[]
}
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
confirm
Registration
delete
Intent
finalize
Tx
get
Event
Stream
get
Info
get
Pending
Txs
get
Transactions
Stream
register
Intent
submit
Signed
Forfeit
Txs
submit
Tree
Nonces
submit
Tree
Signatures
submit
Tx
@arkade-os/sdk Documentation - v0.3.11
Loading...