Documentation
Preparing search index...
@mysten/zksend
ZkSendLink
Class ZkSendLink
Index
Constructors
constructor
Properties
address
assets?
bag
Object?
claimed?
claimed
By?
creator
Address?
keypair?
Methods
claim
Assets
create
Claim
Transaction
create
Regenerate
Transaction
load
Assets
load
Claimed
Status
from
Address
from
Url
Constructors
constructor
new
ZkSendLink
(
__namedParameters
:
ZkSendLinkOptions
)
:
ZkSendLink
Parameters
__namedParameters
:
ZkSendLinkOptions
Returns
ZkSendLink
Properties
address
address
:
string
Optional
assets
assets
?:
LinkAssets
Optional
bag
Object
bagObject
?:
null
|
SuiObjectData
Optional
claimed
claimed
?:
boolean
Optional
claimed
By
claimedBy
?:
string
Optional
creator
Address
creatorAddress
?:
string
Optional
keypair
keypair
?:
Keypair
Methods
claim
Assets
claimAssets
(
address
:
string
,
__namedParameters
?:
|
{
reclaim
?:
false
;
sign
?:
undefined
}
|
{
reclaim
:
true
;
sign
:
(
transaction
:
Uint8Array
)
=>
Promise
<
string
>
}
,
)
:
Promise
<
SuiTransactionBlockResponse
>
Parameters
address
:
string
__namedParameters
:
|
{
reclaim
?:
false
;
sign
?:
undefined
}
|
{
reclaim
:
true
;
sign
:
(
transaction
:
Uint8Array
)
=>
Promise
<
string
>
}
= {}
Returns
Promise
<
SuiTransactionBlockResponse
>
create
Claim
Transaction
createClaimTransaction
(
address
:
string
,
__namedParameters
?:
{
reclaim
?:
boolean
}
,
)
:
Transaction
Parameters
address
:
string
__namedParameters
:
{
reclaim
?:
boolean
}
= {}
Returns
Transaction
create
Regenerate
Transaction
createRegenerateTransaction
(
sender
:
string
,
options
?:
Omit
<
ZkSendLinkBuilderOptions
,
"sender"
>
,
)
:
Promise
<
{
transaction
:
Transaction
;
url
:
string
}
>
Parameters
sender
:
string
options
:
Omit
<
ZkSendLinkBuilderOptions
,
"sender"
>
= {}
Returns
Promise
<
{
transaction
:
Transaction
;
url
:
string
}
>
load
Assets
loadAssets
(
options
?:
{
loadClaimedAssets
?:
boolean
;
transaction
?:
SuiTransactionBlockResponse
;
}
,
)
:
Promise
<
void
>
Parameters
options
:
{
loadClaimedAssets
?:
boolean
;
transaction
?:
SuiTransactionBlockResponse
}
= {}
Returns
Promise
<
void
>
load
Claimed
Status
loadClaimedStatus
()
:
Promise
<
void
>
Returns
Promise
<
void
>
Static
from
Address
fromAddress
(
address
:
string
,
options
:
Omit
<
ZkSendLinkOptions
,
"address"
|
"keypair"
|
"isContractLink"
>
,
)
:
Promise
<
ZkSendLink
>
Parameters
address
:
string
options
:
Omit
<
ZkSendLinkOptions
,
"address"
|
"keypair"
|
"isContractLink"
>
Returns
Promise
<
ZkSendLink
>
Static
from
Url
fromUrl
(
url
:
string
,
options
?:
Omit
<
ZkSendLinkOptions
,
"address"
|
"keypair"
|
"isContractLink"
>
,
)
:
Promise
<
ZkSendLink
>
Parameters
url
:
string
options
:
Omit
<
ZkSendLinkOptions
,
"address"
|
"keypair"
|
"isContractLink"
>
= {}
Returns
Promise
<
ZkSendLink
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
address
assets
bag
Object
claimed
claimed
By
creator
Address
keypair
Methods
claim
Assets
create
Claim
Transaction
create
Regenerate
Transaction
load
Assets
load
Claimed
Status
from
Address
from
Url
Documentation
Loading...