@mysten/sui 2.16.3 → 2.18.0

package/docs/transaction-building/gas.md

@@ -1,61 +0,0 @@
-# Paying for Sui Transactions with Gas Coins
-
-> Configure gas budget, price, and coin selection for Sui transactions.
-
-With Programmable Transactions, you can use the gas payment coin to construct coins with a set
-balance using `splitCoin`. This is useful for Sui payments, and avoids the need for up-front coin
-selection. You can use `tx.gas` to access the gas coin in a transaction, and it is valid as input
-for any arguments, as long as it is used
-[by-reference](https://docs.sui.io/guides/developer/sui-101/simulating-refs). Practically speaking,
-this means you can also add to the gas coin with `mergeCoins` and borrow it for Move functions with
-`moveCall`.
-
-You can also transfer the gas coin using `transferObjects`, in the event that you want to transfer
-all of your coin balance to another address.
-
-## Gas configuration
-
-The new transaction builder comes with default behavior for all gas logic, including automatically
-setting the gas price, budget, and selecting coins to be used as gas. This behavior can be
-customized.
-
-### Gas price
-
-By default, the gas price is set to the reference gas price of the network. You can also explicitly
-set the gas price of the transaction by calling `setGasPrice` on the transaction builder.
-
-```tsx
-tx.setGasPrice(gasPrice);
-```
-
-### Budget
-
-By default, the gas budget is automatically derived by executing a dry-run of the transaction
-beforehand. The dry run gas consumption is then used to determine a balance for the transaction. You
-can override this behavior by explicitly setting a gas budget for the transaction, by calling
-`setGasBudget` on the transaction builder.
-
-The gas budget is represented in Sui and should take the gas price of the transaction into account.
-
-```tsx
-tx.setGasBudget(gasBudgetAmount);
-```
-
-### Gas payment
-
-By default, the gas payment is automatically determined by the SDK. The SDK selects all of the users
-coins that are not used as inputs in the transaction.
-
-The list of coins used as gas payment will be merged down into a single gas coin before executing
-the transaction, and all but one of the gas objects will be deleted. The gas coin at the 0-index
-will be the coin that all others are merged into.
-
-```tsx
-// you need to ensure that the coins do not overlap with any
-// of the input objects for the transaction
-tx.setGasPayment([coin1, coin2]);
-```
-
-Gas coins should be objects containing the coins objectId, version, and digest.
-
-<auto-type-table type="{ objectId: string, version: string | number, digest: string }" />

package/docs/transaction-building/intents.md

@@ -1,62 +0,0 @@
-# Transaction Intents
-
-> Use high-level intents to simplify transaction building.
-
-Transaction Intents enable third-party SDKs and [Transaction Plugins](../plugins) to more easily add
-operations to a Transaction. The TypeScript SDK currently only includes a single Intent
-(CoinWithBalance), but more will be added in the future.
-
-## The CoinWithBalance intent
-
-The `CoinWithBalance` intent makes it easy to get a coin with a specific balance. For SUI, this has
-generally been done by splitting the gas coin:
-
-```typescript
-const tx = new Transaction();
-
-const [coin] = tx.splitCoins(tx.gas, [100]);
-
-tx.transferObjects([coin], recipient);
-```
-
-This approach works well for SUI, but can't be used for other coin types. The CoinWithBalance intent
-solves this by providing a helper function that automatically adds the correct SplitCoins and
-MergeCoins commands to the transaction:
-
-```typescript
-
-const tx = new Transaction();
-
-// Setting the sender is required for the CoinWithBalance intent to resolve coins when not using the gas coin
-tx.setSender(keypair.toSuiAddress());
-
-tx.transferObjects(
-	[
-		// Create a SUI coin (balance is in MIST)
-		coinWithBalance({ balance: 100 }),
-		// Create a coin of another type
-		coinWithBalance({ balance: 100, type: '0x123::foo:Bar' }),
-	],
-	recipient,
-);
-```
-
-Splitting the gas coin also causes problems for sponsored transactions. When sponsoring
-transactions, the gas coin comes from the sponsor instead of the transaction sender. Transaction
-sponsors usually do not sponsor transactions that use the gas coin for anything other than gas. To
-transfer SUI that does not use the gas coin, you can set the `useGasCoin` option to `false`:
-
-```typescript
-const tx = new Transaction();
-tx.transferObjects([coinWithBalance({ balance: 100, useGasCoin: false })], recipient);
-```
-
-It's important to only set `useGasCoin` option to false for sponsored transactions, otherwise the
-coinWithBalance intent might use all the SUI coins, leaving no coins to use for gas.
-
-## How it works
-
-When the `CoinWithBalance` intent is resolved, it will look up the senders owned coins for each type
-that needs to be created. It will then find a set of coins with sufficient balance to cover the
-desired balance, to combine them into a single coin. This coin is then used in a `SplitCoins`
-command to create the desired coin.

package/docs/transaction-building/offline.md

@@ -1,73 +0,0 @@
-# Building Offline
-
-> Build transactions without a network connection.
-
-To build a transaction offline (with no `client` required), you need to fully define all of your
-inputs, gas configuration, and expiration.
-
-## Required configuration
-
-When building offline, you must set the following:
-
-- Sender address: The address that will execute the transaction
-- Gas price: The price per gas unit (can be obtained from the network beforehand)
-- Gas budget: The maximum gas to spend on this transaction
-- Gas payment: One or more coin object references to use for gas, or an empty array for Address
-  Balances
-- Expiration: Only needed when using address balances for gas
-
-```tsx
-
-const { referenceGasPrice } = await client.getReferenceGasPrice();
-
-const tx = new Transaction();
-
-tx.setSender('0x<your-address>');
-tx.setGasPrice(referenceGasPrice);
-tx.setGasBudget(50_000_000);
-tx.setGasPayment([
-	{
-		objectId: '0x<gas-coin-object-id>',
-		version: '<object-version>',
-		digest: '<object-digest>',
-	},
-]);
-
-// Build the transaction without a client
-const bytes = await tx.build();
-```
-
-## Object references
-
-For objects used in your transaction, you must provide full object references using the `Inputs`
-helper:
-
-```tsx
-
-// For owned or immutable objects
-tx.object(
-	Inputs.ObjectRef({
-		objectId: '0x<object-id>',
-		version: '<object-version>',
-		digest: '<object-digest>',
-	}),
-);
-
-// For shared objects
-tx.object(
-	Inputs.SharedObjectRef({
-		objectId: '0x<object-id>',
-		initialSharedVersion: '<initial-shared-version>',
-		mutable: true,
-	}),
-);
-
-// For receiving objects (objects being received by another object)
-tx.object(
-	Inputs.ReceivingRef({
-		objectId: '0x<object-id>',
-		version: '<object-version>',
-		digest: '<object-digest>',
-	}),
-);
-```

package/docs/transaction-building/sponsored-transactions.md

@@ -1,22 +0,0 @@
-# Sponsored Transactions
-
-> Pay gas fees on behalf of other users with sponsored transactions.
-
-The transaction builder can support sponsored transactions by using the `onlyTransactionKind` flag
-when building the transaction.
-
-```tsx
-const tx = new Transaction();
-
-// ... add some transactions...
-
-const kindBytes = await tx.build({ provider, onlyTransactionKind: true });
-
-// construct a sponsored transaction from the kind bytes
-const sponsoredtx = Transaction.fromKind(kindBytes);
-
-// you can now set the sponsored transaction data that is required
-sponsoredtx.setSender(sender);
-sponsoredtx.setGasOwner(sponsor);
-sponsoredtx.setGasPayment(sponsorCoins);
-```