@haneullabs/zksend 0.1.0 → 1.0.2

package/README.md

@@ -1 +1,240 @@
 # `@haneullabs/zksend`
+
+Create claimable links for transferring coins and NFTs. Recipients can claim assets via URL without
+needing a wallet set up beforehand.
+
+## Installation
+
+```sh
+npm install @haneullabs/zksend
+```
+
+## Limitations
+
+- zkSend only supports Mainnet and Testnet at this time.
+- Objects within links must be publicly transferrable.
+
+## Create a link
+
+You can start creating your own zkSend link using the `ZkSendLinkBuilder` class. This class
+constructor takes an object with the following options:
+
+- **`sender`** (required) - The address of the sender / creator of the link.
+- **`client`** (optional) - The `@haneullabs/haneul` client used to fetch data to construct the link. If
+  not provided, a default client will be used.
+- **`network`** (optional) - The network that the link will be created for. Defaults to `mainnet`.
+
+```ts
+import { ZkSendLinkBuilder } from '@haneullabs/zksend';
+
+const link = new ZkSendLinkBuilder({
+	sender: '0x...',
+});
+```
+
+### Adding HANEUL to the link
+
+You can add HANEUL to the link by calling `link.addClaimableMist()`. This method takes the following
+params:
+
+- **`amount`** (required) - The amount of GEUNHWA (the base unit of HANEUL) to add to the link.
+
+### Adding non-HANEUL coins to the link
+
+You can add non-HANEUL coins to the link by calling `link.addClaimableBalance()`. This method takes the
+following params:
+
+- **`coinType`** (required) - The coin type of the coin to add to the link (e.g. `0x2::haneul::HANEUL`).
+- **`amount`** (required) - The amount of the coin to add to the link. Represented in the base unit
+  of the coin.
+
+The SDK will automatically perform the necessary coin management logic to transfer the defined
+amount, such as merging and splitting coin objects.
+
+### Adding objects to the link
+
+You can add a publicly-transferrable object to the link by calling `link.addClaimableObject()`. This
+method takes the following params:
+
+- **`id`** (required) - The ID of the object. This must be owned by the `sender` you configured when
+  creating the link.
+
+### Adding objects created in the same transaction
+
+You can create objects to add to links in the same transaction the link is created in by using
+`link.addClaimableObjectRef()`:
+
+- **`ref`** (required) - The reference to the object you want to add to the link.
+- **`type`** (required) - The move type of the object you are adding
+
+```ts
+const tx = new Transaction();
+
+const link = new ZkSendLinkBuilder({
+	sender: '0x...',
+});
+
+const newObject = tx.moveCall({
+	target: `${PACKAGE_ID}::your_module::mint`,
+});
+
+link.addClaimableObjectRef({
+	ref: newObject,
+	type: `${PACKAGE_ID}::your_module::YourType`,
+});
+
+// Adds the link creation transactions to the transaction
+link.createSendTransaction({
+	transaction: tx,
+});
+```
+
+### Getting the link URL
+
+At any time, you can get the URL for the link by calling `link.getLink()`.
+
+## Submitting the link transaction
+
+Once you have built your zkSend link, you need to execute a transaction to transfer assets and make
+the link claimable.
+
+You can call the `link.createSendTransaction()` method, which returns a `Transaction` object that
+you can sign and submit.
+
+```ts
+const tx = await link.createSendTransaction();
+
+const { bytes, signature } = tx.sign({ client, signer: keypair });
+
+const result = await client.executeTransactionBlock({
+	transactionBlock: bytes,
+	signature,
+});
+```
+
+If you have a keypair you would like to send the transaction with, you can use the `create` method
+as shorthand for creating the send transaction, signing it, and submitting it:
+
+```ts
+await link.create({
+	signer: yourKeypair,
+	// Wait until the new link is ready to be indexed so it is claimable
+	waitForTransaction: true,
+});
+```
+
+## Claiming a link
+
+To claim a link via the SDK you can use the `ZkSendLink` class:
+
+```ts
+import { ZkSendLink } from '@haneullabs/zksend';
+
+// create a link instance from a URL
+const link = await ZkSendLink.fromUrl('https://zksend.com/claim#$abc...');
+
+// list what claimable assets the link has
+const { nfts, balances } = link.assets;
+
+// claim all the assets from the link
+await link.claimAssets(addressOfClaimer);
+```
+
+## Listing links you have created
+
+To list the links created by a specific address, you can use the `listCreatedLinks` function:
+
+```ts
+import { listCreatedLinks } from '@haneullabs/zksend';
+
+const { links, hasNextPage, cursor } = await listCreatedLinks({
+	address: addressOfCreator,
+});
+
+// get the claimable assets for this link (will be empty if the link has been claimed)
+const { nfts, balances } = await links[0].assets;
+```
+
+## Listing transactions and the links they created
+
+`getSentTransactionsWithLinks` will return a list of transactions sent by the provided address. Each
+result will include the transaction that was sent, along with an array containing any links that
+were created or regenerated by that transaction.
+
+```ts
+import { getSentTransactionsWithLinks } from '@haneullabs/zksend';
+
+const { data, hasNextPage, nextCursor } = await getSentTransactionsWithLinks({
+	address: addressOfCreator,
+});
+
+for (const { transaction, links } of data) {
+	// get the claimable assets for this link (will be empty if the link has been claimed)
+	const firstLink = links[0];
+
+	// link is claimed
+	firstLink.claimed;
+	const { nfts, balances } = firstLink.assets;
+
+	// claim link
+	await firstLink.link.claimAssets(addressOfClaimer);
+}
+```
+
+By default `getSentTransactionsWithLinks` will not load the assets for claimed links. This can be
+changed by passing `loadClaimedAssets: true` to the function.
+
+## Regenerating links
+
+If you lose a link you've created, you can re-generate the link (this can only done from the address
+that originally created the link):
+
+```ts
+import { listCreatedLinks } from '@haneullabs/zksend';
+
+const { links, hasNextPage, cursor } = await listCreatedLinks({
+	address: addressOfCreator,
+});
+
+// url will be the new link url
+const { url, transaction } = await links[0].link.createRegenerateTransaction(addressOfLinkCreator);
+
+// Execute the transaction to regenerate the link
+const result = await client.signAndExecuteTransaction({
+	transaction,
+	signer: keypair,
+});
+```
+
+## Bulk link creation
+
+To create multiple links in a single transaction, you can use `ZkSendLinkBuilder.createLinks`:
+
+```ts
+const links = [];
+
+for (let i = 0; i < 10; i++) {
+	const link = new ZkSendLinkBuilder({
+		client,
+		sender: keypair.toSuiAddress(),
+	});
+
+	link.addClaimableMist(100n);
+	links.push(link);
+}
+
+const urls = links.map((link) => link.getLink());
+
+const tx = await ZkSendLinkBuilder.createLinks({
+	links,
+});
+
+const result = await client.signAndExecuteTransaction({
+	transaction: tx,
+	signer: keypair,
+});
+```
+
+## Documentation
+
+See the [zkSend SDK documentation](https://sdk.haneul-labs.com/zksend) for more details.

package/dist/client.d.mts

@@ -0,0 +1,59 @@
+import { ZkBagContractOptions } from "./links/zk-bag.mjs";
+import { ZkSendLinkBuilder } from "./links/builder.mjs";
+import { ZkSendLink } from "./links/claim.mjs";
+import { Transaction } from "@haneullabs/haneul/transactions";
+import { Keypair } from "@haneullabs/haneul/cryptography";
+import { ClientWithCoreApi, HaneulClientRegistration } from "@haneullabs/haneul/client";
+
+//#region src/client.d.ts
+type ZkSendCompatibleClient = ClientWithCoreApi;
+interface ZkSendOptions<Name extends string = 'zksend'> {
+  name?: Name;
+  host?: string;
+  path?: string;
+  claimApi?: string;
+  contract?: ZkBagContractOptions;
+}
+interface LinkBuilderOptions {
+  sender: string;
+  keypair?: Keypair;
+}
+type LoadLinkOptions = {
+  address: string;
+  keypair?: never;
+} | {
+  keypair: Keypair;
+  address?: never;
+};
+declare class ZkSendClient {
+  #private;
+  constructor(client: ZkSendCompatibleClient, options?: Omit<ZkSendOptions, 'name'>);
+  linkBuilder(options: LinkBuilderOptions): ZkSendLinkBuilder;
+  createLinks(options: {
+    links: ZkSendLinkBuilder[];
+    transaction?: Transaction;
+  }): Promise<Transaction>;
+  /**
+   * Get a link without loading its assets (synchronous)
+   */
+  getLink(options: LoadLinkOptions): ZkSendLink;
+  /**
+   * Load a link and its assets
+   */
+  loadLink(options: LoadLinkOptions): Promise<ZkSendLink>;
+  /**
+   * Get a link from a URL without loading assets (synchronous)
+   */
+  getLinkFromUrl(url: string): ZkSendLink;
+  /**
+   * Load a link from a URL and its assets
+   */
+  loadLinkFromUrl(url: string): Promise<ZkSendLink>;
+}
+declare function zksend<Name extends string = 'zksend'>({
+  name,
+  ...options
+}?: ZkSendOptions<Name>): HaneulClientRegistration<ZkSendCompatibleClient, Name, ZkSendClient>;
+//#endregion
+export { LinkBuilderOptions, LoadLinkOptions, ZkSendClient, ZkSendCompatibleClient, ZkSendOptions, zksend };
+//# sourceMappingURL=client.d.mts.map

package/dist/client.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.mts","names":[],"sources":["../src/client.ts"],"sourcesContent":[],"mappings":";;;;;;;;KAcY,sBAAA,GAAyB;UAEpB;EAFL,IAAA,CAAA,EAGJ,IAHI;EAEK,IAAA,CAAA,EAAA,MAAA;EAQA,IAAA,CAAA,EAAA,MAAA;EAKL,QAAA,CAAA,EAAA,MAAA;EAmBC,QAAA,CAAA,EA3BD,oBA2Ba;;AAQkC,UAhC1C,kBAAA,CAgC0C;EAAL,MAAA,EAAA,MAAA;EAShC,OAAA,CAAA,EAvCX,OAuCW;;AAab,KAjDG,eAAA,GAiDH;EACO,OAAA,EAAA,MAAA;EACH,OAAA,CAAA,EAAA,KAAA;CAAR,GAAA;EAaa,OAAA,EA1DN,OA0DM;EAAkB,OAAA,CAAA,EAAA,KAAA;CAeX;AAA0B,cA5DtC,YAAA,CA4DsC;EAAR,CAAA,OAAA;EASb,WAAA,CAAA,MAAA,EA7DT,sBA6DS,EAAA,OAAA,CAAA,EA7DwB,IA6DxB,CA7D6B,aA6D7B,EAAA,MAAA,CAAA;EA8Be,WAAA,CAAA,OAAA,EAlFvB,kBAkFuB,CAAA,EAlFF,iBAkFE;EAAR,WAAA,CAAA,OAAA,EAAA;IAAO,KAAA,EArEnC,iBAqEmC,EAAA;IAO5B,WAAM,CAAA,EA3EN,WA2EM;EACrB,CAAA,CAAA,EA3EI,OA2EJ,CA3EY,WA2EZ,CAAA;EAEgB;;;EAA8D,OAAA,CAAA,OAAA,EAhE7D,eAgE6D,CAAA,EAhE3C,UAgE2C;EAAM;;;oBAjD5D,kBAAkB,QAAQ;;;;+BASrB;;;;gCA8BO,QAAQ;;iBAO7B;;;IAGb,cAAc,QAAa,yBAAyB,wBAAwB,MAAM"}

package/dist/client.mjs

@@ -0,0 +1,108 @@
+import { getContractIds } from "./links/zk-bag.mjs";
+import { ZkSendLinkBuilder } from "./links/builder.mjs";
+import { ZkSendLink } from "./links/claim.mjs";
+import { Ed25519Keypair } from "@haneullabs/haneul/keypairs/ed25519";
+import { fromBase64 } from "@haneullabs/haneul/utils";
+
+//#region src/client.ts
+function getDefaultContractIds(clientNetwork) {
+	if (clientNetwork === "mainnet" || clientNetwork === "testnet") return getContractIds(clientNetwork);
+	throw new Error(`zkSend only has built-in contract IDs for mainnet and testnet. For network "${clientNetwork}", you must provide a custom contract option.`);
+}
+var ZkSendClient = class {
+	#client;
+	#network;
+	#host;
+	#path;
+	#claimApi;
+	#contract;
+	constructor(client, options = {}) {
+		this.#client = client;
+		this.#network = client.network;
+		this.#host = options.host ?? "https://my.slush.app";
+		this.#path = options.path ?? "/claim";
+		this.#claimApi = options.claimApi ?? "https://api.slush.app/api";
+		this.#contract = options.contract ?? getDefaultContractIds(client.network);
+	}
+	linkBuilder(options) {
+		return new ZkSendLinkBuilder({
+			client: this.#client,
+			sender: options.sender,
+			keypair: options.keypair,
+			network: this.#network,
+			host: this.#host,
+			path: this.#path,
+			contract: this.#contract
+		});
+	}
+	async createLinks(options) {
+		return ZkSendLinkBuilder.createLinks({
+			links: options.links,
+			transaction: options.transaction,
+			client: this.#client,
+			network: this.#network,
+			contract: this.#contract
+		});
+	}
+	/**
+	* Get a link without loading its assets (synchronous)
+	*/
+	getLink(options) {
+		return new ZkSendLink({
+			client: this.#client,
+			network: this.#network,
+			host: this.#host,
+			path: this.#path,
+			claimApi: this.#claimApi,
+			contract: this.#contract,
+			...options
+		});
+	}
+	/**
+	* Load a link and its assets
+	*/
+	async loadLink(options) {
+		const link = this.getLink(options);
+		await link.loadAssets();
+		return link;
+	}
+	/**
+	* Get a link from a URL without loading assets (synchronous)
+	*/
+	getLinkFromUrl(url) {
+		const parsed = new URL(url);
+		if (!parsed.hash.startsWith("#$")) throw new Error("Invalid link URL");
+		const parsedNetwork = parsed.searchParams.get("network") === "testnet" ? "testnet" : "mainnet";
+		if (parsedNetwork !== this.#network) throw new Error(`Link network "${parsedNetwork}" does not match client network "${this.#network}"`);
+		const keypair = Ed25519Keypair.fromSecretKey(fromBase64(parsed.hash.slice(2)));
+		return new ZkSendLink({
+			client: this.#client,
+			keypair,
+			network: this.#network,
+			host: `${parsed.protocol}//${parsed.host}`,
+			path: parsed.pathname,
+			claimApi: this.#claimApi,
+			contract: this.#contract
+		});
+	}
+	/**
+	* Load a link from a URL and its assets
+	*/
+	async loadLinkFromUrl(url) {
+		const link = this.getLinkFromUrl(url);
+		await link.loadAssets();
+		return link;
+	}
+};
+function zksend({ name = "zksend", ...options } = {}) {
+	return {
+		name,
+		register: (client) => {
+			return new ZkSendClient(client, options);
+		}
+	};
+}
+
+//#endregion
+export { ZkSendClient, zksend };
+//# sourceMappingURL=client.mjs.map

package/dist/client.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.mjs","names":["#client","#network","#host","#path","#claimApi","#contract"],"sources":["../src/client.ts"],"sourcesContent":["// Copyright (c) Mysten Labs, Inc.\n// SPDX-License-Identifier: Apache-2.0\n\nimport type { ClientWithCoreApi, HaneulClientRegistration } from '@haneullabs/haneul/client';\nimport type { Keypair } from '@haneullabs/haneul/cryptography';\nimport { Ed25519Keypair } from '@haneullabs/haneul/keypairs/ed25519';\nimport type { Transaction } from '@haneullabs/haneul/transactions';\nimport { fromBase64 } from '@haneullabs/haneul/utils';\n\nimport { ZkSendLink } from './links/claim.js';\nimport { ZkSendLinkBuilder } from './links/builder.js';\nimport type { ZkBagContractOptions } from './links/zk-bag.js';\nimport { getContractIds } from './links/zk-bag.js';\n\nexport type ZkSendCompatibleClient = ClientWithCoreApi;\n\nexport interface ZkSendOptions<Name extends string = 'zksend'> {\n\tname?: Name;\n\thost?: string;\n\tpath?: string;\n\tclaimApi?: string;\n\tcontract?: ZkBagContractOptions;\n}\n\nexport interface LinkBuilderOptions {\n\tsender: string;\n\tkeypair?: Keypair;\n}\n\nexport type LoadLinkOptions =\n\t| {\n\t\t\taddress: string;\n\t\t\tkeypair?: never;\n\t  }\n\t| {\n\t\t\tkeypair: Keypair;\n\t\t\taddress?: never;\n\t  };\n\nfunction getDefaultContractIds(clientNetwork: string): ZkBagContractOptions {\n\tif (clientNetwork === 'mainnet' || clientNetwork === 'testnet') {\n\t\treturn getContractIds(clientNetwork);\n\t}\n\tthrow new Error(\n\t\t`zkSend only has built-in contract IDs for mainnet and testnet. For network \"${clientNetwork}\", you must provide a custom contract option.`,\n\t);\n}\n\nexport class ZkSendClient {\n\t#client: ZkSendCompatibleClient;\n\t#network: string;\n\t#host: string;\n\t#path: string;\n\t#claimApi: string;\n\t#contract: ZkBagContractOptions;\n\n\tconstructor(client: ZkSendCompatibleClient, options: Omit<ZkSendOptions, 'name'> = {}) {\n\t\tthis.#client = client;\n\t\tthis.#network = client.network;\n\t\tthis.#host = options.host ?? 'https://my.slush.app';\n\t\tthis.#path = options.path ?? '/claim';\n\t\tthis.#claimApi = options.claimApi ?? 'https://api.slush.app/api';\n\t\tthis.#contract = options.contract ?? getDefaultContractIds(client.network);\n\t}\n\n\tlinkBuilder(options: LinkBuilderOptions): ZkSendLinkBuilder {\n\t\treturn new ZkSendLinkBuilder({\n\t\t\tclient: this.#client,\n\t\t\tsender: options.sender,\n\t\t\tkeypair: options.keypair,\n\t\t\tnetwork: this.#network,\n\t\t\thost: this.#host,\n\t\t\tpath: this.#path,\n\t\t\tcontract: this.#contract,\n\t\t});\n\t}\n\n\tasync createLinks(options: {\n\t\tlinks: ZkSendLinkBuilder[];\n\t\ttransaction?: Transaction;\n\t}): Promise<Transaction> {\n\t\treturn ZkSendLinkBuilder.createLinks({\n\t\t\tlinks: options.links,\n\t\t\ttransaction: options.transaction,\n\t\t\tclient: this.#client,\n\t\t\tnetwork: this.#network,\n\t\t\tcontract: this.#contract,\n\t\t});\n\t}\n\n\t/**\n\t * Get a link without loading its assets (synchronous)\n\t */\n\tgetLink(options: LoadLinkOptions): ZkSendLink {\n\t\treturn new ZkSendLink({\n\t\t\tclient: this.#client,\n\t\t\tnetwork: this.#network,\n\t\t\thost: this.#host,\n\t\t\tpath: this.#path,\n\t\t\tclaimApi: this.#claimApi,\n\t\t\tcontract: this.#contract,\n\t\t\t...options,\n\t\t});\n\t}\n\n\t/**\n\t * Load a link and its assets\n\t */\n\tasync loadLink(options: LoadLinkOptions): Promise<ZkSendLink> {\n\t\tconst link = this.getLink(options);\n\t\tawait link.loadAssets();\n\t\treturn link;\n\t}\n\n\t/**\n\t * Get a link from a URL without loading assets (synchronous)\n\t */\n\tgetLinkFromUrl(url: string): ZkSendLink {\n\t\tconst parsed = new URL(url);\n\t\tif (!parsed.hash.startsWith('#$')) {\n\t\t\tthrow new Error('Invalid link URL');\n\t\t}\n\n\t\tconst parsedNetwork = parsed.searchParams.get('network') === 'testnet' ? 'testnet' : 'mainnet';\n\n\t\tif (parsedNetwork !== this.#network) {\n\t\t\tthrow new Error(\n\t\t\t\t`Link network \"${parsedNetwork}\" does not match client network \"${this.#network}\"`,\n\t\t\t);\n\t\t}\n\n\t\tconst keypair = Ed25519Keypair.fromSecretKey(fromBase64(parsed.hash.slice(2)));\n\n\t\treturn new ZkSendLink({\n\t\t\tclient: this.#client,\n\t\t\tkeypair,\n\t\t\tnetwork: this.#network,\n\t\t\thost: `${parsed.protocol}//${parsed.host}`,\n\t\t\tpath: parsed.pathname,\n\t\t\tclaimApi: this.#claimApi,\n\t\t\tcontract: this.#contract,\n\t\t});\n\t}\n\n\t/**\n\t * Load a link from a URL and its assets\n\t */\n\tasync loadLinkFromUrl(url: string): Promise<ZkSendLink> {\n\t\tconst link = this.getLinkFromUrl(url);\n\t\tawait link.loadAssets();\n\t\treturn link;\n\t}\n}\n\nexport function zksend<Name extends string = 'zksend'>({\n\tname = 'zksend' as Name,\n\t...options\n}: ZkSendOptions<Name> = {}): HaneulClientRegistration<ZkSendCompatibleClient, Name, ZkSendClient> {\n\treturn {\n\t\tname,\n\t\tregister: (client) => {\n\t\t\treturn new ZkSendClient(client, options);\n\t\t},\n\t};\n}\n"],"mappings":";;;;;;;AAuCA,SAAS,sBAAsB,eAA6C;AAC3E,KAAI,kBAAkB,aAAa,kBAAkB,UACpD,QAAO,eAAe,cAAc;AAErC,OAAM,IAAI,MACT,+EAA+E,cAAc,+CAC7F;;AAGF,IAAa,eAAb,MAA0B;CACzB;CACA;CACA;CACA;CACA;CACA;CAEA,YAAY,QAAgC,UAAuC,EAAE,EAAE;AACtF,QAAKA,SAAU;AACf,QAAKC,UAAW,OAAO;AACvB,QAAKC,OAAQ,QAAQ,QAAQ;AAC7B,QAAKC,OAAQ,QAAQ,QAAQ;AAC7B,QAAKC,WAAY,QAAQ,YAAY;AACrC,QAAKC,WAAY,QAAQ,YAAY,sBAAsB,OAAO,QAAQ;;CAG3E,YAAY,SAAgD;AAC3D,SAAO,IAAI,kBAAkB;GAC5B,QAAQ,MAAKL;GACb,QAAQ,QAAQ;GAChB,SAAS,QAAQ;GACjB,SAAS,MAAKC;GACd,MAAM,MAAKC;GACX,MAAM,MAAKC;GACX,UAAU,MAAKE;GACf,CAAC;;CAGH,MAAM,YAAY,SAGO;AACxB,SAAO,kBAAkB,YAAY;GACpC,OAAO,QAAQ;GACf,aAAa,QAAQ;GACrB,QAAQ,MAAKL;GACb,SAAS,MAAKC;GACd,UAAU,MAAKI;GACf,CAAC;;;;;CAMH,QAAQ,SAAsC;AAC7C,SAAO,IAAI,WAAW;GACrB,QAAQ,MAAKL;GACb,SAAS,MAAKC;GACd,MAAM,MAAKC;GACX,MAAM,MAAKC;GACX,UAAU,MAAKC;GACf,UAAU,MAAKC;GACf,GAAG;GACH,CAAC;;;;;CAMH,MAAM,SAAS,SAA+C;EAC7D,MAAM,OAAO,KAAK,QAAQ,QAAQ;AAClC,QAAM,KAAK,YAAY;AACvB,SAAO;;;;;CAMR,eAAe,KAAyB;EACvC,MAAM,SAAS,IAAI,IAAI,IAAI;AAC3B,MAAI,CAAC,OAAO,KAAK,WAAW,KAAK,CAChC,OAAM,IAAI,MAAM,mBAAmB;EAGpC,MAAM,gBAAgB,OAAO,aAAa,IAAI,UAAU,KAAK,YAAY,YAAY;AAErF,MAAI,kBAAkB,MAAKJ,QAC1B,OAAM,IAAI,MACT,iBAAiB,cAAc,mCAAmC,MAAKA,QAAS,GAChF;EAGF,MAAM,UAAU,eAAe,cAAc,WAAW,OAAO,KAAK,MAAM,EAAE,CAAC,CAAC;AAE9E,SAAO,IAAI,WAAW;GACrB,QAAQ,MAAKD;GACb;GACA,SAAS,MAAKC;GACd,MAAM,GAAG,OAAO,SAAS,IAAI,OAAO;GACpC,MAAM,OAAO;GACb,UAAU,MAAKG;GACf,UAAU,MAAKC;GACf,CAAC;;;;;CAMH,MAAM,gBAAgB,KAAkC;EACvD,MAAM,OAAO,KAAK,eAAe,IAAI;AACrC,QAAM,KAAK,YAAY;AACvB,SAAO;;;AAIT,SAAgB,OAAuC,EACtD,OAAO,UACP,GAAG,YACqB,EAAE,EAAwE;AAClG,QAAO;EACN;EACA,WAAW,WAAW;AACrB,UAAO,IAAI,aAAa,QAAQ,QAAQ;;EAEzC"}

package/dist/index.d.mts

@@ -0,0 +1,6 @@
+import { MAINNET_CONTRACT_IDS, TESTNET_CONTRACT_IDS, ZkBag, ZkBagContractOptions } from "./links/zk-bag.mjs";
+import { CreateZkSendLinkOptions, ZkSendLinkBuilder, ZkSendLinkBuilderOptions } from "./links/builder.mjs";
+import { isClaimTransaction } from "./links/utils.mjs";
+import { ZkSendLink, ZkSendLinkOptions } from "./links/claim.mjs";
+import { LinkBuilderOptions, LoadLinkOptions, ZkSendClient, ZkSendCompatibleClient, ZkSendOptions, zksend } from "./client.mjs";
+export { type CreateZkSendLinkOptions, type LinkBuilderOptions, type LoadLinkOptions, MAINNET_CONTRACT_IDS, TESTNET_CONTRACT_IDS, ZkBag, type ZkBagContractOptions, ZkSendClient, type ZkSendCompatibleClient, ZkSendLink, ZkSendLinkBuilder, type ZkSendLinkBuilderOptions, type ZkSendLinkOptions, type ZkSendOptions, isClaimTransaction, zksend };

package/dist/index.mjs

@@ -0,0 +1,7 @@
+import { MAINNET_CONTRACT_IDS, TESTNET_CONTRACT_IDS, ZkBag } from "./links/zk-bag.mjs";
+import { ZkSendLinkBuilder } from "./links/builder.mjs";
+import { ZkSendLink } from "./links/claim.mjs";
+import { ZkSendClient, zksend } from "./client.mjs";
+import { isClaimTransaction } from "./links/utils.mjs";
+
+export { MAINNET_CONTRACT_IDS, TESTNET_CONTRACT_IDS, ZkBag, ZkSendClient, ZkSendLink, ZkSendLinkBuilder, isClaimTransaction, zksend };

package/dist/links/builder.d.mts

@@ -0,0 +1,83 @@
+import { ZkBagContractOptions } from "./zk-bag.mjs";
+import { Transaction, TransactionObjectArgument } from "@haneullabs/haneul/transactions";
+import { Keypair, Signer } from "@haneullabs/haneul/cryptography";
+import { ClientWithCoreApi, HaneulClientTypes } from "@haneullabs/haneul/client";
+
+//#region src/links/builder.d.ts
+interface ZkSendLinkBuilderOptions {
+  host?: string;
+  path?: string;
+  keypair?: Keypair;
+  network?: string;
+  client: ClientWithCoreApi;
+  sender: string;
+  contract?: ZkBagContractOptions;
+}
+interface CreateZkSendLinkOptions {
+  transaction?: Transaction;
+}
+declare class ZkSendLinkBuilder {
+  #private;
+  objectIds: Set<string>;
+  objectRefs: {
+    ref: TransactionObjectArgument;
+    type: string;
+  }[];
+  balances: Map<string, bigint>;
+  sender: string;
+  network: string;
+  keypair: Keypair;
+  constructor({
+    host,
+    path,
+    keypair,
+    network,
+    client,
+    sender,
+    contract
+  }: ZkSendLinkBuilderOptions);
+  addClaimableMist(amount: bigint): void;
+  addClaimableBalance(coinType: string, amount: bigint): void;
+  addClaimableObject(id: string): void;
+  addClaimableObjectRef(ref: TransactionObjectArgument, type: string): void;
+  getLink(): string;
+  create({
+    signer,
+    ...options
+  }: CreateZkSendLinkOptions & {
+    signer: Signer;
+    waitForTransaction?: boolean;
+  }): Promise<{
+    $kind: "Transaction";
+    Transaction: HaneulClientTypes.Transaction<{
+      transaction: true;
+      effects: true;
+    }>;
+    FailedTransaction?: never;
+  }>;
+  createSendTransaction({
+    transaction
+  }?: CreateZkSendLinkOptions): Promise<Transaction>;
+  createSendToAddressTransaction({
+    transaction,
+    address
+  }: CreateZkSendLinkOptions & {
+    address: string;
+  }): Promise<Transaction>;
+  static createLinks({
+    links,
+    network,
+    client,
+    transaction,
+    contract: contractIds
+  }: {
+    transaction?: Transaction;
+    client: ClientWithCoreApi;
+    network?: string;
+    links: ZkSendLinkBuilder[];
+    contract?: ZkBagContractOptions;
+  }): Promise<Transaction>;
+}
+//#endregion
+export { CreateZkSendLinkOptions, ZkSendLinkBuilder, ZkSendLinkBuilderOptions };
+//# sourceMappingURL=builder.d.mts.map

package/dist/links/builder.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"builder.d.mts","names":[],"sources":["../../src/links/builder.ts"],"sourcesContent":[],"mappings":";;;;;;UAciB,wBAAA;EAAA,IAAA,CAAA,EAAA,MAAA;EAGN,IAAA,CAAA,EAAA,MAAA;EAEF,OAAA,CAAA,EAFE,OAEF;EAEG,OAAA,CAAA,EAAA,MAAA;EAAoB,MAAA,EAFvB,iBAEuB;EAWf,MAAA,EAAA,MAAA;EAIJ,QAAA,CAAA,EAfD,oBAekB;;AAGvB,UAPU,uBAAA,CAOV;EAGE,WAAA,CAAA,EATM,WASN;;AAWP,cAjBW,iBAAA,CAiBX;EACA,CAAA,OAAA;EACA,SAAA,EAlBQ,GAkBR,CAAA,MAAA,CAAA;EACA,UAAA,EAAA;IACA,GAAA,EAlBK,yBAkBL;IACA,IAAA,EAAA,MAAA;EACA,CAAA,EAAA;EACE,QAAA,EAlBK,GAkBL,CAAA,MAAA,EAAA,MAAA,CAAA;EA0BwB,MAAA,EAAA,MAAA;EAkB1B,OAAA,EAAA,MAAA;EAEE,OAAA,EA3DM,OA2DN;EACM,WAAA,CAAA;IAAA,IAAA;IAAA,IAAA;IAAA,OAAA;IAAA,OAAA;IAAA,MAAA;IAAA,MAAA;IAAA;EAAA,CAAA,EA/CN,wBA+CM;;EAER,mBAAA,CAAA,QAAA,EAAA,MAAA,EAAA,MAAA,EAAA,MAAA,CAAA,EAAA,IAAA;EAoB6B,kBAAA,CAAA,EAAA,EAAA,MAAA,CAAA,EAAA,IAAA;EAAmC,qBAAA,CAAA,GAAA,EA3CtC,yBA2CsC,EAAA,IAAA,EAAA,MAAA,CAAA,EAAA,IAAA;EAA4B,OAAA,CAAA,CAAA,EAAA,MAAA;EAAA,MAAA,CAAA;IAAA,MAAA;IAAA,GAAA;EAe1F,CAf0F,EAvB1F,uBAuB0F,GAAA;IAa5F,MAAA,EAnCQ,MAmCR;IACA,kBAAA,CAAA,EAAA,OAAA;EACE,CAAA,CAAA,EAnCF,OAmCE,CAAA;IAEF,KAAA,EAAA,aAAA;IAAA,WAAA,+BAAA,CAAA;MAyEA,WAAA,EAAA,IAAA;MACA,OAAA,EAAA,IAAA;IACA,CAAA,CAAA;IACA,iBAAA,CAAA,EAAA,KAAA;EACU,CAAA,CAAA;EAEI,qBAAA,CAAA;IAAA;EAAA,CAAA,CAAA,EAhGkD,uBAgGlD,CAAA,EAhG8E,OAgG9E,CAhG8E,WAgG9E,CAAA;EACN,8BAAA,CAAA;IAAA,WAAA;IAAA;EAGG,CAHH,EAlFN,uBAkFM,GAAA;IAED,OAAA,EAAA,MAAA;EACI,CAAA,CAAA,EAnFX,OAmFW,CAnFX,WAmFW,CAAA;EACX,OAAA,WAAA,CAAA;IAAA,KAAA;IAAA,OAAA;IAAA,MAAA;IAAA,WAAA;IAAA,QAAA,EAPU;GAOV,EAAA;IAAA,WAAA,CAAA,EALc,WAKd;IAAA,MAAA,EAJQ,iBAIR;;WAFO;eACI;MACX,QAAA"}