@haneullabs/haneul 0.1.0 → 2.5.0

package/README.md

@@ -1,13 +1,12 @@
 # Docs site
 
-For more complete docs, visit the [Sui TypeScript SDK docs](https://sdk.haneullabs.com/)
+For more complete docs, visit the [Haneul TypeScript SDK docs](https://sdk.haneul-labs.com/)
 
-# Sui TypeScript SDK
+# Haneul TypeScript SDK
 
-This is the Haneul TypeScript SDK built on the Haneul
-[JSON RPC API](https://github.com/GeunhwaJeong/haneul/blob/main/docs/content/references/sui-api.mdx). It
-provides utility classes and functions for applications to sign transactions and interact with the
-Haneul network.
+This is the Haneul TypeScript SDK providing utility classes and functions for applications to sign
+transactions and interact with the Haneul network. It supports multiple communication protocols
+including gRPC (recommended), GraphQL, and JSON RPC (deprecated).
 
 ## Building Locally
 
@@ -17,10 +16,10 @@ To get started you need to install [pnpm](https://pnpm.io/), then run the follow
 # Install all dependencies
 $ pnpm install
 
-# Run `build` for the TypeScript SDK if you're in the `sdk/typescript` project
+# Run `build` for the TypeScript SDK if you're in the `sdk/haneul` project
 $ pnpm run build
 
-# Run `sdk build` for the TypeScript SDK if you're in the root of `sui` repo
+# Run `sdk build` for the TypeScript SDK if you're in the root of `haneul` repo
 $ pnpm sdk build
 ```
 
@@ -30,7 +29,7 @@ $ pnpm sdk build
 
 You can view the generated [Type Doc](https://typedoc.org/) for the
 [current release of the SDK](https://www.npmjs.com/package/@haneullabs/haneul) at
-http://typescript-sdk-docs.s3-website-us-east-1.amazonaws.com/.
+https://sdk.haneul-labs.com/typedoc/index.html.
 
 For the latest docs for the `main` branch, run `pnpm doc` and open the
 [doc/index.html](doc/index.html) in your browser.
@@ -68,24 +67,29 @@ https://stackoverflow.com/questions/52676244/node-version-not-updating-after-nvm
 To run E2E tests against Devnet
 
 ```
-VITE_FAUCET_URL='https://faucet.devnet.sui.io:443/v2/gas' VITE_FULLNODE_URL='https://fullnode.devnet.sui.io' pnpm --filter @haneullabs/haneul exec vitest e2e
+VITE_FAUCET_URL='https://faucet.devnet.haneul.io:443/v2/gas' VITE_FULLNODE_URL='https://fullnode.devnet.haneul.io' pnpm --filter @haneullabs/haneul exec vitest e2e
 ```
 
-## Connecting to Sui Network
+## Connecting to Haneul Network
 
-The `HaneulClient` class provides a connection to the JSON-RPC Server and should be used for all
-read-only operations. The default URLs to connect with the RPC server are:
+The `SuiGrpcClient` class provides a connection to the Haneul network via gRPC and is the recommended
+client for all operations. The default URLs to connect with the gRPC server are:
 
 - local: http://127.0.0.1:9000
-- Devnet: https://fullnode.devnet.sui.io
+- Devnet: https://fullnode.devnet.haneul.io:443
+- Testnet: https://fullnode.testnet.haneul.io:443
+- Mainnet: https://fullnode.mainnet.haneul.io:443
 
 ```typescript
-import { getFullnodeUrl, HaneulClient } from '@haneullabs/haneul/client';
+import { SuiGrpcClient } from '@haneullabs/haneul/grpc';
 
 // create a client connected to devnet
-const client = new HaneulClient({ url: getFullnodeUrl('devnet') });
+const client = new SuiGrpcClient({
+	network: 'devnet',
+	baseUrl: 'https://fullnode.devnet.haneul.io:443',
+});
 
-// get coins owned by an address
+// get coins owned by an address using the Core API
 await client.getCoins({
 	owner: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
 });
@@ -93,31 +97,35 @@ await client.getCoins({
 
 For local development, you can run `cargo run --bin --with-faucet --force-regenesis` to spin up a
 local network with a local validator, a fullnode, and a faucet server. Refer to
-[this guide](https://docs.sui.io/build/sui-local-network) for more information.
+[this guide](https://docs.haneul.io/build/haneul-local-network) for more information.
 
 ```typescript
-import { getFullnodeUrl, HaneulClient } from '@haneullabs/haneul/client';
+import { SuiGrpcClient } from '@haneullabs/haneul/grpc';
 
-// create a client connected to devnet
-const client = new HaneulClient({ url: getFullnodeUrl('localnet') });
+// create a client connected to localnet
+const client = new SuiGrpcClient({
+	network: 'localnet',
+	baseUrl: 'http://127.0.0.1:9000',
+});
 
-// get coins owned by an address
+// get coins owned by an address using the Core API
 await client.getCoins({
 	owner: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
 });
 ```
 
-You can also construct your own in custom connections, with the URL for your own fullnode
+You can also construct your own SuiGrpcClient connections with the URL for your own fullnode:
 
 ```typescript
-import { getFullnodeUrl, HaneulClient } from '@haneullabs/haneul/client';
+import { SuiGrpcClient } from '@haneullabs/haneul/grpc';
 
-// create a client connected to devnet
-const client = new HaneulClient({
-	url: 'https://fullnode.devnet.sui.io',
+// create a client connected to your own fullnode
+const client = new SuiGrpcClient({
+	network: 'devnet',
+	baseUrl: 'https://your-fullnode.example.com:443',
 });
 
-// get coins owned by an address
+// get coins owned by an address using the Core API
 await client.getCoins({
 	owner: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
 });
@@ -125,8 +133,8 @@ await client.getCoins({
 
 ## Getting coins from the faucet
 
-You can request sui from the faucet when running against devnet or localnet. For testnet, visit
-faucet.sui.io.
+You can request haneul from the faucet when running against devnet or localnet. For testnet, visit
+faucet.haneul.io.
 
 ```typescript
 import { getFaucetHost, requestSuiFromFaucetV2 } from '@haneullabs/haneul/faucet';
@@ -140,19 +148,20 @@ await requestSuiFromFaucetV2({
 ## Writing APIs
 
 For a primer for building transactions, refer to
-[this guide](https://docs.sui.io/build/prog-trans-ts-sdk).
+[this guide](https://docs.haneul.io/build/prog-trans-ts-sdk).
 
 ### Transfer Object
 
 ```typescript
-import { getFullnodeUrl, HaneulClient } from '@haneullabs/haneul/client';
+import { SuiGrpcClient } from '@haneullabs/haneul/grpc';
 import { Ed25519Keypair } from '@haneullabs/haneul/keypairs/ed25519';
 import { Transaction } from '@haneullabs/haneul/transactions';
 
 // Generate a new Ed25519 Keypair
 const keypair = new Ed25519Keypair();
-const client = new HaneulClient({
-	url: getFullnodeUrl('testnet'),
+const client = new SuiGrpcClient({
+	network: 'testnet',
+	baseUrl: 'https://fullnode.testnet.haneul.io:443',
 });
 
 const tx = new Transaction();
@@ -167,24 +176,25 @@ const result = await client.signAndExecuteTransaction({
 console.log({ result });
 ```
 
-### Transfer Sui
+### Transfer Haneul
 
-To transfer `1000` MIST to another address:
+To transfer `1000` GEUNHWA to another address:
 
 ```typescript
-import { getFullnodeUrl, HaneulClient } from '@haneullabs/haneul/client';
+import { SuiGrpcClient } from '@haneullabs/haneul/grpc';
 import { Ed25519Keypair } from '@haneullabs/haneul/keypairs/ed25519';
 import { Transaction } from '@haneullabs/haneul/transactions';
 
 // Generate a new Ed25519 Keypair
 const keypair = new Ed25519Keypair();
-const client = new HaneulClient({
-	url: getFullnodeUrl('testnet'),
+const client = new SuiGrpcClient({
+	network: 'testnet',
+	baseUrl: 'https://fullnode.testnet.haneul.io:443',
 });
 
 const tx = new Transaction();
 const [coin] = tx.splitCoins(tx.gas, [1000]);
-tx.transferObjects([coin], keypair.getPublicKey().toHaneulAddress());
+tx.transferObjects([coin], keypair.getPublicKey().toSuiAddress());
 const result = await client.signAndExecuteTransaction({
 	signer: keypair,
 	transaction: tx,
@@ -195,14 +205,15 @@ console.log({ result });
 ### Merge coins
 
 ```typescript
-import { getFullnodeUrl, HaneulClient } from '@haneullabs/haneul/client';
+import { SuiGrpcClient } from '@haneullabs/haneul/grpc';
 import { Ed25519Keypair } from '@haneullabs/haneul/keypairs/ed25519';
 import { Transaction } from '@haneullabs/haneul/transactions';
 
 // Generate a new Ed25519 Keypair
 const keypair = new Ed25519Keypair();
-const client = new HaneulClient({
-	url: getFullnodeUrl('testnet'),
+const client = new SuiGrpcClient({
+	network: 'testnet',
+	baseUrl: 'https://fullnode.testnet.haneul.io:443',
 });
 
 const tx = new Transaction();
@@ -219,15 +230,17 @@ console.log({ result });
 ### Move Call
 
 ```typescript
-import { getFullnodeUrl, HaneulClient } from '@haneullabs/haneul/client';
+import { SuiGrpcClient } from '@haneullabs/haneul/grpc';
 import { Ed25519Keypair } from '@haneullabs/haneul/keypairs/ed25519';
 import { Transaction } from '@haneullabs/haneul/transactions';
 
 // Generate a new Ed25519 Keypair
 const keypair = new Ed25519Keypair();
-const client = new HaneulClient({
-	url: getFullnodeUrl('testnet'),
+const client = new SuiGrpcClient({
+	network: 'testnet',
+	baseUrl: 'https://fullnode.testnet.haneul.io:443',
 });
+
 const packageObjectId = '0x...';
 const tx = new Transaction();
 tx.moveCall({
@@ -246,16 +259,18 @@ console.log({ result });
 To publish a package:
 
 ```typescript
-import { getFullnodeUrl, HaneulClient } from '@haneullabs/haneul/client';
+import { SuiGrpcClient } from '@haneullabs/haneul/grpc';
 import { Ed25519Keypair } from '@haneullabs/haneul/keypairs/ed25519';
 import { Transaction } from '@haneullabs/haneul/transactions';
+import { execSync } from 'child_process';
 
-const { execSync } = require('child_process');
 // Generate a new Ed25519 Keypair
 const keypair = new Ed25519Keypair();
-const client = new HaneulClient({
-	url: getFullnodeUrl('testnet'),
+const client = new SuiGrpcClient({
+	network: 'testnet',
+	baseUrl: 'https://fullnode.testnet.haneul.io:443',
 });
+
 const { modules, dependencies } = JSON.parse(
 	execSync(`${cliPath} move build --dump-bytecode-as-base64 --path ${packagePath}`, {
 		encoding: 'utf-8',
@@ -266,7 +281,7 @@ const [upgradeCap] = tx.publish({
 	modules,
 	dependencies,
 });
-tx.transferObjects([upgradeCap], keypair.toHaneulAddress());
+tx.transferObjects([upgradeCap], keypair.toSuiAddress());
 const result = await client.signAndExecuteTransaction({
 	signer: keypair,
 	transaction: tx,
@@ -282,11 +297,13 @@ Fetch objects owned by the address
 `0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231`
 
 ```typescript
-import { getFullnodeUrl, HaneulClient } from '@haneullabs/haneul/client';
+import { SuiGrpcClient } from '@haneullabs/haneul/grpc';
 
-const client = new HaneulClient({
-	url: getFullnodeUrl('testnet'),
+const client = new SuiGrpcClient({
+	network: 'testnet',
+	baseUrl: 'https://fullnode.testnet.haneul.io:443',
 });
+
 const objects = await client.getOwnedObjects({
 	owner: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
 });
@@ -298,18 +315,21 @@ Fetch object details for the object with id
 `0xe19739da1a701eadc21683c5b127e62b553e833e8a15a4f292f4f48b4afea3f2`
 
 ```typescript
-import { getFullnodeUrl, HaneulClient } from '@haneullabs/haneul/client';
+import { SuiGrpcClient } from '@haneullabs/haneul/grpc';
 
-const client = new HaneulClient({
-	url: getFullnodeUrl('testnet'),
+const client = new SuiGrpcClient({
+	network: 'testnet',
+	baseUrl: 'https://fullnode.testnet.haneul.io:443',
 });
-const txn = await client.getObject({
+
+const object = await client.getObject({
 	id: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
 	// fetch the object content field
 	options: { showContent: true },
 });
+
 // You can also fetch multiple objects in one batch request
-const txns = await client.multiGetObjects({
+const objects = await client.multiGetObjects({
 	ids: [
 		'0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
 		'0x9ad3de788483877fe348aef7f6ba3e52b9cfee5f52de0694d36b16a6b50c1429',
@@ -324,11 +344,13 @@ const txns = await client.multiGetObjects({
 Fetch transaction details from transaction digests:
 
 ```typescript
-import { getFullnodeUrl, HaneulClient } from '@haneullabs/haneul/client';
+import { SuiGrpcClient } from '@haneullabs/haneul/grpc';
 
-const client = new HaneulClient({
-	url: getFullnodeUrl('testnet'),
+const client = new SuiGrpcClient({
+	network: 'testnet',
+	baseUrl: 'https://fullnode.testnet.haneul.io:443',
 });
+
 const txn = await client.getTransactionBlock({
 	digest: '9XFneskU8tW7UxQf7tE5qFRfcN4FadtC2Z3HAZkgeETd=',
 	// only fetch the effects field
@@ -392,11 +414,13 @@ Fetch coins of type `0x65b0553a591d7b13376e03a408e112c706dc0909a79080c810b93b06f
 owned by an address:
 
 ```typescript
-import { getFullnodeUrl, HaneulClient } from '@haneullabs/haneul/client';
+import { SuiGrpcClient } from '@haneullabs/haneul/grpc';
 
-const client = new HaneulClient({
-	url: getFullnodeUrl('testnet'),
+const client = new SuiGrpcClient({
+	network: 'testnet',
+	baseUrl: 'https://fullnode.testnet.haneul.io:443',
 });
+
 const coins = await client.getCoins({
 	owner: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
 	coinType: '0x65b0553a591d7b13376e03a408e112c706dc0909a79080c810b93b06f922c458::usdc::USDC',
@@ -406,24 +430,28 @@ const coins = await client.getCoins({
 Fetch all coin objects owned by an address:
 
 ```typescript
-import { getFullnodeUrl, HaneulClient } from '@haneullabs/haneul/client';
+import { SuiGrpcClient } from '@haneullabs/haneul/grpc';
 
-const client = new HaneulClient({
-	url: getFullnodeUrl('testnet'),
+const client = new SuiGrpcClient({
+	network: 'testnet',
+	baseUrl: 'https://fullnode.testnet.haneul.io:443',
 });
+
 const allCoins = await client.getAllCoins({
 	owner: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
 });
 ```
 
-Fetch the total coin balance for one coin type, owned by an address:
+Fetch the total coin balance for a coin type, owned by an address:
 
 ```typescript
-import { getFullnodeUrl, HaneulClient } from '@haneullabs/haneul/client';
+import { SuiGrpcClient } from '@haneullabs/haneul/grpc';
 
-const client = new HaneulClient({
-	url: getFullnodeUrl('testnet'),
+const client = new SuiGrpcClient({
+	network: 'testnet',
+	baseUrl: 'https://fullnode.testnet.haneul.io:443',
 });
+
 // If coin type is not specified, it defaults to 0x2::haneul::HANEUL
 const coinBalance = await client.getBalance({
 	owner: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
@@ -437,13 +465,15 @@ Querying events created by transactions sent by account
 `0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231`
 
 ```typescript
-import { getFullnodeUrl, HaneulClient } from '@haneullabs/haneul/client';
+import { SuiGrpcClient } from '@haneullabs/haneul/grpc';
 
-const client = new HaneulClient({
-	url: getFullnodeUrl('testnet'),
+const client = new SuiGrpcClient({
+	network: 'testnet',
+	baseUrl: 'https://fullnode.testnet.haneul.io:443',
 });
-const events = client.queryEvents({
-	query: { Sender: toolbox.address() },
+
+const events = await client.queryEvents({
+	query: { Sender: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231' },
 	limit: 2,
 });
 ```

package/dist/_virtual/rolldown_runtime.mjs

@@ -0,0 +1,18 @@
+//#region rolldown:runtime
+var __defProp = Object.defineProperty;
+var __exportAll = (all, symbols) => {
+	let target = {};
+	for (var name in all) {
+		__defProp(target, name, {
+			get: all[name],
+			enumerable: true
+		});
+	}
+	if (symbols) {
+		__defProp(target, Symbol.toStringTag, { value: "Module" });
+	}
+	return target;
+};
+
+//#endregion
+export { __exportAll };

package/dist/bcs/bcs.d.mts

@@ -0,0 +1,27 @@
+import { TypeTag as TypeTag$1 } from "./types.mjs";
+import * as _haneullabs_bcs823 from "@haneullabs/bcs";
+import { BcsType } from "@haneullabs/bcs";
+
+//#region src/bcs/bcs.d.ts
+
+declare const TypeTag: BcsType<string, string | TypeTag$1, string>;
+declare function IntentMessage<T extends BcsType<any>>(T: T): _haneullabs_bcs823.BcsStruct<{
+  intent: _haneullabs_bcs823.BcsStruct<{
+    scope: _haneullabs_bcs823.BcsEnum<{
+      TransactionData: null;
+      TransactionEffects: null;
+      CheckpointSummary: null;
+      PersonalMessage: null;
+    }, "IntentScope">;
+    version: _haneullabs_bcs823.BcsEnum<{
+      V0: null;
+    }, "IntentVersion">;
+    appId: _haneullabs_bcs823.BcsEnum<{
+      Haneul: null;
+    }, "AppId">;
+  }, string>;
+  value: T;
+}, string>;
+//#endregion
+export { IntentMessage, TypeTag };
+//# sourceMappingURL=bcs.d.mts.map

package/dist/bcs/bcs.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bcs.d.mts","names":[],"sources":["../../src/bcs/bcs.ts"],"sourcesContent":[],"mappings":";;;;;;cAoIa,SAAO,yBAAA;iBAuKJ,wBAAwB,iBAAiB,uBAAC;;WAAA,kBAAA,CAAA"}