@mysten/sui
Version:
Sui TypeScript API
480 lines (371 loc) • 13.3 kB
Markdown
# Docs site
For more complete docs, visit the [Sui TypeScript SDK docs](https://sdk.mystenlabs.com/)
# Sui TypeScript SDK
This is the Sui TypeScript SDK providing utility classes and functions for applications to sign
transactions and interact with the Sui network. It supports multiple communication protocols
including gRPC (recommended), GraphQL, and JSON RPC (deprecated).
## Building Locally
To get started you need to install [pnpm](https://pnpm.io/), then run the following command:
```bash
# Install all dependencies
$ pnpm install
# Run `build` for the TypeScript SDK if you're in the `sdk/sui` project
$ pnpm run build
# Run `sdk build` for the TypeScript SDK if you're in the root of `sui` repo
$ pnpm sdk build
```
> All `pnpm` commands below are intended to be run in the root of the Sui repo.
## Type Doc
You can view the generated [Type Doc](https://typedoc.org/) for the
[current release of the SDK](https://www.npmjs.com/package/@mysten/sui) at
https://sdk.mystenlabs.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.
## Testing
To run unit tests
```
pnpm --filter @mysten/sui test:unit
```
To run E2E tests against local network
```
pnpm --filter @mysten/sui prepare:e2e
// This will run all e2e tests
pnpm --filter @mysten/sui test:e2e
// Alternatively you can choose to run only one test file
npx vitest txn-builder.test.ts
```
Troubleshooting:
If you see errors like `ECONNRESET or "socket hang up"`, run `node -v` to make sure your node
version is `v18.x.x`. Refer to this
[guide](https://blog.logrocket.com/how-switch-node-js-versions-nvm/) to switch node version.
Some more follow up here is if you used homebrew to install node, there could be multiple paths to
node on your machine.
https://stackoverflow.com/questions/52676244/node-version-not-updating-after-nvm-use-on-mac
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 @mysten/sui exec vitest e2e
```
## Connecting to Sui Network
The `SuiGrpcClient` class provides a connection to the Sui 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:443
- Testnet: https://fullnode.testnet.sui.io:443
- Mainnet: https://fullnode.mainnet.sui.io:443
```typescript
import { SuiGrpcClient } from '@mysten/sui/grpc';
// create a client connected to devnet
const client = new SuiGrpcClient({
network: 'devnet',
baseUrl: 'https://fullnode.devnet.sui.io:443',
});
// get coins owned by an address using the Core API
await client.getCoins({
owner: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
});
```
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.
```typescript
import { SuiGrpcClient } from '@mysten/sui/grpc';
// 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 using the Core API
await client.getCoins({
owner: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
});
```
You can also construct your own SuiGrpcClient connections with the URL for your own fullnode:
```typescript
import { SuiGrpcClient } from '@mysten/sui/grpc';
// 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 using the Core API
await client.getCoins({
owner: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
});
```
## Getting coins from the faucet
You can request sui from the faucet when running against devnet or localnet. For testnet, visit
faucet.sui.io.
```typescript
import { getFaucetHost, requestSuiFromFaucetV2 } from '@mysten/sui/faucet';
await requestSuiFromFaucetV2({
host: getFaucetHost('devnet'),
recipient: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
});
```
## Writing APIs
For a primer for building transactions, refer to
[this guide](https://docs.sui.io/build/prog-trans-ts-sdk).
### Transfer Object
```typescript
import { SuiGrpcClient } from '@mysten/sui/grpc';
import { Ed25519Keypair } from '@mysten/sui/keypairs/ed25519';
import { Transaction } from '@mysten/sui/transactions';
// Generate a new Ed25519 Keypair
const keypair = new Ed25519Keypair();
const client = new SuiGrpcClient({
network: 'testnet',
baseUrl: 'https://fullnode.testnet.sui.io:443',
});
const tx = new Transaction();
tx.transferObjects(
['0xe19739da1a701eadc21683c5b127e62b553e833e8a15a4f292f4f48b4afea3f2'],
'0x1d20dcdb2bca4f508ea9613994683eb4e76e9c4ed371169677c1be02aaf0b12a',
);
const result = await client.signAndExecuteTransaction({
signer: keypair,
transaction: tx,
});
console.log({ result });
```
### Transfer Sui
To transfer `1000` MIST to another address:
```typescript
import { SuiGrpcClient } from '@mysten/sui/grpc';
import { Ed25519Keypair } from '@mysten/sui/keypairs/ed25519';
import { Transaction } from '@mysten/sui/transactions';
// Generate a new Ed25519 Keypair
const keypair = new Ed25519Keypair();
const client = new SuiGrpcClient({
network: 'testnet',
baseUrl: 'https://fullnode.testnet.sui.io:443',
});
const tx = new Transaction();
const [coin] = tx.splitCoins(tx.gas, [1000]);
tx.transferObjects([coin], keypair.getPublicKey().toSuiAddress());
const result = await client.signAndExecuteTransaction({
signer: keypair,
transaction: tx,
});
console.log({ result });
```
### Merge coins
```typescript
import { SuiGrpcClient } from '@mysten/sui/grpc';
import { Ed25519Keypair } from '@mysten/sui/keypairs/ed25519';
import { Transaction } from '@mysten/sui/transactions';
// Generate a new Ed25519 Keypair
const keypair = new Ed25519Keypair();
const client = new SuiGrpcClient({
network: 'testnet',
baseUrl: 'https://fullnode.testnet.sui.io:443',
});
const tx = new Transaction();
tx.mergeCoins('0xe19739da1a701eadc21683c5b127e62b553e833e8a15a4f292f4f48b4afea3f2', [
'0x127a8975134a4824d9288722c4ee4fc824cd22502ab4ad9f6617f3ba19229c1b',
]);
const result = await client.signAndExecuteTransaction({
signer: keypair,
transaction: tx,
});
console.log({ result });
```
### Move Call
```typescript
import { SuiGrpcClient } from '@mysten/sui/grpc';
import { Ed25519Keypair } from '@mysten/sui/keypairs/ed25519';
import { Transaction } from '@mysten/sui/transactions';
// Generate a new Ed25519 Keypair
const keypair = new Ed25519Keypair();
const client = new SuiGrpcClient({
network: 'testnet',
baseUrl: 'https://fullnode.testnet.sui.io:443',
});
const packageObjectId = '0x...';
const tx = new Transaction();
tx.moveCall({
target: `${packageObjectId}::nft::mint`,
arguments: [tx.pure.string('Example NFT')],
});
const result = await client.signAndExecuteTransaction({
signer: keypair,
transaction: tx,
});
console.log({ result });
```
### Publish Modules
To publish a package:
```typescript
import { SuiGrpcClient } from '@mysten/sui/grpc';
import { Ed25519Keypair } from '@mysten/sui/keypairs/ed25519';
import { Transaction } from '@mysten/sui/transactions';
import { execSync } from 'child_process';
// Generate a new Ed25519 Keypair
const keypair = new Ed25519Keypair();
const client = new SuiGrpcClient({
network: 'testnet',
baseUrl: 'https://fullnode.testnet.sui.io:443',
});
const { modules, dependencies } = JSON.parse(
execSync(`${cliPath} move build --dump-bytecode-as-base64 --path ${packagePath}`, {
encoding: 'utf-8',
}),
);
const tx = new Transaction();
const [upgradeCap] = tx.publish({
modules,
dependencies,
});
tx.transferObjects([upgradeCap], keypair.toSuiAddress());
const result = await client.signAndExecuteTransaction({
signer: keypair,
transaction: tx,
});
console.log({ result });
```
## Reading APIs
### Get Owned Objects
Fetch objects owned by the address
`0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231`
```typescript
import { SuiGrpcClient } from '@mysten/sui/grpc';
const client = new SuiGrpcClient({
network: 'testnet',
baseUrl: 'https://fullnode.testnet.sui.io:443',
});
const objects = await client.getOwnedObjects({
owner: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
});
```
### Get Object
Fetch object details for the object with id
`0xe19739da1a701eadc21683c5b127e62b553e833e8a15a4f292f4f48b4afea3f2`
```typescript
import { SuiGrpcClient } from '@mysten/sui/grpc';
const client = new SuiGrpcClient({
network: 'testnet',
baseUrl: 'https://fullnode.testnet.sui.io:443',
});
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 objects = await client.multiGetObjects({
ids: [
'0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
'0x9ad3de788483877fe348aef7f6ba3e52b9cfee5f52de0694d36b16a6b50c1429',
],
// only fetch the object type
options: { showType: true },
});
```
### Get Transaction
Fetch transaction details from transaction digests:
```typescript
import { SuiGrpcClient } from '@mysten/sui/grpc';
const client = new SuiGrpcClient({
network: 'testnet',
baseUrl: 'https://fullnode.testnet.sui.io:443',
});
const txn = await client.getTransactionBlock({
digest: '9XFneskU8tW7UxQf7tE5qFRfcN4FadtC2Z3HAZkgeETd=',
// only fetch the effects field
options: {
showEffects: true,
showInput: false,
showEvents: false,
showObjectChanges: false,
showBalanceChanges: false,
},
});
// You can also fetch multiple transactions in one batch request
const txns = await client.multiGetTransactionBlocks({
digests: [
'9XFneskU8tW7UxQf7tE5qFRfcN4FadtC2Z3HAZkgeETd=',
'17mn5W1CczLwitHCO9OIUbqirNrQ0cuKdyxaNe16SAME=',
],
// fetch both the input transaction data as well as effects
options: { showInput: true, showEffects: true },
});
```
### Get Checkpoints
Get latest 100 Checkpoints in descending order and print Transaction Digests for each one of them.
```typescript
client.getCheckpoints({ descendingOrder: true }).then(function (checkpointPage: CheckpointPage) {
console.log(checkpointPage);
checkpointPage.data.forEach((checkpoint) => {
console.log('---------------------------------------------------------------');
console.log(
' ----------- Transactions for Checkpoint: ',
checkpoint.sequenceNumber,
' -------- ',
);
console.log('---------------------------------------------------------------');
checkpoint.transactions.forEach((tx) => {
console.log(tx);
});
console.log('***************************************************************');
});
});
```
Get Checkpoint 1994010 and print details.
```typescript
client.getCheckpoint({ id: '1994010' }).then(function (checkpoint: Checkpoint) {
console.log('Checkpoint Sequence Num ', checkpoint.sequenceNumber);
console.log('Checkpoint timestampMs ', checkpoint.timestampMs);
console.log('Checkpoint # of Transactions ', checkpoint.transactions.length);
});
```
### Get Coins
Fetch coins of type `0x65b0553a591d7b13376e03a408e112c706dc0909a79080c810b93b06f922c458::usdc::USDC`
owned by an address:
```typescript
import { SuiGrpcClient } from '@mysten/sui/grpc';
const client = new SuiGrpcClient({
network: 'testnet',
baseUrl: 'https://fullnode.testnet.sui.io:443',
});
const coins = await client.getCoins({
owner: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
coinType: '0x65b0553a591d7b13376e03a408e112c706dc0909a79080c810b93b06f922c458::usdc::USDC',
});
```
Fetch all coin objects owned by an address:
```typescript
import { SuiGrpcClient } from '@mysten/sui/grpc';
const client = new SuiGrpcClient({
network: 'testnet',
baseUrl: 'https://fullnode.testnet.sui.io:443',
});
const allCoins = await client.getAllCoins({
owner: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
});
```
Fetch the total coin balance for a coin type, owned by an address:
```typescript
import { SuiGrpcClient } from '@mysten/sui/grpc';
const client = new SuiGrpcClient({
network: 'testnet',
baseUrl: 'https://fullnode.testnet.sui.io:443',
});
// If coin type is not specified, it defaults to 0x2::sui::SUI
const coinBalance = await client.getBalance({
owner: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231',
coinType: '0x65b0553a591d7b13376e03a408e112c706dc0909a79080c810b93b06f922c458::usdc::USDC',
});
```
### Events API
Querying events created by transactions sent by account
`0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231`
```typescript
import { SuiGrpcClient } from '@mysten/sui/grpc';
const client = new SuiGrpcClient({
network: 'testnet',
baseUrl: 'https://fullnode.testnet.sui.io:443',
});
const events = await client.queryEvents({
query: { Sender: '0xcc2bd176a478baea9a0de7a24cd927661cc6e860d5bacecb9a138ef20dbab231' },
limit: 2,
});
```