Class ZkSendClient

Index

Constructors

Methods

createLinks getLink getLinkFromUrl linkBuilder loadLink loadLinkFromUrl

Constructors

constructor

new ZkSendClient(
client: ClientWithCoreApi,
options?: Omit<ZkSendOptions, "name">,
): ZkSendClient
Parameters
- client: ClientWithCoreApi
- options: Omit<ZkSendOptions, "name"> = {}
Returns ZkSendClient
- Defined in zksend/src/client.ts:57

Methods

createLinks

createLinks(
options: { links: ZkSendLinkBuilder[]; transaction?: Transaction },
): Promise<Transaction>
Parameters
- options: { links: ZkSendLinkBuilder[]; transaction?: Transaction }
Returns Promise<Transaction>
- Defined in zksend/src/client.ts:78

getLink

getLink(options: LoadLinkOptions): ZkSendLink
Get a link without loading its assets (synchronous)
Parameters
- options: LoadLinkOptions
Returns ZkSendLink
- Defined in zksend/src/client.ts:94

getLinkFromUrl

getLinkFromUrl(url: string): ZkSendLink
Get a link from a URL without loading assets (synchronous)
Parameters
- url: string
Returns ZkSendLink
- Defined in zksend/src/client.ts:118

linkBuilder

linkBuilder(options: LinkBuilderOptions): ZkSendLinkBuilder
Parameters
- options: LinkBuilderOptions
Returns ZkSendLinkBuilder
- Defined in zksend/src/client.ts:66

loadLink

loadLink(options: LoadLinkOptions): Promise<ZkSendLink>
Load a link and its assets
Parameters
- options: LoadLinkOptions
Returns Promise<ZkSendLink>
- Defined in zksend/src/client.ts:109

loadLinkFromUrl

loadLinkFromUrl(url: string): Promise<ZkSendLink>
Load a link from a URL and its assets
Parameters
- url: string
Returns Promise<ZkSendLink>
- Defined in zksend/src/client.ts:148