Documentation
Preparing search index...
@mysten/zksend
ZkBag
Class ZkBag<IDs>
Type Parameters
IDs
Index
Constructors
constructor
Properties
ids
Methods
add
claim
finalize
init_
claim
new
reclaim
update_
receiver
Constructors
constructor
new
ZkBag
<
IDs
>
(
packageAddress
:
string
,
ids
:
IDs
)
:
ZkBag
<
IDs
>
Type Parameters
IDs
Parameters
packageAddress
:
string
ids
:
IDs
Returns
ZkBag
<
IDs
>
Properties
ids
ids
:
IDs
Methods
add
add
(
__namedParameters
:
{
arguments
:
[
store
:
string
|
TransactionObjectArgument
,
receiver
:
|
string
|
{
$kind
:
"GasCoin"
;
GasCoin
:
true
}
|
{
$kind
:
"Input"
;
Input
:
number
;
type
?:
"pure"
}
|
{
$kind
:
"Input"
;
Input
:
number
;
type
?:
"object"
}
|
{
$kind
:
"Result"
;
Result
:
number
}
|
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
item
:
string
|
TransactionObjectArgument
,
]
;
typeArguments
:
[
string
]
;
}
,
)
:
(
tx
:
Transaction
)
=>
{
$kind
:
"Result"
;
Result
:
number
}
Parameters
__namedParameters
:
{
arguments
:
[
store
:
string
|
TransactionObjectArgument
,
receiver
:
|
string
|
{
$kind
:
"GasCoin"
;
GasCoin
:
true
}
|
{
$kind
:
"Input"
;
Input
:
number
;
type
?:
"pure"
}
|
{
$kind
:
"Input"
;
Input
:
number
;
type
?:
"object"
}
|
{
$kind
:
"Result"
;
Result
:
number
}
|
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
item
:
string
|
TransactionObjectArgument
,
]
;
typeArguments
:
[
string
]
;
}
Returns
(
tx
:
Transaction
)
=>
{
$kind
:
"Result"
;
Result
:
number
}
claim
claim
(
__namedParameters
:
{
arguments
:
[
bag
:
string
|
TransactionObjectArgument
,
claim
:
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
id
:
string
|
TransactionObjectArgument
,
]
;
typeArguments
:
[
string
]
;
}
,
)
:
(
tx
:
Transaction
)
=>
{
$kind
:
"Result"
;
Result
:
number
}
Parameters
__namedParameters
:
{
arguments
:
[
bag
:
string
|
TransactionObjectArgument
,
claim
:
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
id
:
string
|
TransactionObjectArgument
,
]
;
typeArguments
:
[
string
]
;
}
Returns
(
tx
:
Transaction
)
=>
{
$kind
:
"Result"
;
Result
:
number
}
finalize
finalize
(
__namedParameters
:
{
arguments
:
[
bag
:
string
|
TransactionObjectArgument
,
claim
:
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
]
;
}
,
)
:
(
tx
:
Transaction
)
=>
void
Parameters
__namedParameters
:
{
arguments
:
[
bag
:
string
|
TransactionObjectArgument
,
claim
:
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
]
;
}
Returns
(
tx
:
Transaction
)
=>
void
init_
claim
init_claim
(
__namedParameters
:
{
arguments
:
[
store
:
string
|
TransactionObjectArgument
]
;
}
,
)
:
(
tx
:
Transaction
,
)
=>
readonly
[
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
]
Parameters
__namedParameters
:
{
arguments
:
[
store
:
string
|
TransactionObjectArgument
]
}
Returns
(
tx
:
Transaction
,
)
=>
readonly
[
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
]
new
new
(
__namedParameters
:
{
arguments
:
[
store
:
string
|
TransactionObjectArgument
,
receiver
:
|
string
|
{
$kind
:
"GasCoin"
;
GasCoin
:
true
}
|
{
$kind
:
"Input"
;
Input
:
number
;
type
?:
"pure"
}
|
{
$kind
:
"Input"
;
Input
:
number
;
type
?:
"object"
}
|
{
$kind
:
"Result"
;
Result
:
number
}
|
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
]
;
}
,
)
:
(
tx
:
Transaction
)
=>
void
Parameters
__namedParameters
:
{
arguments
:
[
store
:
string
|
TransactionObjectArgument
,
receiver
:
|
string
|
{
$kind
:
"GasCoin"
;
GasCoin
:
true
}
|
{
$kind
:
"Input"
;
Input
:
number
;
type
?:
"pure"
}
|
{
$kind
:
"Input"
;
Input
:
number
;
type
?:
"object"
}
|
{
$kind
:
"Result"
;
Result
:
number
}
|
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
]
;
}
Returns
(
tx
:
Transaction
)
=>
void
reclaim
reclaim
(
__namedParameters
:
{
arguments
:
[
store
:
string
|
TransactionObjectArgument
,
receiver
:
|
string
|
{
$kind
:
"GasCoin"
;
GasCoin
:
true
}
|
{
$kind
:
"Input"
;
Input
:
number
;
type
?:
"pure"
}
|
{
$kind
:
"Input"
;
Input
:
number
;
type
?:
"object"
}
|
{
$kind
:
"Result"
;
Result
:
number
}
|
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
]
;
}
,
)
:
(
tx
:
Transaction
,
)
=>
readonly
[
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
]
Parameters
__namedParameters
:
{
arguments
:
[
store
:
string
|
TransactionObjectArgument
,
receiver
:
|
string
|
{
$kind
:
"GasCoin"
;
GasCoin
:
true
}
|
{
$kind
:
"Input"
;
Input
:
number
;
type
?:
"pure"
}
|
{
$kind
:
"Input"
;
Input
:
number
;
type
?:
"object"
}
|
{
$kind
:
"Result"
;
Result
:
number
}
|
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
]
;
}
Returns
(
tx
:
Transaction
,
)
=>
readonly
[
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
]
update_
receiver
update_receiver
(
__namedParameters
:
{
arguments
:
[
bag
:
string
|
TransactionObjectArgument
,
from
:
|
string
|
{
$kind
:
"GasCoin"
;
GasCoin
:
true
}
|
{
$kind
:
"Input"
;
Input
:
number
;
type
?:
"pure"
}
|
{
$kind
:
"Input"
;
Input
:
number
;
type
?:
"object"
}
|
{
$kind
:
"Result"
;
Result
:
number
}
|
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
to
:
|
string
|
{
$kind
:
"GasCoin"
;
GasCoin
:
true
}
|
{
$kind
:
"Input"
;
Input
:
number
;
type
?:
"pure"
}
|
{
$kind
:
"Input"
;
Input
:
number
;
type
?:
"object"
}
|
{
$kind
:
"Result"
;
Result
:
number
}
|
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
]
;
}
,
)
:
(
tx
:
Transaction
)
=>
void
Parameters
__namedParameters
:
{
arguments
:
[
bag
:
string
|
TransactionObjectArgument
,
from
:
|
string
|
{
$kind
:
"GasCoin"
;
GasCoin
:
true
}
|
{
$kind
:
"Input"
;
Input
:
number
;
type
?:
"pure"
}
|
{
$kind
:
"Input"
;
Input
:
number
;
type
?:
"object"
}
|
{
$kind
:
"Result"
;
Result
:
number
}
|
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
to
:
|
string
|
{
$kind
:
"GasCoin"
;
GasCoin
:
true
}
|
{
$kind
:
"Input"
;
Input
:
number
;
type
?:
"pure"
}
|
{
$kind
:
"Input"
;
Input
:
number
;
type
?:
"object"
}
|
{
$kind
:
"Result"
;
Result
:
number
}
|
{
$kind
:
"NestedResult"
;
NestedResult
:
[
number
,
number
]
}
,
]
;
}
Returns
(
tx
:
Transaction
)
=>
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
ids
Methods
add
claim
finalize
init_
claim
new
reclaim
update_
receiver
Documentation
Loading...