import { UnsignedHyper } from 'js-xdr';
+ import { UnsignedHyper } from '@stellar/js-xdr';
import BigNumber from 'bignumber.js';
import xdr from './xdr';
@@ -296,7 +296,7 @@ js-stellar-base/src/memo.js
diff --git a/js-stellar-base_src_muxed_account.js.html b/js-stellar-base_src_muxed_account.js.html
index ce2ae28..4c43ebf 100644
--- a/js-stellar-base_src_muxed_account.js.html
+++ b/js-stellar-base_src_muxed_account.js.html
@@ -24,7 +24,7 @@
@@ -188,7 +188,7 @@ js-stellar-base/src/muxed_account.js
diff --git a/js-stellar-base_src_network.js.html b/js-stellar-base_src_network.js.html
index 4eb5c29..f58968c 100644
--- a/js-stellar-base_src_network.js.html
+++ b/js-stellar-base_src_network.js.html
@@ -24,7 +24,7 @@
@@ -67,7 +67,7 @@ js-stellar-base/src/network.js
diff --git a/js-stellar-base_src_numbers_index.js.html b/js-stellar-base_src_numbers_index.js.html
index 6eddf91..aeec6b1 100644
--- a/js-stellar-base_src_numbers_index.js.html
+++ b/js-stellar-base_src_numbers_index.js.html
@@ -24,7 +24,7 @@
@@ -110,7 +110,7 @@ js-stellar-base/src/numbers/index.js
diff --git a/js-stellar-base_src_numbers_int128.js.html b/js-stellar-base_src_numbers_int128.js.html
index 58dfac3..279408a 100644
--- a/js-stellar-base_src_numbers_int128.js.html
+++ b/js-stellar-base_src_numbers_int128.js.html
@@ -24,7 +24,7 @@
@@ -39,7 +39,7 @@ js-stellar-base/src/numbers/int128.js
- import { LargeInt } from 'js-xdr';
+ import { LargeInt } from '@stellar/js-xdr';
export class Int128 extends LargeInt {
/**
@@ -74,7 +74,7 @@ js-stellar-base/src/numbers/int128.js
diff --git a/js-stellar-base_src_numbers_int256.js.html b/js-stellar-base_src_numbers_int256.js.html
index 9f653ef..b4073ea 100644
--- a/js-stellar-base_src_numbers_int256.js.html
+++ b/js-stellar-base_src_numbers_int256.js.html
@@ -24,7 +24,7 @@
@@ -39,7 +39,7 @@ js-stellar-base/src/numbers/int256.js
- import { LargeInt } from 'js-xdr';
+ import { LargeInt } from '@stellar/js-xdr';
export class Int256 extends LargeInt {
/**
@@ -74,7 +74,7 @@ js-stellar-base/src/numbers/int256.js
diff --git a/js-stellar-base_src_numbers_sc_int.js.html b/js-stellar-base_src_numbers_sc_int.js.html
index a1e2d3e..d0d1346 100644
--- a/js-stellar-base_src_numbers_sc_int.js.html
+++ b/js-stellar-base_src_numbers_sc_int.js.html
@@ -24,7 +24,7 @@
@@ -53,11 +53,11 @@ js-stellar-base/src/numbers/sc_int.js
* example, you could do `new XdrLargeInt('u128', bytes...).toBigInt()`.
*
* @example
- * import sdk from "stellar-base";
+ * import { xdr, ScInt } from "@stellar/stellar-base";
*
* // You have an ScVal from a contract and want to parse it into JS native.
- * const value = sdk.xdr.ScVal.fromXDR(someXdr, "base64");
- * const bigi = sdk.ScInt.fromScVal(value); // grab it as a BigInt
+ * const value = xdr.ScVal.fromXDR(someXdr, "base64");
+ * const bigi = ScInt.fromScVal(value); // grab it as a BigInt
* let sci = new ScInt(bigi);
*
* sci.toNumber(); // gives native JS type (w/ size check)
@@ -65,7 +65,7 @@ js-stellar-base/src/numbers/sc_int.js
* sci.toU64(); // gives ScValType-specific XDR constructs (with size checks)
*
* // You have a number and want to shove it into a contract.
- * sci = sdk.ScInt(0xdeadcafebabe);
+ * sci = ScInt(0xdeadcafebabe);
* sci.toBigInt() // returns 244838016400062n
* sci.toNumber() // throws: too large
*
@@ -76,16 +76,16 @@ js-stellar-base/src/numbers/sc_int.js
* const scValU64 = sci.toU64();
*
* // Lots of ways to initialize:
- * sdk.ScInt("123456789123456789")
- * sdk.ScInt(123456789123456789n);
- * sdk.ScInt(1n << 140n);
- * sdk.ScInt(-42);
- * sdk.ScInt.fromScVal(scValU128); // from above
+ * ScInt("123456789123456789")
+ * ScInt(123456789123456789n);
+ * ScInt(1n << 140n);
+ * ScInt(-42);
+ * ScInt.fromScVal(scValU128); // from above
*
* // If you know the type ahead of time (accessing `.raw` is faster than
* // conversions), you can specify the type directly (otherwise, it's
* // interpreted from the numbers you pass in):
- * const i = sdk.ScInt(123456789n, { type: "u256" });
+ * const i = ScInt(123456789n, { type: "u256" });
*
* // For example, you can use the underlying `sdk.U256` and convert it to an
* // `xdr.ScVal` directly like so:
@@ -165,7 +165,7 @@ js-stellar-base/src/numbers/sc_int.js
diff --git a/js-stellar-base_src_numbers_uint128.js.html b/js-stellar-base_src_numbers_uint128.js.html
index 06874db..87d0d6a 100644
--- a/js-stellar-base_src_numbers_uint128.js.html
+++ b/js-stellar-base_src_numbers_uint128.js.html
@@ -24,7 +24,7 @@
@@ -39,7 +39,7 @@ js-stellar-base/src/numbers/uint128.js
- import { LargeInt } from 'js-xdr';
+ import { LargeInt } from '@stellar/js-xdr';
export class Uint128 extends LargeInt {
/**
@@ -74,7 +74,7 @@ js-stellar-base/src/numbers/uint128.js
diff --git a/js-stellar-base_src_numbers_uint256.js.html b/js-stellar-base_src_numbers_uint256.js.html
index 7b16116..a029d92 100644
--- a/js-stellar-base_src_numbers_uint256.js.html
+++ b/js-stellar-base_src_numbers_uint256.js.html
@@ -24,7 +24,7 @@
@@ -39,7 +39,7 @@ js-stellar-base/src/numbers/uint256.js
- import { LargeInt } from 'js-xdr';
+ import { LargeInt } from '@stellar/js-xdr';
export class Uint256 extends LargeInt {
/**
@@ -74,7 +74,7 @@ js-stellar-base/src/numbers/uint256.js
diff --git a/js-stellar-base_src_numbers_xdr_large_int.js.html b/js-stellar-base_src_numbers_xdr_large_int.js.html
index fbd382c..8c3e616 100644
--- a/js-stellar-base_src_numbers_xdr_large_int.js.html
+++ b/js-stellar-base_src_numbers_xdr_large_int.js.html
@@ -24,7 +24,7 @@
@@ -40,7 +40,7 @@ js-stellar-base/src/numbers/xdr_large_int.js
/* eslint no-bitwise: ["error", {"allow": [">>"]}] */
-import { Hyper, UnsignedHyper } from 'js-xdr';
+import { Hyper, UnsignedHyper } from '@stellar/js-xdr';
import { Uint128 } from './uint128';
import { Uint256 } from './uint256';
@@ -63,14 +63,10 @@ js-stellar-base/src/numbers/xdr_large_int.js
* integer-like values interpreted in big-endian order
*/
export class XdrLargeInt {
- /**
- * @type {xdr.LargeInt}
- */
+ /** @type {xdr.LargeInt} */
int; // child class of a jsXdr.LargeInt
- /**
- * @type {string} - one of i64, u64, i128, u128, i256, or u256
- */
+ /** @type {string} */
type;
constructor(type, values) {
@@ -305,7 +301,7 @@ js-stellar-base/src/numbers/xdr_large_int.js
diff --git a/js-stellar-base_src_operation.js.html b/js-stellar-base_src_operation.js.html
index c9aa536..e9d64f4 100644
--- a/js-stellar-base_src_operation.js.html
+++ b/js-stellar-base_src_operation.js.html
@@ -24,7 +24,7 @@
@@ -41,7 +41,7 @@ js-stellar-base/src/operation.js
/* eslint-disable no-bitwise */
-import { Hyper } from 'js-xdr';
+import { Hyper } from '@stellar/js-xdr';
import BigNumber from 'bignumber.js';
import { trimEnd } from './util/util';
import { best_r } from './util/continued_fraction';
@@ -51,7 +51,7 @@ js-stellar-base/src/operation.js
import { StrKey } from './strkey';
import { LiquidityPoolId } from './liquidity_pool_id';
import xdr from './xdr';
-import * as ops from './operations/index';
+import * as ops from './operations';
import {
decodeAddressToMuxedAccount,
encodeMuxedAccountToAddress
@@ -133,7 +133,7 @@ js-stellar-base/src/operation.js
* * `{@link Operation.liquidityPoolDeposit}`
* * `{@link Operation.liquidityPoolWithdraw}`
* * `{@link Operation.invokeHostFunction}`
- * * `{@link Operation.bumpFootprintExpiration}`
+ * * `{@link Operation.extendFootprintTtlOp}`
* * `{@link Operation.restoreFootprint}`
*
* @class Operation
@@ -422,9 +422,9 @@ js-stellar-base/src/operation.js
result.auth = attrs.auth() ?? [];
break;
}
- case 'bumpFootprintExpiration': {
- result.type = 'bumpFootprintExpiration';
- result.ledgersToExpire = attrs.ledgersToExpire();
+ case 'extendFootprintTtl': {
+ result.type = 'extendFootprintTtl';
+ result.extendTo = attrs.extendTo();
break;
}
case 'restoreFootprint': {
@@ -713,8 +713,15 @@ js-stellar-base/src/operation.js
Operation.liquidityPoolDeposit = ops.liquidityPoolDeposit;
Operation.liquidityPoolWithdraw = ops.liquidityPoolWithdraw;
Operation.invokeHostFunction = ops.invokeHostFunction;
-Operation.bumpFootprintExpiration = ops.bumpFootprintExpiration;
+Operation.extendFootprintTtl = ops.extendFootprintTtl;
Operation.restoreFootprint = ops.restoreFootprint;
+
+// these are not `xdr.Operation`s directly, but are proxies for complex but
+// common versions of `Operation.invokeHostFunction`
+Operation.createStellarAssetContract = ops.createStellarAssetContract;
+Operation.invokeContractFunction = ops.invokeContractFunction;
+Operation.createCustomContract = ops.createCustomContract;
+Operation.uploadContractWasm = ops.uploadContractWasm;
@@ -727,7 +734,7 @@ js-stellar-base/src/operation.js
diff --git a/js-stellar-base_src_operations_account_merge.js.html b/js-stellar-base_src_operations_account_merge.js.html
index 00c26da..733b9ed 100644
--- a/js-stellar-base_src_operations_account_merge.js.html
+++ b/js-stellar-base_src_operations_account_merge.js.html
@@ -24,7 +24,7 @@
@@ -80,7 +80,7 @@ js-stellar-base/src/operations/account_merge.js
diff --git a/js-stellar-base_src_operations_allow_trust.js.html b/js-stellar-base_src_operations_allow_trust.js.html
index 46dd0d8..b01923c 100644
--- a/js-stellar-base_src_operations_allow_trust.js.html
+++ b/js-stellar-base_src_operations_allow_trust.js.html
@@ -24,7 +24,7 @@
@@ -106,7 +106,7 @@ js-stellar-base/src/operations/allow_trust.js
diff --git a/js-stellar-base_src_operations_begin_sponsoring_future_reserves.js.html b/js-stellar-base_src_operations_begin_sponsoring_future_reserves.js.html
index 32da049..6e5b01b 100644
--- a/js-stellar-base_src_operations_begin_sponsoring_future_reserves.js.html
+++ b/js-stellar-base_src_operations_begin_sponsoring_future_reserves.js.html
@@ -24,7 +24,7 @@
@@ -84,7 +84,7 @@ js-stellar-base/src/operations/begin_sponsoring_future_re
diff --git a/js-stellar-base_src_operations_bump_sequence.js.html b/js-stellar-base_src_operations_bump_sequence.js.html
index be38bfe..035cb07 100644
--- a/js-stellar-base_src_operations_bump_sequence.js.html
+++ b/js-stellar-base_src_operations_bump_sequence.js.html
@@ -24,7 +24,7 @@
@@ -39,7 +39,7 @@ js-stellar-base/src/operations/bump_sequence.js
- import { Hyper } from 'js-xdr';
+ import { Hyper } from '@stellar/js-xdr';
import BigNumber from 'bignumber.js';
import xdr from '../xdr';
@@ -88,7 +88,7 @@ js-stellar-base/src/operations/bump_sequence.js
diff --git a/js-stellar-base_src_operations_change_trust.js.html b/js-stellar-base_src_operations_change_trust.js.html
index e6f7d46..b0558f5 100644
--- a/js-stellar-base_src_operations_change_trust.js.html
+++ b/js-stellar-base_src_operations_change_trust.js.html
@@ -24,7 +24,7 @@
@@ -39,7 +39,7 @@ js-stellar-base/src/operations/change_trust.js
- import { Hyper } from 'js-xdr';
+ import { Hyper } from '@stellar/js-xdr';
import BigNumber from 'bignumber.js';
import xdr from '../xdr';
import { Asset } from '../asset';
@@ -103,7 +103,7 @@ js-stellar-base/src/operations/change_trust.js
diff --git a/js-stellar-base_src_operations_claim_claimable_balance.js.html b/js-stellar-base_src_operations_claim_claimable_balance.js.html
index a9f7432..df1ed62 100644
--- a/js-stellar-base_src_operations_claim_claimable_balance.js.html
+++ b/js-stellar-base_src_operations_claim_claimable_balance.js.html
@@ -24,7 +24,7 @@
@@ -92,7 +92,7 @@ js-stellar-base/src/operations/claim_claimable_balance.js
diff --git a/js-stellar-base_src_operations_clawback.js.html b/js-stellar-base_src_operations_clawback.js.html
index 046312a..2a2b50a 100644
--- a/js-stellar-base_src_operations_clawback.js.html
+++ b/js-stellar-base_src_operations_clawback.js.html
@@ -24,7 +24,7 @@
@@ -93,7 +93,7 @@ js-stellar-base/src/operations/clawback.js
diff --git a/js-stellar-base_src_operations_clawback_claimable_balance.js.html b/js-stellar-base_src_operations_clawback_claimable_balance.js.html
index 79e3a48..0cd69fd 100644
--- a/js-stellar-base_src_operations_clawback_claimable_balance.js.html
+++ b/js-stellar-base_src_operations_clawback_claimable_balance.js.html
@@ -24,7 +24,7 @@
@@ -88,7 +88,7 @@ js-stellar-base/src/operations/clawback_claimable_balance
diff --git a/js-stellar-base_src_operations_create_account.js.html b/js-stellar-base_src_operations_create_account.js.html
index cd047d2..97d37cb 100644
--- a/js-stellar-base_src_operations_create_account.js.html
+++ b/js-stellar-base_src_operations_create_account.js.html
@@ -24,7 +24,7 @@
@@ -88,7 +88,7 @@ js-stellar-base/src/operations/create_account.js
diff --git a/js-stellar-base_src_operations_create_claimable_balance.js.html b/js-stellar-base_src_operations_create_claimable_balance.js.html
index 3344de4..26f3c94 100644
--- a/js-stellar-base_src_operations_create_claimable_balance.js.html
+++ b/js-stellar-base_src_operations_create_claimable_balance.js.html
@@ -24,7 +24,7 @@
@@ -120,7 +120,7 @@ js-stellar-base/src/operations/create_claimable_balance.j
diff --git a/js-stellar-base_src_operations_create_passive_sell_offer.js.html b/js-stellar-base_src_operations_create_passive_sell_offer.js.html
index 082df17..b993b6c 100644
--- a/js-stellar-base_src_operations_create_passive_sell_offer.js.html
+++ b/js-stellar-base_src_operations_create_passive_sell_offer.js.html
@@ -24,7 +24,7 @@
@@ -93,7 +93,7 @@ js-stellar-base/src/operations/create_passive_sell_offer.
diff --git a/js-stellar-base_src_operations_end_sponsoring_future_reserves.js.html b/js-stellar-base_src_operations_end_sponsoring_future_reserves.js.html
index 061a026..7ecf1ff 100644
--- a/js-stellar-base_src_operations_end_sponsoring_future_reserves.js.html
+++ b/js-stellar-base_src_operations_end_sponsoring_future_reserves.js.html
@@ -24,7 +24,7 @@
@@ -72,7 +72,7 @@ js-stellar-base/src/operations/end_sponsoring_future_rese
diff --git a/js-stellar-base_src_operations_extend_footprint_ttl.js.html b/js-stellar-base_src_operations_extend_footprint_ttl.js.html
new file mode 100644
index 0000000..fd3c4df
--- /dev/null
+++ b/js-stellar-base_src_operations_extend_footprint_ttl.js.html
@@ -0,0 +1,101 @@
+
+
+
+
+
+ js-stellar-base/src/operations/extend_footprint_ttl.js - Documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ js-stellar-base/src/operations/extend_footprint_ttl.js
+
+
+
+
+
+
+
+
+
+ import xdr from '../xdr';
+
+/**
+ * Builds an operation to bump the expiration of a footprint (read and written
+ * ledger keys). Its only parameter is the number of ledgers to extend
+ * expiration for.
+ *
+ * The footprint itself is derived from the transaction (see
+ * {@link TransactionBuilder}'s `opts.sorobanData` parameter, which is a
+ * {@link xdr.SorobanTransactionData} instance that contains fee data & resource
+ * usage as part of {@link xdr.SorobanResources}).
+ *
+ * @function
+ * @alias Operation.extendFootprintTtl
+ *
+ * @param {object} opts - object holding operation parameters
+ * @param {number} opts.extendTo - the number of ledgers past the LCL
+ * (last closed ledger) by which to extend the validity of the ledger keys in
+ * this transaction
+ * @param {string} [opts.source] - an optional source account
+ *
+ * @returns {xdr.Operation} a Bump Footprint Expiration operation
+ * (xdr.ExtendFootprintTTLOp)
+ */
+export function extendFootprintTtl(opts) {
+ if ((opts.extendTo ?? -1) <= 0) {
+ throw new RangeError("extendTo isn't a ledger quantity (uint32)");
+ }
+
+ const extendFootprintOp = new xdr.ExtendFootprintTtlOp({
+ ext: new xdr.ExtensionPoint(0),
+ extendTo: opts.extendTo
+ });
+
+ const opAttributes = {
+ body: xdr.OperationBody.extendFootprintTtl(extendFootprintOp)
+ };
+ this.setSourceAccount(opAttributes, opts);
+
+ return new xdr.Operation(opAttributes);
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/js-stellar-base_src_operations_inflation.js.html b/js-stellar-base_src_operations_inflation.js.html
index e17b9cf..78e2229 100644
--- a/js-stellar-base_src_operations_inflation.js.html
+++ b/js-stellar-base_src_operations_inflation.js.html
@@ -24,7 +24,7 @@
@@ -67,7 +67,7 @@ js-stellar-base/src/operations/inflation.js
diff --git a/js-stellar-base_src_operations_invoke_host_function.js.html b/js-stellar-base_src_operations_invoke_host_function.js.html
index e1d4913..b822c20 100644
--- a/js-stellar-base_src_operations_invoke_host_function.js.html
+++ b/js-stellar-base_src_operations_invoke_host_function.js.html
@@ -24,7 +24,7 @@
@@ -41,8 +41,12 @@ js-stellar-base/src/operations/invoke_host_function.js
import xdr from '../xdr';
+import { Keypair } from '../keypair';
+import { Address } from '../address';
+import { Asset } from '../asset';
+
/**
- * Invokes a single smart contract function.
+ * Invokes a single smart contract host function.
*
* @function
* @alias Operation.invokeHostFunction
@@ -56,6 +60,13 @@ js-stellar-base/src/operations/invoke_host_function.jsjs-stellar-base/src/operations/invoke_host_function.js
@@ -88,7 +280,7 @@ js-stellar-base/src/operations/invoke_host_function.js
diff --git a/js-stellar-base_src_operations_liquidity_pool_deposit.js.html b/js-stellar-base_src_operations_liquidity_pool_deposit.js.html
index 3926790..49e998c 100644
--- a/js-stellar-base_src_operations_liquidity_pool_deposit.js.html
+++ b/js-stellar-base_src_operations_liquidity_pool_deposit.js.html
@@ -24,7 +24,7 @@
@@ -111,7 +111,7 @@ js-stellar-base/src/operations/liquidity_pool_deposit.js<
diff --git a/js-stellar-base_src_operations_liquidity_pool_withdraw.js.html b/js-stellar-base_src_operations_liquidity_pool_withdraw.js.html
index f69c949..31cda5f 100644
--- a/js-stellar-base_src_operations_liquidity_pool_withdraw.js.html
+++ b/js-stellar-base_src_operations_liquidity_pool_withdraw.js.html
@@ -24,7 +24,7 @@
@@ -99,7 +99,7 @@ js-stellar-base/src/operations/liquidity_pool_withdraw.js
diff --git a/js-stellar-base_src_operations_manage_buy_offer.js.html b/js-stellar-base_src_operations_manage_buy_offer.js.html
index 9d63cd3..fafe329 100644
--- a/js-stellar-base_src_operations_manage_buy_offer.js.html
+++ b/js-stellar-base_src_operations_manage_buy_offer.js.html
@@ -24,7 +24,7 @@
@@ -39,7 +39,7 @@ js-stellar-base/src/operations/manage_buy_offer.js
- import { Hyper } from 'js-xdr';
+ import { Hyper } from '@stellar/js-xdr';
import xdr from '../xdr';
/**
* Returns a XDR ManageBuyOfferOp. A "manage buy offer" operation creates, updates, or
@@ -98,7 +98,7 @@ js-stellar-base/src/operations/manage_buy_offer.js
diff --git a/js-stellar-base_src_operations_manage_data.js.html b/js-stellar-base_src_operations_manage_data.js.html
index 405ec4d..ef3b74e 100644
--- a/js-stellar-base_src_operations_manage_data.js.html
+++ b/js-stellar-base_src_operations_manage_data.js.html
@@ -24,7 +24,7 @@
@@ -97,7 +97,7 @@ js-stellar-base/src/operations/manage_data.js
diff --git a/js-stellar-base_src_operations_manage_sell_offer.js.html b/js-stellar-base_src_operations_manage_sell_offer.js.html
index 4c5286f..0772415 100644
--- a/js-stellar-base_src_operations_manage_sell_offer.js.html
+++ b/js-stellar-base_src_operations_manage_sell_offer.js.html
@@ -24,7 +24,7 @@
@@ -39,7 +39,7 @@ js-stellar-base/src/operations/manage_sell_offer.js
- import { Hyper } from 'js-xdr';
+ import { Hyper } from '@stellar/js-xdr';
import xdr from '../xdr';
/**
* Returns a XDR ManageSellOfferOp. A "manage sell offer" operation creates, updates, or
@@ -98,7 +98,7 @@ js-stellar-base/src/operations/manage_sell_offer.js
diff --git a/js-stellar-base_src_operations_path_payment_strict_receive.js.html b/js-stellar-base_src_operations_path_payment_strict_receive.js.html
index f052402..1f11190 100644
--- a/js-stellar-base_src_operations_path_payment_strict_receive.js.html
+++ b/js-stellar-base_src_operations_path_payment_strict_receive.js.html
@@ -24,7 +24,7 @@
@@ -117,7 +117,7 @@ js-stellar-base/src/operations/path_payment_strict_receiv
diff --git a/js-stellar-base_src_operations_path_payment_strict_send.js.html b/js-stellar-base_src_operations_path_payment_strict_send.js.html
index 870a99b..b13ef4f 100644
--- a/js-stellar-base_src_operations_path_payment_strict_send.js.html
+++ b/js-stellar-base_src_operations_path_payment_strict_send.js.html
@@ -24,7 +24,7 @@
@@ -116,7 +116,7 @@ js-stellar-base/src/operations/path_payment_strict_send.j
diff --git a/js-stellar-base_src_operations_payment.js.html b/js-stellar-base_src_operations_payment.js.html
index fff4e70..394efd8 100644
--- a/js-stellar-base_src_operations_payment.js.html
+++ b/js-stellar-base_src_operations_payment.js.html
@@ -24,7 +24,7 @@
@@ -96,7 +96,7 @@ js-stellar-base/src/operations/payment.js
diff --git a/js-stellar-base_src_operations_restore_footprint.js.html b/js-stellar-base_src_operations_restore_footprint.js.html
index b08bf33..c47cc7e 100644
--- a/js-stellar-base_src_operations_restore_footprint.js.html
+++ b/js-stellar-base_src_operations_restore_footprint.js.html
@@ -24,7 +24,7 @@
@@ -80,7 +80,7 @@ js-stellar-base/src/operations/restore_footprint.js
diff --git a/js-stellar-base_src_operations_revoke_sponsorship.js.html b/js-stellar-base_src_operations_revoke_sponsorship.js.html
index 7a18fd2..209af16 100644
--- a/js-stellar-base_src_operations_revoke_sponsorship.js.html
+++ b/js-stellar-base_src_operations_revoke_sponsorship.js.html
@@ -24,7 +24,7 @@
@@ -367,7 +367,7 @@ js-stellar-base/src/operations/revoke_sponsorship.js
diff --git a/js-stellar-base_src_operations_set_options.js.html b/js-stellar-base_src_operations_set_options.js.html
index 68099c3..3e300d1 100644
--- a/js-stellar-base_src_operations_set_options.js.html
+++ b/js-stellar-base_src_operations_set_options.js.html
@@ -24,7 +24,7 @@
@@ -235,7 +235,7 @@ js-stellar-base/src/operations/set_options.js
diff --git a/js-stellar-base_src_operations_set_trustline_flags.js.html b/js-stellar-base_src_operations_set_trustline_flags.js.html
index 7bd938a..e833708 100644
--- a/js-stellar-base_src_operations_set_trustline_flags.js.html
+++ b/js-stellar-base_src_operations_set_trustline_flags.js.html
@@ -24,7 +24,7 @@
@@ -137,7 +137,7 @@ js-stellar-base/src/operations/set_trustline_flags.js
diff --git a/js-stellar-base_src_scval.js.html b/js-stellar-base_src_scval.js.html
index 3a94944..8e1b1ab 100644
--- a/js-stellar-base_src_scval.js.html
+++ b/js-stellar-base_src_scval.js.html
@@ -24,7 +24,7 @@
@@ -421,7 +421,7 @@ js-stellar-base/src/scval.js
diff --git a/js-stellar-base_src_signerkey.js.html b/js-stellar-base_src_signerkey.js.html
index a243fa2..38c4a3d 100644
--- a/js-stellar-base_src_signerkey.js.html
+++ b/js-stellar-base_src_signerkey.js.html
@@ -24,7 +24,7 @@
@@ -143,7 +143,7 @@ js-stellar-base/src/signerkey.js
diff --git a/js-stellar-base_src_signing.js.html b/js-stellar-base_src_signing.js.html
index 11fedab..e0cc3d9 100644
--- a/js-stellar-base_src_signing.js.html
+++ b/js-stellar-base_src_signing.js.html
@@ -24,7 +24,7 @@
@@ -158,7 +158,7 @@ js-stellar-base/src/signing.js
diff --git a/js-stellar-base_src_soroban.js.html b/js-stellar-base_src_soroban.js.html
index 6d8ee6b..b3b7296 100644
--- a/js-stellar-base_src_soroban.js.html
+++ b/js-stellar-base_src_soroban.js.html
@@ -24,7 +24,7 @@
@@ -39,10 +39,7 @@ js-stellar-base/src/soroban.js
- /**
- * @class Soroban
- * Soroban helper class to assist with formatting and parsing token amounts.
- */
+ /* Helper class to assist with formatting and parsing token amounts. */
export class Soroban {
/**
* Given a whole number smart contract amount of a token and an amount of
@@ -128,7 +125,7 @@ js-stellar-base/src/soroban.js
diff --git a/js-stellar-base_src_sorobandata_builder.js.html b/js-stellar-base_src_sorobandata_builder.js.html
index 7bfd55a..57645ab 100644
--- a/js-stellar-base_src_sorobandata_builder.js.html
+++ b/js-stellar-base_src_sorobandata_builder.js.html
@@ -24,7 +24,7 @@
@@ -46,10 +46,9 @@ js-stellar-base/src/sorobandata_builder.js
* items set to specific values.
*
* This is recommended for when you are building
- * {@link Operation.bumpFootprintExpiration} /
- * {@link Operation.restoreFootprint} operations and need to
- * {@link TransactionBuilder.setSorobanData} to avoid (re)building the entire
- * data structure from scratch.
+ * {@link Operation.extendFootprintTtl} / {@link Operation.restoreFootprint}
+ * operations and need to {@link TransactionBuilder.setSorobanData} to avoid
+ * (re)building the entire data structure from scratch.
*
* @constructor
*
@@ -87,7 +86,7 @@ js-stellar-base/src/sorobandata_builder.js
writeBytes: 0
}),
ext: new xdr.ExtensionPoint(0),
- refundableFee: new xdr.Int64(0)
+ resourceFee: new xdr.Int64(0)
});
} else if (
typeof sorobanData === 'string' ||
@@ -114,12 +113,12 @@ js-stellar-base/src/sorobandata_builder.js
}
/**
- * Sets the "refundable" fee portion of the Soroban data.
- * @param {number | bigint | string} fee the refundable fee to set (int64)
+ * Sets the resource fee portion of the Soroban data.
+ * @param {number | bigint | string} fee the resource fee to set (int64)
* @returns {SorobanDataBuilder}
*/
- setRefundableFee(fee) {
- this._data.refundableFee(new xdr.Int64(fee));
+ setResourceFee(fee) {
+ this._data.resourceFee(new xdr.Int64(fee));
return this;
}
@@ -248,7 +247,7 @@ js-stellar-base/src/sorobandata_builder.js
diff --git a/js-stellar-base_src_strkey.js.html b/js-stellar-base_src_strkey.js.html
index 55ed374..7cc866a 100644
--- a/js-stellar-base_src_strkey.js.html
+++ b/js-stellar-base_src_strkey.js.html
@@ -24,7 +24,7 @@
@@ -449,7 +449,7 @@ js-stellar-base/src/strkey.js
diff --git a/js-stellar-base_src_transaction.js.html b/js-stellar-base_src_transaction.js.html
index aaf0ae1..f9856f8 100644
--- a/js-stellar-base_src_transaction.js.html
+++ b/js-stellar-base_src_transaction.js.html
@@ -24,7 +24,7 @@
@@ -195,8 +195,9 @@ js-stellar-base/src/transaction.js
}
/**
- * @type {string} 64 bit account sequence
+ * 64 bit account sequence
* @readonly
+ * @type {string}
*/
get minAccountSequence() {
return this._minAccountSequence;
@@ -206,7 +207,8 @@ js-stellar-base/src/transaction.js
}
/**
- * @type {number} 64 bit number of seconds
+ * 64 bit number of seconds
+ * @type {number}
* @readonly
*/
get minAccountSequenceAge() {
@@ -217,7 +219,8 @@ js-stellar-base/src/transaction.js
}
/**
- * @type {number} 32 bit number of ledgers
+ * 32 bit number of ledgers
+ * @type {number}
* @readonly
*/
get minAccountSequenceLedgerGap() {
@@ -228,7 +231,8 @@ js-stellar-base/src/transaction.js
}
/**
- * @type {string[]} array of extra signers (@{link StrKey}s)
+ * array of extra signers ({@link StrKey}s)
+ * @type {string[]}
* @readonly
*/
get extraSigners() {
@@ -245,7 +249,6 @@ js-stellar-base/src/transaction.js
get sequence() {
return this._sequence;
}
-
set sequence(value) {
throw new Error('Transaction is immutable');
}
@@ -257,7 +260,6 @@ js-stellar-base/src/transaction.js
get source() {
return this._source;
}
-
set source(value) {
throw new Error('Transaction is immutable');
}
@@ -269,7 +271,6 @@ js-stellar-base/src/transaction.js
get operations() {
return this._operations;
}
-
set operations(value) {
throw new Error('Transaction is immutable');
}
@@ -281,7 +282,6 @@ js-stellar-base/src/transaction.js
get memo() {
return Memo.fromXDRObject(this._memo);
}
-
set memo(value) {
throw new Error('Transaction is immutable');
}
@@ -419,7 +419,7 @@ js-stellar-base/src/transaction.js
diff --git a/js-stellar-base_src_transaction_base.js.html b/js-stellar-base_src_transaction_base.js.html
index 5d65fe4..29005aa 100644
--- a/js-stellar-base_src_transaction_base.js.html
+++ b/js-stellar-base_src_transaction_base.js.html
@@ -24,7 +24,7 @@
@@ -268,7 +268,7 @@ js-stellar-base/src/transaction_base.js
diff --git a/js-stellar-base_src_transaction_builder.js.html b/js-stellar-base_src_transaction_builder.js.html
index f7e5938..d22153c 100644
--- a/js-stellar-base_src_transaction_builder.js.html
+++ b/js-stellar-base_src_transaction_builder.js.html
@@ -24,7 +24,7 @@
@@ -39,7 +39,7 @@ js-stellar-base/src/transaction_builder.js
- import { UnsignedHyper } from 'js-xdr';
+ import { UnsignedHyper } from '@stellar/js-xdr';
import BigNumber from 'bignumber.js';
import xdr from './xdr';
@@ -851,7 +851,7 @@ js-stellar-base/src/transaction_builder.js
diff --git a/js-stellar-base_src_util_decode_encode_muxed_account.js.html b/js-stellar-base_src_util_decode_encode_muxed_account.js.html
index 1e21f9f..1b2ddce 100644
--- a/js-stellar-base_src_util_decode_encode_muxed_account.js.html
+++ b/js-stellar-base_src_util_decode_encode_muxed_account.js.html
@@ -24,7 +24,7 @@
@@ -175,7 +175,7 @@ js-stellar-base/src/util/decode_encode_muxed_account.js
diff --git a/lib_contract_spec.js.html b/lib_contract_spec.js.html
index 37ece89..0c0cfb6 100644
--- a/lib_contract_spec.js.html
+++ b/lib_contract_spec.js.html
@@ -24,7 +24,7 @@
@@ -116,11 +116,13 @@ lib/contract_spec.js
* @throws {Error} if argument is missing or incorrect type
*
* @example
+ * ```js
* const args = {
* arg1: 'value1',
* arg2: 1234
* };
* const scArgs = contractSpec.funcArgsToScVals('funcName', args);
+ * ```
*/
funcArgsToScVals(name, args) {
let fn = this.getFunc(name);
@@ -137,8 +139,10 @@ lib/contract_spec.js
* @throws {Error} if return type mismatch or invalid input
*
* @example
+ * ```js
* const resultScv = 'AAA=='; // Base64 encoded ScVal
* const result = contractSpec.funcResToNative('funcName', resultScv);
+ * ```
*/
funcResToNative(name, val_or_base64) {
let val = typeof val_or_base64 === 'string' ? _stellarBase.xdr.ScVal.fromXDR(val_or_base64, 'base64') : val_or_base64;
@@ -215,7 +219,6 @@ lib/contract_spec.js
if (val instanceof _stellarBase.xdr.ScVal) {
return val; // should we copy?
}
-
if (val instanceof _stellarBase.Address) {
if (ty.switch().value !== _stellarBase.xdr.ScSpecType.scSpecTypeAddress().value) {
throw new TypeError(`Type ${ty} was not address, but value was Address`);
@@ -397,7 +400,6 @@ lib/contract_spec.js
// enum_.cases()
}
-
nativeToStruct(val, struct) {
let fields = struct.fields();
if (fields.some(isNumeric)) {
@@ -649,7 +651,7 @@ lib/contract_spec.js
diff --git a/lib_jsonrpc.js.html b/lib_jsonrpc.js.html
index 7c29104..76963ef 100644
--- a/lib_jsonrpc.js.html
+++ b/lib_jsonrpc.js.html
@@ -24,7 +24,7 @@
@@ -105,7 +105,7 @@ lib/jsonrpc.js
diff --git a/lib_parsers.js.html b/lib_parsers.js.html
index e817217..df9290a 100644
--- a/lib_parsers.js.html
+++ b/lib_parsers.js.html
@@ -24,7 +24,7 @@
@@ -67,11 +67,19 @@ lib/parsers.js
return {
latestLedger: r.latestLedger,
events: (r.events ?? []).map(evt => {
+ const clone = {
+ ...evt
+ };
+ delete clone.contractId; // `as any` hack because contractId field isn't optional
+
+ // the contractId may be empty so we omit the field in that case
return {
- ...evt,
- contractId: new _stellarBase.Contract(evt.contractId),
+ ...clone,
+ ...(evt.contractId !== '' && {
+ contractId: new _stellarBase.Contract(evt.contractId)
+ }),
topic: evt.topic.map(topic => _stellarBase.xdr.ScVal.fromXDR(topic, 'base64')),
- value: _stellarBase.xdr.DiagnosticEvent.fromXDR(evt.value.xdr, 'base64')
+ value: _stellarBase.xdr.ScVal.fromXDR(evt.value, 'base64')
};
})
};
@@ -87,7 +95,9 @@ lib/parsers.js
lastModifiedLedgerSeq: rawEntry.lastModifiedLedgerSeq,
key: _stellarBase.xdr.LedgerKey.fromXDR(rawEntry.key, 'base64'),
val: _stellarBase.xdr.LedgerEntryData.fromXDR(rawEntry.xdr, 'base64'),
- expirationLedgerSeq: rawEntry.expirationLedgerSeq
+ ...(rawEntry.liveUntilLedgerSeq !== undefined && {
+ liveUntilLedgerSeq: rawEntry.liveUntilLedgerSeq
+ })
};
})
};
@@ -175,7 +185,7 @@ lib/parsers.js
diff --git a/lib_server.js.html b/lib_server.js.html
index 3e975e0..e77203a 100644
--- a/lib_server.js.html
+++ b/lib_server.js.html
@@ -24,7 +24,7 @@
@@ -176,7 +176,7 @@ lib/server.js
* const key = xdr.ScVal.scvSymbol("counter");
* server.getContractData(contractId, key, Durability.Temporary).then(data => {
* console.log("value:", data.val);
- * console.log("expirationLedgerSeq:", data.expirationLedgerSeq);
+ * console.log("liveUntilLedgerSeq:", data.liveUntilLedgerSeq);
* console.log("lastModified:", data.lastModifiedLedgerSeq);
* console.log("latestLedger:", data.latestLedger);
* });
@@ -248,7 +248,7 @@ lib/server.js
* const ledgerData = response.entries[0];
* console.log("key:", ledgerData.key);
* console.log("value:", ledgerData.val);
- * console.log("expirationLedgerSeq:", ledgerData.expirationLedgerSeq);
+ * console.log("liveUntilLedgerSeq:", ledgerData.liveUntilLedgerSeq);
* console.log("lastModified:", ledgerData.lastModifiedLedgerSeq);
* console.log("latestLedger:", response.latestLedger);
* });
@@ -257,7 +257,7 @@ lib/server.js
return this._getLedgerEntries(...keys).then(_parsers.parseRawLedgerEntries);
}
async _getLedgerEntries(...keys) {
- return jsonrpc.post(this.serverURL.toString(), 'getLedgerEntries', expandRequestIncludeExpirationLedgers(keys).map(k => k.toXDR('base64'))).then(response => mergeResponseExpirationLedgers(response, keys));
+ return jsonrpc.post(this.serverURL.toString(), 'getLedgerEntries', keys.map(k => k.toXDR('base64')));
}
/**
@@ -332,7 +332,7 @@ lib/server.js
* @see https://soroban.stellar.org/api/methods/getEvents
* @example
* server.getEvents({
- * startLedger: "1000",
+ * startLedger: 1000,
* filters: [
* {
* type: "contract",
@@ -369,7 +369,7 @@ lib/server.js
})
},
...(request.startLedger && {
- startLedger: request.startLedger.toString()
+ startLedger: request.startLedger
})
});
}
@@ -417,7 +417,7 @@ lib/server.js
*
* @param {Transaction | FeeBumpTransaction} transaction the transaction to
* simulate, which should include exactly one operation (one of
- * {@link xdr.InvokeHostFunctionOp}, {@link xdr.BumpFootprintExpirationOp},
+ * {@link xdr.InvokeHostFunctionOp}, {@link xdr.ExtendFootprintTTLOp},
* or {@link xdr.RestoreFootprintOp}). Any provided footprint or auth
* information will be ignored.
*
@@ -479,7 +479,7 @@ lib/server.js
*
* @param {Transaction | FeeBumpTransaction} transaction the transaction to
* prepare. It should include exactly one operation, which must be one of
- * {@link xdr.InvokeHostFunctionOp}, {@link xdr.BumpFootprintExpirationOp},
+ * {@link xdr.InvokeHostFunctionOp}, {@link xdr.ExtendFootprintTTLOp},
* or {@link xdr.RestoreFootprintOp}.
*
* Any provided footprint will be overwritten. However, if your operation
@@ -678,46 +678,6 @@ lib/server.js
}
}
throw new Error('No account created in transaction');
-}
-
-// TODO - remove once rpc updated to
-// append expiration entry per data LK requested onto server-side response
-// https://github.com/stellar/soroban-tools/issues/1010
-function mergeResponseExpirationLedgers(ledgerEntriesResponse, requestedKeys) {
- const requestedKeyXdrs = new Set(requestedKeys.map(requestedKey => requestedKey.toXDR('base64')));
- const expirationKeyToRawEntryResult = new Map();
- (ledgerEntriesResponse.entries ?? []).forEach(rawEntryResult => {
- if (!rawEntryResult.key || !rawEntryResult.xdr) {
- throw new TypeError(`invalid ledger entry: ${JSON.stringify(rawEntryResult)}`);
- }
- const parsedKey = _stellarBase.xdr.LedgerKey.fromXDR(rawEntryResult.key, 'base64');
- const isExpirationMeta = parsedKey.switch().value === _stellarBase.xdr.LedgerEntryType.expiration().value && !requestedKeyXdrs.has(rawEntryResult.key);
- const keyHash = isExpirationMeta ? parsedKey.expiration().keyHash().toString() : (0, _stellarBase.hash)(parsedKey.toXDR()).toString();
- const rawEntry = expirationKeyToRawEntryResult.get(keyHash) ?? rawEntryResult;
- if (isExpirationMeta) {
- const expirationLedgerSeq = _stellarBase.xdr.LedgerEntryData.fromXDR(rawEntryResult.xdr, 'base64').expiration().expirationLedgerSeq();
- expirationKeyToRawEntryResult.set(keyHash, {
- ...rawEntry,
- expirationLedgerSeq
- });
- } else {
- expirationKeyToRawEntryResult.set(keyHash, {
- ...rawEntry,
- ...rawEntryResult
- });
- }
- });
- ledgerEntriesResponse.entries = [...expirationKeyToRawEntryResult.values()];
- return ledgerEntriesResponse;
-}
-
-// TODO - remove once rpc updated to
-// include expiration entry on responses for any data LK's requested
-// https://github.com/stellar/soroban-tools/issues/1010
-function expandRequestIncludeExpirationLedgers(keys) {
- return keys.concat(keys.filter(key => key.switch().value !== _stellarBase.xdr.LedgerEntryType.expiration().value).map(key => _stellarBase.xdr.LedgerKey.expiration(new _stellarBase.xdr.LedgerKeyExpiration({
- keyHash: (0, _stellarBase.hash)(key.toXDR())
- }))));
}
@@ -730,7 +690,7 @@ lib/server.js
diff --git a/lib_soroban_rpc.js.html b/lib_soroban_rpc.js.html
index 0f936fc..5caebb7 100644
--- a/lib_soroban_rpc.js.html
+++ b/lib_soroban_rpc.js.html
@@ -24,7 +24,7 @@
@@ -45,19 +45,14 @@ lib/soroban_rpc.js
value: true
});
exports.SorobanRpc = void 0;
-// TODO: Better parsing for hashes
/* tslint:disable-next-line:no-namespace */
-/**
- * @namespace SorobanRpc
- */
+/** @namespace SorobanRpc */
let SorobanRpc = exports.SorobanRpc = void 0;
(function (_SorobanRpc) {
/** An XDR-parsed version of {@link RawLedgerEntryResult} */
/** @see https://soroban.stellar.org/api/methods/getLedgerEntries */
- /* Response for jsonrpc method `getNetwork`
- */
- /* Response for jsonrpc method `getLatestLedger`
- */
+ /** @see https://soroban.stellar.org/api/methods/getNetwork */
+ /** @see https://soroban.stellar.org/api/methods/getLatestLedger */
let GetTransactionStatus = /*#__PURE__*/function (GetTransactionStatus) {
GetTransactionStatus["SUCCESS"] = "SUCCESS";
GetTransactionStatus["NOT_FOUND"] = "NOT_FOUND";
@@ -65,6 +60,7 @@ lib/soroban_rpc.js
return GetTransactionStatus;
}({});
_SorobanRpc.GetTransactionStatus = GetTransactionStatus;
+ /** @see https://soroban.stellar.org/api/methods/getTransaction */
/**
* Simplifies {@link RawSimulateTransactionResponse} into separate interfaces
* based on status:
@@ -108,7 +104,7 @@ lib/soroban_rpc.js
diff --git a/lib_transaction.js.html b/lib_transaction.js.html
index 879e34f..13a333f 100644
--- a/lib_transaction.js.html
+++ b/lib_transaction.js.html
@@ -24,7 +24,7 @@
@@ -73,7 +73,7 @@ lib/transaction.js
return assembleTransaction(raw.innerTransaction, networkPassphrase, simulation);
}
if (!isSorobanTransaction(raw)) {
- throw new TypeError('unsupported transaction: must contain exactly one ' + 'invokeHostFunction, bumpFootprintExpiration, or restoreFootprint ' + 'operation');
+ throw new TypeError('unsupported transaction: must contain exactly one ' + 'invokeHostFunction, extendFootprintTtl, or restoreFootprint ' + 'operation');
}
let success = (0, _parsers.parseRawSimulation)(simulation);
if (!_soroban_rpc.SorobanRpc.isSimulationSuccess(success)) {
@@ -121,7 +121,7 @@ lib/transaction.js
}
switch (tx.operations[0].type) {
case 'invokeHostFunction':
- case 'bumpFootprintExpiration':
+ case 'extendFootprintTtl':
case 'restoreFootprint':
return true;
default:
@@ -139,7 +139,7 @@ lib/transaction.js
Returns:
diff --git a/Address.html b/Address.html index 2c661cd..f88c8ac 100644 --- a/Address.html +++ b/Address.html @@ -24,7 +24,7 @@
@@ -1428,7 +1428,7 @@
diff --git a/Asset.html b/Asset.html index fab5ef0..531c788 100644 --- a/Asset.html +++ b/Asset.html @@ -24,7 +24,7 @@
Returns:
diff --git a/Asset.html b/Asset.html index fab5ef0..531c788 100644 --- a/Asset.html +++ b/Asset.html @@ -24,7 +24,7 @@
@@ -2053,7 +2053,7 @@
diff --git a/Claimant.html b/Claimant.html index eb0014f..d141c32 100644 --- a/Claimant.html +++ b/Claimant.html @@ -24,7 +24,7 @@
Returns:
diff --git a/Claimant.html b/Claimant.html index eb0014f..d141c32 100644 --- a/Claimant.html +++ b/Claimant.html @@ -24,7 +24,7 @@
@@ -1625,7 +1625,7 @@
diff --git a/Contract.html b/Contract.html index 9be7787..a287034 100644 --- a/Contract.html +++ b/Contract.html @@ -24,7 +24,7 @@
diff --git a/ScInt.html b/ScInt.html index d26e353..490bc5d 100644 --- a/ScInt.html +++ b/ScInt.html @@ -24,7 +24,7 @@
Returns:
diff --git a/Contract.html b/Contract.html index 9be7787..a287034 100644 --- a/Contract.html +++ b/Contract.html @@ -24,7 +24,7 @@
@@ -368,13 +368,28 @@ callSource:
@@ -12124,7 +13516,7 @@ callSource:
See:
+
+
+
+
@@ -637,7 +652,7 @@ Returns:
- getFootprint() → {Array.<xdr.LedgerKey>}
+ getFootprint() → {xdr.LedgerKey}
@@ -645,8 +660,8 @@ getFootpr
Returns the read-only footprint entries necessary for any invocations to
-this contract, for convenience when adding it to your transaction's overall
-footprint or doing bump/restore operations.
+this contract, for convenience when manually adding it to your
+transaction's overall footprint or doing bump/restore operations.
@@ -724,7 +739,7 @@ Returns:
-Array.<xdr.LedgerKey>
+xdr.LedgerKey
@@ -732,8 +747,7 @@ Returns:
- the ledger keys containing the contract's code
-(first) and its deployed contract instance (second)
+ the ledger key for the deployed contract instance
@@ -864,7 +878,7 @@ Returns:
diff --git a/ContractSpec.html b/ContractSpec.html
index 56ce357..ec257a3 100644
--- a/ContractSpec.html
+++ b/ContractSpec.html
@@ -24,7 +24,7 @@
@@ -315,7 +315,7 @@ findEntrySource:
funcA
Source:
Returns:
Example
- const args = {
+ ```js
+const args = {
arg1: 'value1',
arg2: 1234
};
-const scArgs = contractSpec.funcArgsToScVals('funcName', args);
+const scArgs = contractSpec.funcArgsToScVals('funcName', args);
+```
@@ -736,7 +738,7 @@ funcRe
Source:
Returns:
Example
- const resultScv = 'AAA=='; // Base64 encoded ScVal
-const result = contractSpec.funcResToNative('funcName', resultScv);
+ ```js
+const resultScv = 'AAA=='; // Base64 encoded ScVal
+const result = contractSpec.funcResToNative('funcName', resultScv);
+```
@@ -1157,7 +1161,7 @@ nativeTo
Source:
scVal
Source:
scValToN
Source:
Returns:
diff --git a/FeeBumpTransaction.html b/FeeBumpTransaction.html
index e423bfb..3a6118a 100644
--- a/FeeBumpTransaction.html
+++ b/FeeBumpTransaction.html
@@ -24,7 +24,7 @@
@@ -2040,7 +2040,7 @@ Returns:
diff --git a/Int128_Int128.html b/Int128_Int128.html
index c15cf68..8419ac1 100644
--- a/Int128_Int128.html
+++ b/Int128_Int128.html
@@ -24,7 +24,7 @@
@@ -230,7 +230,7 @@ Parameters:
diff --git a/Int256_Int256.html b/Int256_Int256.html
index 0a00e6b..eb21507 100644
--- a/Int256_Int256.html
+++ b/Int256_Int256.html
@@ -24,7 +24,7 @@
@@ -230,7 +230,7 @@ Parameters:
diff --git a/Keypair.html b/Keypair.html
index 8bfa84d..85f20bb 100644
--- a/Keypair.html
+++ b/Keypair.html
@@ -24,7 +24,7 @@
@@ -2462,7 +2462,7 @@ Returns:
diff --git a/LiquidityPoolAsset.html b/LiquidityPoolAsset.html
index fc88db3..35b4193 100644
--- a/LiquidityPoolAsset.html
+++ b/LiquidityPoolAsset.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Returns:
diff --git a/LiquidityPoolId.html b/LiquidityPoolId.html
index c7b42aa..97c983a 100644
--- a/LiquidityPoolId.html
+++ b/LiquidityPoolId.html
@@ -24,7 +24,7 @@
@@ -867,7 +867,7 @@ Returns:
diff --git a/Memo.html b/Memo.html
index edc76c0..2dfe01b 100644
--- a/Memo.html
+++ b/Memo.html
@@ -24,7 +24,7 @@
@@ -1386,7 +1386,7 @@ Returns:
diff --git a/MuxedAccount.html b/MuxedAccount.html
index b56d531..8131865 100644
--- a/MuxedAccount.html
+++ b/MuxedAccount.html
@@ -24,7 +24,7 @@
@@ -985,7 +985,7 @@ Returns:
diff --git a/Operation.html b/Operation.html
index 33871e0..622a062 100644
--- a/Operation.html
+++ b/Operation.html
@@ -24,7 +24,7 @@
@@ -99,7 +99,7 @@ new Operatio
Operation.liquidityPoolDepositOperation.liquidityPoolWithdrawOperation.invokeHostFunctionOperation.bumpFootprintExpirationOperation.extendFootprintTtlOpOperation.restoreFootprintExample
- (static) bumpFootprintExpiration(opts) → {xdr.Operation}
+ (static) bumpSequence(opts) → {xdr.BumpSequenceOp}
- Builds an operation to bump the expiration of a footprint (read and written
-ledger keys). Its only parameter is the number of ledgers to extend
-expiration for.
-The footprint itself is derived from the transaction (see
-TransactionBuilder's opts.sorobanData parameter, which is a
-xdr.SorobanTransactionData instance that contains fee data & resource
-usage as part of xdr.SorobanResources).
+ This operation bumps sequence number.
@@ -1100,7 +1094,7 @@ (sta
Source:
Parameters:
- object holding operation parameters
+ Options object
@@ -1189,13 +1183,13 @@ Parameters:
- ledgersToExpirebumpTo
-number
+string
@@ -1214,9 +1208,7 @@ Parameters:
- the number of ledgers past the LCL
-(last closed ledger) by which to extend the validity of the ledger keys in
-this transaction
+ Sequence number to bump to.
@@ -1252,7 +1244,7 @@ Parameters:
- an optional source account
+ The optional source account.
@@ -1293,7 +1285,7 @@ Returns:
-xdr.Operation
+xdr.BumpSequenceOp
@@ -1301,8 +1293,7 @@ Returns:
- a Bump Footprint Expiration operation
-(xdr.BumpFootprintExpirationOp)
+ Operation
@@ -1317,14 +1308,15 @@ Returns:
- (static) bumpSequence(opts) → {xdr.BumpSequenceOp}
+ (static) changeTrust(opts) → {xdr.ChangeTrustOp}
- This operation bumps sequence number.
+ Returns an XDR ChangeTrustOp. A "change trust" operation adds, removes, or updates a
+trust line for a given asset from the source account to another.
@@ -1360,7 +1352,7 @@ (static) Source:
Parameters:
- bumpToasset
+
+
+Asset
+|
+
+LiquidityPoolAsset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The asset for the trust line.
+
+
+
+
+
+
+
+
+ limit
@@ -1464,6 +1493,8 @@ Parameters:
+ <optional>
+
@@ -1474,7 +1505,8 @@ Parameters:
- Sequence number to bump to.
+ The limit for the asset, defaults to max int64.
+If the limit is set to "0" it deletes the trustline.
@@ -1510,7 +1542,7 @@ Parameters:
- The optional source account.
+ The source account (defaults to transaction source).
@@ -1551,7 +1583,7 @@ Returns:
-xdr.BumpSequenceOp
+xdr.ChangeTrustOp
@@ -1559,7 +1591,7 @@ Returns:
- Operation
+ Change Trust operation
@@ -1574,15 +1606,14 @@ Returns:
- (static) changeTrust(opts) → {xdr.ChangeTrustOp}
+ (static) claimClaimableBalance(opts) → {xdr.Operation}
- Returns an XDR ChangeTrustOp. A "change trust" operation adds, removes, or updates a
-trust line for a given asset from the source account to another.
+ Create a new claim claimable balance operation.
@@ -1618,7 +1649,7 @@ (static)
Source:
Parameters:
- asset
-
-
-Asset
-|
-
-LiquidityPoolAsset
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The asset for the trust line.
-
-
-
-
-
-
-
-
- limitbalanceId
@@ -1759,8 +1753,6 @@ Parameters:
- <optional>
-
@@ -1771,8 +1763,7 @@ Parameters:
- The limit for the asset, defaults to max int64.
-If the limit is set to "0" it deletes the trustline.
+ The claimable balance id to be claimed.
@@ -1808,7 +1799,7 @@ Parameters:
- The source account (defaults to transaction source).
+ The source account for the operation. Defaults to the transaction's source account.
@@ -1849,7 +1840,7 @@ Returns:
-xdr.ChangeTrustOp
+xdr.Operation
@@ -1857,7 +1848,7 @@ Returns:
- Change Trust operation
+ Claim claimable balance operation
@@ -1865,6 +1856,15 @@ Returns:
+
+Example
+
+ const op = Operation.claimClaimableBalance({
+ balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
+});
+
+
+
@@ -1872,14 +1872,14 @@ Returns:
- (static) claimClaimableBalance(opts) → {xdr.Operation}
+ (static) clawback(opts) → {xdr.ClawbackOp}
- Create a new claim claimable balance operation.
+ Creates a clawback operation.
@@ -1915,13 +1915,20 @@ (stati
Source:
See:
+
+
+
+
@@ -2004,7 +2011,41 @@ Parameters:
- balanceIdasset
+
+
+Asset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The asset being clawed back.
+
+
+
+
+
+
+
+
+ amount
@@ -2029,7 +2070,42 @@ Parameters:
- The claimable balance id to be claimed.
+ The amount of the asset to claw back.
+
+
+
+
+
+
+
+
+ from
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The public key of the (optionally-muxed)
+account to claw back from.
@@ -2065,7 +2141,8 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
+ The source account for the operation.
+Defaults to the transaction's source account.
@@ -2106,31 +2183,18 @@ Returns:
-xdr.Operation
+xdr.ClawbackOp
-
- Claim claimable balance operation
-
-
-
-Example
-
- const op = Operation.claimClaimableBalance({
- balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
-});
-
-
-
@@ -2138,14 +2202,14 @@ Example
- (static) clawback(opts) → {xdr.ClawbackOp}
+ (static) clawbackClaimableBalance(opts) → {xdr.ClawbackClaimableBalanceOp}
- Creates a clawback operation.
+ Creates a clawback operation for a claimable balance.
@@ -2181,20 +2245,13 @@ (static) cla
Source:
See:
-
-
-
-
@@ -2277,75 +2334,7 @@ Parameters:
- asset
-
-
-Asset
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The asset being clawed back.
-
-
-
-
-
-
-
-
- amount
-
-
-string
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The amount of the asset to claw back.
-
-
-
-
-
-
-
-
- frombalanceId
@@ -2370,8 +2359,7 @@ Parameters:
- The public key of the (optionally-muxed)
-account to claw back from.
+ The claimable balance ID to be clawed back.
@@ -2407,8 +2395,7 @@ Parameters:
- The source account for the operation.
-Defaults to the transaction's source account.
+ The source account for the operation. Defaults to the transaction's source account.
@@ -2449,7 +2436,7 @@ Returns:
-xdr.ClawbackOp
+xdr.ClawbackClaimableBalanceOp
@@ -2461,6 +2448,15 @@ Returns:
+
+Example
+
+ const op = Operation.clawbackClaimableBalance({
+ balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
+});
+
+
+
@@ -2468,14 +2464,14 @@ Returns:
- (static) clawbackClaimableBalance(opts) → {xdr.ClawbackClaimableBalanceOp}
+ (static) createAccount(opts) → {xdr.CreateAccountOp}
- Creates a clawback operation for a claimable balance.
+ Create and fund a non existent account.
@@ -2511,7 +2507,7 @@ (st
Source:
Parameters:
- balanceIddestination
@@ -2625,7 +2621,42 @@ Parameters:
- The claimable balance ID to be clawed back.
+ Destination account ID to create an account for.
+
+
+
+
+
+
+
+
+ startingBalance
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Amount in XLM the account should be funded for. Must be greater
+than the reserve balance amount.
@@ -2661,7 +2692,7 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
+ The source account for the payment. Defaults to the transaction's source account.
@@ -2702,26 +2733,21 @@ Returns:
-xdr.ClawbackClaimableBalanceOp
+xdr.CreateAccountOp
-
+
+ Create account operation
+
+
-
-Example
-
- const op = Operation.clawbackClaimableBalance({
- balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
-});
-
-
@@ -2730,14 +2756,14 @@ Example
- (static) createAccount(opts) → {xdr.CreateAccountOp}
+ (static) createClaimableBalance(opts) → {xdr.Operation}
- Create and fund a non existent account.
+ Create a new claimable balance operation.
@@ -2773,7 +2799,7 @@ (static) Source:
Parameters:
- destinationasset
-string
+Asset
@@ -2887,7 +2913,7 @@ Parameters:
- Destination account ID to create an account for.
+ The asset for the claimable balance.
@@ -2896,7 +2922,7 @@ Parameters:
- startingBalanceamount
@@ -2921,8 +2947,41 @@ Parameters:
- Amount in XLM the account should be funded for. Must be greater
-than the reserve balance amount.
+ Amount.
+
+
+
+
+
+
+
+
+ claimants
+
+
+Array.<Claimant>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An array of Claimants
@@ -2958,7 +3017,7 @@ Parameters:
- The source account for the payment. Defaults to the transaction's source account.
+ The source account for the operation. Defaults to the transaction's source account.
@@ -2999,7 +3058,7 @@ Returns:
-xdr.CreateAccountOp
+xdr.Operation
@@ -3007,7 +3066,7 @@ Returns:
- Create account operation
+ Create claimable balance operation
@@ -3015,6 +3074,29 @@ Returns:
+
+Example
+
+ const asset = new Asset(
+ 'USD',
+ 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
+);
+const amount = '100.0000000';
+const claimants = [
+ new Claimant(
+ 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ',
+ Claimant.predicateBeforeAbsoluteTime("4102444800000")
+ )
+];
+
+const op = Operation.createClaimableBalance({
+ asset,
+ amount,
+ claimants
+});
+
+
+
@@ -3022,14 +3104,14 @@ Returns:
- (static) createClaimableBalance(opts) → {xdr.Operation}
+ (static) createCustomContract(opts) → {xdr.Operation}
- Create a new claimable balance operation.
+ Returns an operation that creates a custom WASM contract.
@@ -3065,13 +3147,20 @@ (stat
Source:
See:
+
+
+
+
@@ -3115,7 +3204,7 @@ Parameters:
-object
+any
@@ -3126,7 +3215,7 @@ Parameters:
- Options object
+ the set of parameters
@@ -3154,13 +3243,13 @@ Parameters:
- assetaddress
-Asset
+Address
@@ -3179,7 +3268,7 @@ Parameters:
- The asset for the claimable balance.
+ the contract uploader address
@@ -3188,13 +3277,16 @@ Parameters:
- amountwasmHash
-string
+Uint8Array
+|
+
+Buffer
@@ -3213,7 +3305,9 @@ Parameters:
- Amount.
+ the SHA-256 hash of the contract
+WASM you're uploading (see hash and
+Operation.uploadContractWasm)
@@ -3222,13 +3316,16 @@ Parameters:
- claimantssalt
-Array.<Claimant>
+Uint8Array
+|
+
+Buffer
@@ -3237,6 +3334,8 @@ Parameters:
+ <optional>
+
@@ -3247,7 +3346,46 @@ Parameters:
- An array of Claimants
+ an optional, 32-byte salt to
+distinguish deployment instances of the same wasm from the same user (if
+omitted, one will be generated for you)
+
+
+
+
+
+
+
+
+ auth
+
+
+Array.<xdr.SorobanAuthorizationEntry>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ an optional list
+outlining the tree of authorizations required for the call
@@ -3283,7 +3421,7 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
+ an optional source account
@@ -3332,7 +3470,8 @@ Returns:
- Create claimable balance operation
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
@@ -3340,29 +3479,6 @@ Returns:
-
-Example
-
- const asset = new Asset(
- 'USD',
- 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
-);
-const amount = '100.0000000';
-const claimants = [
- new Claimant(
- 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ',
- Claimant.predicateBeforeAbsoluteTime("4102444800000")
- )
-];
-
-const op = Operation.createClaimableBalance({
- asset,
- amount,
- claimants
-});
-
-
-
@@ -3850,14 +3966,14 @@ Returns:
- (static) endSponsoringFutureReserves(opts) → {xdr.Operation}
+ (static) createStellarAssetContract(opts) → {xdr.Operation}
- Create an "end sponsoring future reserves" operation.
+ Returns an operation that wraps a Stellar asset into a token contract.
@@ -3893,13 +4009,26 @@
Source:
See:
+
+
+
+
@@ -3943,7 +4072,7 @@ Parameters:
-object
+any
@@ -3954,7 +4083,7 @@ Parameters:
- Options object
+ the set of parameters
@@ -3980,6 +4109,81 @@ Parameters:
+
+
+ asset
+
+
+Asset
+|
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ the Stellar asset to wrap, either as an
+Asset object or in canonical form (SEP-11, code:issuer)
+
+
+
+
+
+
+
+
+ auth
+
+
+Array.<xdr.SorobanAuthorizationEntry>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ an optional list
+outlining the tree of authorizations required for the call
+
+
+
+
+
+
sourceParameters:
- The source account for the operation. Defaults to the transaction's source account.
+ an optional source account
@@ -4058,7 +4262,8 @@ Returns:
- xdr operation
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
@@ -4066,13 +4271,6 @@ Returns:
-
-Example
-
- const op = Operation.endSponsoringFutureReserves();
-
-
-
@@ -4080,15 +4278,14 @@ Example
- (static) fromXDRObject(operation) → {Operation}
+ (static) endSponsoringFutureReserves(opts) → {xdr.Operation}
- Deconstructs the raw XDR operation object into the structured object that
-was used to create the operation (i.e. the opts parameter to most ops).
+ Create an "end sponsoring future reserves" operation.
@@ -4124,7 +4321,7 @@ (static) Source:
Parameters:
- operationopts
-xdr.Operation
+object
@@ -4185,7 +4382,70 @@ Parameters:
- An XDR Operation.
+ Options object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ source
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The source account for the operation. Defaults to the transaction's source account.
+
+
+
+
+
+
+
+
@@ -4218,33 +4478,50 @@ Returns:
-Operation
+xdr.Operation
+
+ xdr operation
+
+
-
-
-
-
+
+Example
+
+ const op = Operation.endSponsoringFutureReserves();
+
+
+
+
+
+
+
- (static) inflation(optsopt) → {xdr.InflationOp}
+ (static) extendFootprintTtl(opts) → {xdr.Operation}
- This operation generates the inflation.
+ Builds an operation to bump the expiration of a footprint (read and written
+ledger keys). Its only parameter is the number of ledgers to extend
+expiration for.
+The footprint itself is derived from the transaction (see
+TransactionBuilder's opts.sorobanData parameter, which is a
+xdr.SorobanTransactionData instance that contains fee data & resource
+usage as part of xdr.SorobanResources).
@@ -4280,7 +4557,7 @@ (static) in
Source:
Parameters:
Type
- Attributes
-
@@ -4339,21 +4614,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
- Options object
+ object holding operation parameters
@@ -4379,6 +4644,42 @@ Parameters:
+
+
+ extendTo
+
+
+number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ the number of ledgers past the LCL
+(last closed ledger) by which to extend the validity of the ledger keys in
+this transaction
+
+
+
+
+
+
sourceParameters:
- The optional source account.
+ an optional source account
@@ -4449,7 +4750,7 @@ Returns:
-xdr.InflationOp
+xdr.Operation
@@ -4457,7 +4758,8 @@ Returns:
- Inflation operation
+ a Bump Footprint Expiration operation
+(xdr.ExtendFootprintTTLOp)
@@ -4472,14 +4774,15 @@ Returns:
- (static) invokeHostFunction(opts) → {xdr.Operation}
+ (static) fromXDRObject(operation) → {Operation}
- Invokes a single smart contract function.
+ Deconstructs the raw XDR operation object into the structured object that
+was used to create the operation (i.e. the opts parameter to most ops).
@@ -4515,7 +4818,7 @@ (static)
Source:
Parameters:
- opts
-
-
-object
-
-
-
-
-
-
-
-
-
-
- options object
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- func
-
-
-xdr.HostFunction
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- host function to execute (with its
-wrapped parameters)
-
-
-
-
-
-
-
-
- auth
-
-
-Array.<xdr.SorobanAuthorizationEntry>
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- list outlining the
-tree of authorizations required for the call
-
-
-
-
-
-
-
-
- sourceoperation
-string
+xdr.Operation
-
-
- <optional>
-
-
-
-
-
-
-
- an optional source account
-
-
-
-
-
-
-
-
+ An XDR Operation.
@@ -4744,18 +4912,13 @@ Returns:
-xdr.Operation
+Operation
-
- an Invoke Host Function operation
-(xdr.InvokeHostFunctionOp)
-
-
@@ -4768,19 +4931,14 @@ Returns:
- (static) isValidAmount(value, allowZero) → {boolean}
+ (static) inflation(optsopt) → {xdr.InflationOp}
- Validates that a given amount is possible for a Stellar asset.
-Specifically, this means that the amount is well, a valid number, but also
-that it is within the int64 range and has no more than 7 decimal levels of
-precision.
-Note that while smart contracts allow larger amounts, this is oriented
-towards validating the standard Stellar operations.
+ This operation generates the inflation.
@@ -4816,7 +4974,7 @@ (static) Source:
Parameters:
Type
-
+ Attributes
- Default
+
Description
@@ -4862,60 +5020,97 @@ Parameters:
- valueopts
-string
+object
+
+
+ <optional>
+
+
+
-
-
+
+
- the amount to validate
+ Options object
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- allowZerosource
-boolean
+string
+
+
+ <optional>
+
-
-
- false
+
+
+
- optionally, whether or not zero is valid (default: no)
+ The optional source account.
+
+
+
+
+
+
+
+
@@ -4948,13 +5143,17 @@ Returns:
-boolean
+xdr.InflationOp
+
+ Inflation operation
+
+
@@ -4967,14 +5166,14 @@ Returns:
- (static) liquidityPoolDeposit(opts) → {xdr.Operation}
+ (static) invokeContractFunction(opts) → {xdr.Operation}
- Creates a liquidity pool deposit operation.
+ Returns an operation that invokes a contract function.
@@ -5010,7 +5209,7 @@ (static
Source:
(static
See:
@@ -5067,7 +5270,7 @@ Parameters:
-object
+any
@@ -5078,7 +5281,7 @@ Parameters:
- Options object
+ the set of parameters
@@ -5106,7 +5309,7 @@ Parameters:
- liquidityPoolIdcontract
@@ -5131,7 +5334,7 @@ Parameters:
- The liquidity pool ID.
+ a strkey-fied contract address (C...)
@@ -5140,7 +5343,7 @@ Parameters:
- maxAmountAfunction
@@ -5165,7 +5368,7 @@ Parameters:
- Maximum amount of first asset to deposit.
+ the name of the contract fn to invoke
@@ -5174,13 +5377,13 @@ Parameters:
- maxAmountBargs
-string
+Array.<xdr.ScVal>
@@ -5199,7 +5402,9 @@ Parameters:
- Maximum amount of second asset to deposit.
+ parameters to pass to the function
+invocation (try nativeToScVal or ScInt to make building
+these easier)
@@ -5208,22 +5413,13 @@ Parameters:
- minPriceauth
-number
-|
-
-string
-|
-
-BigNumber
-|
-
-Object
+Array.<xdr.SorobanAuthorizationEntry>
@@ -5232,6 +5428,8 @@ Parameters:
+ <optional>
+
@@ -5242,76 +5440,44 @@ Parameters:
- Minimum depositA/depositB price.
+ an optional list
+outlining the tree of authorizations required for the call
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- nsource
-number
+string
-
-
-
-
- If opts.minPrice is an object: the price numerator
+
-
-
-
-
-
-
-
- d
-
+ <optional>
-number
-
-
-
+
+
+
- If opts.minPrice is an object: the price denominator
+ an optional source account
@@ -5325,243 +5491,80 @@ Parameters:
+
+
-
-
- maxPrice
-
-
-number
-|
-string
-|
-BigNumber
-|
-Object
-
-
-
-
-
-
-
-
-
-
-
- Maximum depositA/depositB price.
-
-
-
-
-
-
- Name
-
- Type
+
+Returns:
+
+ -
+ Type:
+
+ -
+
xdr.Operation
- Description
-
-
-
-
+
+
-
-
- n
-
-
-number
+
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
+
+
+
-
-
-
+
+
+
-
- If opts.maxPrice is an object: the price numerator
-
-
-
+
+
+ (static) invokeHostFunction(opts) → {xdr.Operation}
-
-
- d
-
-
-number
+
+ Invokes a single smart contract host function.
+
-
-
-
-
-
- If opts.maxPrice is an object: the price denominator
-
-
-
+
+
-
-
-
-
-
+
-
-
- source
-
-
-string
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The source account for the operation. Defaults to the transaction's source account.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
xdr.Operation
-
-
-
-
-
-
-
- The resulting operation (xdr.LiquidityPoolDepositOp).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- (static) liquidityPoolWithdraw(opts) → {xdr.Operation}
-
-
-
-
-
-
- Creates a liquidity pool withdraw operation.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
@@ -5582,7 +5585,7 @@ (stati
- Source:
(stati
- See:
-
- - https://developers.stellar.org/docs/start/list-of-operations/#liquidity-pool-withdraw
+ - https://soroban.stellar.org/docs/fundamentals-and-concepts/invoking-contracts-with-transactions#function
+
+ - Operation.invokeContractFunction
+
+ - Operation.createCustomContract
+
+ - Operation.createStellarAssetContract
+
+ - Operation.uploadContractWasm
+
+ - Contract.call
@@ -5650,7 +5663,7 @@ Parameters:
- Options object
+ options object
@@ -5678,47 +5691,13 @@ Parameters:
- liquidityPoolId
-
-
-string
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The liquidity pool ID.
-
-
-
-
-
-
-
-
- amountfunc
-string
+xdr.HostFunction
@@ -5737,7 +5716,8 @@ Parameters:
- Amount of pool shares to withdraw.
+ host function to execute (with its
+wrapped parameters)
@@ -5746,13 +5726,13 @@ Parameters:
- minAmountAauth
-string
+Array.<xdr.SorobanAuthorizationEntry>
@@ -5761,39 +5741,7 @@ Parameters:
-
-
-
-
-
-
-
-
-
-
- Minimum amount of first asset to withdraw.
-
-
-
-
-
-
-
-
- minAmountB
-
-
-string
-
-
-
-
-
-
-
+ <optional>
@@ -5805,7 +5753,8 @@ Parameters:
- Minimum amount of second asset to withdraw.
+ list outlining the
+tree of authorizations required for the call
@@ -5841,7 +5790,7 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
+ an optional source account
@@ -5890,7 +5839,8 @@ Returns:
- The resulting operation (xdr.LiquidityPoolWithdrawOp).
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
@@ -5905,15 +5855,19 @@ Returns:
- (static) manageBuyOffer(opts) → {xdr.ManageBuyOfferOp}
+ (static) isValidAmount(value, allowZero) → {boolean}
- Returns a XDR ManageBuyOfferOp. A "manage buy offer" operation creates, updates, or
-deletes a buy offer.
+ Validates that a given amount is possible for a Stellar asset.
+Specifically, this means that the amount is well, a valid number, but also
+that it is within the int64 range and has no more than 7 decimal levels of
+precision.
+Note that while smart contracts allow larger amounts, this is oriented
+towards validating the standard Stellar operations.
@@ -5949,7 +5903,7 @@ (static) Source:
Parameters:
+ Default
+
Description
@@ -5993,13 +5949,13 @@ Parameters:
- optsvalue
-object
+string
@@ -6008,43 +5964,1174 @@ Parameters:
+
+
+
+
- Options object
+ the amount to validate
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+
+
-
- sellingallowZero
-Asset
+boolean
+
+
+
+
+
+
+
+
+
+
+ false
+
+
+
+
+
+ optionally, whether or not zero is valid (default: no)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
boolean
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (static) liquidityPoolDeposit(opts) → {xdr.Operation}
+
+
+
+
+
+
+ Creates a liquidity pool deposit operation.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ opts
+
+
+object
+
+
+
+
+
+
+
+
+
+
+ Options object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ liquidityPoolId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The liquidity pool ID.
+
+
+
+
+
+
+
+
+ maxAmountA
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Maximum amount of first asset to deposit.
+
+
+
+
+
+
+
+
+ maxAmountB
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Maximum amount of second asset to deposit.
+
+
+
+
+
+
+
+
+ minPrice
+
+
+number
+|
+
+string
+|
+
+BigNumber
+|
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Minimum depositA/depositB price.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ n
+
+
+number
+
+
+
+
+
+
+
+
+
+
+ If opts.minPrice is an object: the price numerator
+
+
+
+
+
+
+
+
+ d
+
+
+number
+
+
+
+
+
+
+
+
+
+
+ If opts.minPrice is an object: the price denominator
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ maxPrice
+
+
+number
+|
+
+string
+|
+
+BigNumber
+|
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Maximum depositA/depositB price.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ n
+
+
+number
+
+
+
+
+
+
+
+
+
+
+ If opts.maxPrice is an object: the price numerator
+
+
+
+
+
+
+
+
+ d
+
+
+number
+
+
+
+
+
+
+
+
+
+
+ If opts.maxPrice is an object: the price denominator
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ source
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The source account for the operation. Defaults to the transaction's source account.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
xdr.Operation
+
+
+
+
+
+
+
+ The resulting operation (xdr.LiquidityPoolDepositOp).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (static) liquidityPoolWithdraw(opts) → {xdr.Operation}
+
+
+
+
+
+
+ Creates a liquidity pool withdraw operation.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ opts
+
+
+object
+
+
+
+
+
+
+
+
+
+
+ Options object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ liquidityPoolId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The liquidity pool ID.
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Amount of pool shares to withdraw.
+
+
+
+
+
+
+
+
+ minAmountA
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Minimum amount of first asset to withdraw.
+
+
+
+
+
+
+
+
+ minAmountB
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Minimum amount of second asset to withdraw.
+
+
+
+
+
+
+
+
+ source
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The source account for the operation. Defaults to the transaction's source account.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
xdr.Operation
+
+
+
+
+
+
+
+ The resulting operation (xdr.LiquidityPoolWithdrawOp).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (static) manageBuyOffer(opts) → {xdr.ManageBuyOfferOp}
+
+
+
+
+
+
+ Returns a XDR ManageBuyOfferOp. A "manage buy offer" operation creates, updates, or
+deletes a buy offer.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ opts
+
+
+object
+
+
+
+
+
+
+
+
+
+
+ Options object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ selling
+
+
+Asset
@@ -8289,44 +9376,265 @@ Parameters:
asset
-
-
-Asset
+
+
+
+Asset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ asset to send
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ amount to send
+
+
+
+
+
+
+
+
+ source
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The source account for the payment.
+Defaults to the transaction's source account.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
xdr.Operation
+
+
+
+
+
+
+
+ The resulting payment operation (xdr.PaymentOp)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (static) restoreFootprint(optsopt) → {xdr.Operation}
+
+
+
+
+
+
+ Builds a footprint restoration operation.
+It takes no parameters because the relevant footprint is derived from the
+transaction itself (see TransactionBuilder's opts.sorobanData
+parameter (or TransactionBuilder.setSorobanData /
+TransactionBuilder.setLedgerKeys), which is a
+xdr.SorobanTransactionData instance that contains fee data & resource
+usage as part of xdr.SorobanTransactionData).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
-
-
-
-
-
+ Parameters:
+
-
+
+
+
+
+ Name
+
-
-
-
+ Type
-
+
+ Attributes
+
-
- asset to send
-
-
-
+
+ Description
+
+
+
+
- amountopts
-string
+object
@@ -8335,6 +9643,8 @@ Parameters:
+ <optional>
+
@@ -8345,11 +9655,30 @@ Parameters:
- amount to send
+ an optional set of parameters
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
@@ -8381,8 +9710,7 @@ Parameters:
- The source account for the payment.
-Defaults to the transaction's source account.
+ an optional source account
@@ -8431,7 +9759,8 @@ Returns:
- The resulting payment operation (xdr.PaymentOp)
+ a Bump Footprint Expiration operation
+(xdr.RestoreFootprintOp)
@@ -8446,20 +9775,14 @@ Returns:
- (static) restoreFootprint(optsopt) → {xdr.Operation}
+ (static) revokeAccountSponsorship(opts) → {xdr.Operation}
- Builds a footprint restoration operation.
-It takes no parameters because the relevant footprint is derived from the
-transaction itself (see TransactionBuilder's opts.sorobanData
-parameter (or TransactionBuilder.setSorobanData /
-TransactionBuilder.setLedgerKeys), which is a
-xdr.SorobanTransactionData instance that contains fee data & resource
-usage as part of xdr.SorobanTransactionData).
+ Create a "revoke sponsorship" operation for an account.
@@ -8495,7 +9818,7 @@ (static) Source:
Parameters:
Type
- Attributes
-
@@ -8554,21 +9875,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
- an optional set of parameters
+ Options object
@@ -8594,6 +9905,40 @@ Parameters:
+
+
+ account
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The sponsored account ID.
+
+
+
+
+
+
sourceParameters:
- an optional source account
+ The source account for the operation. Defaults to the transaction's source account.
@@ -8672,8 +10017,7 @@ Returns:
- a Bump Footprint Expiration operation
-(xdr.RestoreFootprintOp)
+ xdr operation
@@ -8681,6 +10025,15 @@ Returns:
+
+Example
+
+ const op = Operation.revokeAccountSponsorship({
+ account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
+});
+
+
+
@@ -8688,14 +10041,14 @@ Returns:
- (static) revokeAccountSponsorship(opts) → {xdr.Operation}
+ (static) revokeClaimableBalanceSponsorship(opts) → {xdr.Operation}
- Create a "revoke sponsorship" operation for an account.
+ Create a "revoke sponsorship" operation for a claimable balance.
@@ -8731,7 +10084,7 @@ (st
- Source:
Parameters:
- accountbalanceId
@@ -8845,7 +10198,7 @@ Parameters:
- The sponsored account ID.
+ The sponsored claimable balance ID.
@@ -8941,8 +10294,8 @@ Returns:
Example
- const op = Operation.revokeAccountSponsorship({
- account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
+ const op = Operation.revokeClaimableBalanceSponsorship({
+ balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
});
@@ -8954,14 +10307,14 @@ Example
- (static) revokeClaimableBalanceSponsorship(opts) → {xdr.Operation}
+ (static) revokeDataSponsorship(opts) → {xdr.Operation}
- Create a "revoke sponsorship" operation for a claimable balance.
+ Create a "revoke sponsorship" operation for a data entry.
@@ -8997,7 +10350,7 @@ Source:
Parameters:
- balanceIdaccount
@@ -9111,7 +10464,41 @@ Parameters:
- The sponsored claimable balance ID.
+ The account ID which owns the data entry.
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The name of the data entry
@@ -9207,8 +10594,9 @@ Returns:
Example
- const op = Operation.revokeClaimableBalanceSponsorship({
- balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
+ const op = Operation.revokeDataSponsorship({
+ account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
+ name: 'foo'
});
@@ -9220,14 +10608,14 @@ Example
- (static) revokeDataSponsorship(opts) → {xdr.Operation}
+ (static) revokeLiquidityPoolSponsorship(opts) → {xdr.Operation}
- Create a "revoke sponsorship" operation for a data entry.
+ Creates a "revoke sponsorship" operation for a liquidity pool.
@@ -9263,7 +10651,7 @@ (stati
- Source:
Parameters:
- Options object
+ – Options object.
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- account
-
-
-string
-
-
-
-
-
-
-
-
+
+
+ Name
+
-
+ Type
-
-
-
+
+ Attributes
+
-
+
-
- The account ID which owns the data entry.
-
-
-
+ Description
+
+
+
- nameliquidityPoolId
@@ -9411,7 +10765,7 @@ Parameters:
- The name of the data entry
+ The sponsored liquidity pool ID in 'hex' string.
@@ -9496,7 +10850,7 @@ Returns:
- xdr operation
+ xdr Operation.
@@ -9507,9 +10861,8 @@ Returns:
Example
- const op = Operation.revokeDataSponsorship({
- account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
- name: 'foo'
+ const op = Operation.revokeLiquidityPoolSponsorship({
+ liquidityPoolId: 'dd7b1ab831c273310ddbec6f97870aa83c2fbd78ce22aded37ecbf4f3380fac7',
});
@@ -9521,14 +10874,14 @@ Example
- (static) revokeLiquidityPoolSponsorship(opts) → {xdr.Operation}
+ (static) revokeOfferSponsorship(opts) → {xdr.Operation}
- Creates a "revoke sponsorship" operation for a liquidity pool.
+ Create a "revoke sponsorship" operation for an offer.
@@ -9564,7 +10917,7 @@ Source:
Parameters:
- – Options object.
+ Options object
@@ -9653,7 +11006,7 @@ Parameters:
- liquidityPoolIdseller
@@ -9678,7 +11031,41 @@ Parameters:
- The sponsored liquidity pool ID in 'hex' string.
+ The account ID which created the offer.
+
+
+
+
+
+
+
+
+ offerId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The offer ID.
@@ -9763,7 +11150,7 @@ Returns:
- xdr Operation.
+ xdr operation
@@ -9774,8 +11161,9 @@ Returns:
Example
- const op = Operation.revokeLiquidityPoolSponsorship({
- liquidityPoolId: 'dd7b1ab831c273310ddbec6f97870aa83c2fbd78ce22aded37ecbf4f3380fac7',
+ const op = Operation.revokeOfferSponsorship({
+ seller: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
+ offerId: '1234'
});
@@ -9787,14 +11175,14 @@ Example
- (static) revokeOfferSponsorship(opts) → {xdr.Operation}
+ (static) revokeSignerSponsorship(opts) → {xdr.Operation}
- Create a "revoke sponsorship" operation for an offer.
+ Create a "revoke sponsorship" operation for a signer.
@@ -9830,7 +11218,7 @@ (stat
- Source:
Parameters:
- selleraccount
@@ -9944,7 +11332,7 @@ Parameters:
- The account ID which created the offer.
+ The account ID where the signer sponsorship is being removed from.
@@ -9953,7 +11341,60 @@ Parameters:
- offerIdsigner
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The signer whose sponsorship is being removed.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ ed25519PublicKey
@@ -9968,6 +11409,8 @@ Parameters:
+ <optional>
+
@@ -9978,7 +11421,93 @@ Parameters:
- The offer ID.
+ The ed25519 public key of the signer.
+
+
+
+
+
+
+
+
+ sha256Hash
+
+
+Buffer
+|
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ sha256 hash (Buffer or hex string).
+
+
+
+
+
+
+
+
+ preAuthTx
+
+
+Buffer
+|
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Hash (Buffer or hex string) of transaction.
+
+
+
+
+
+
+
+
@@ -10074,10 +11603,12 @@ Returns:
Example
- const op = Operation.revokeOfferSponsorship({
- seller: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
- offerId: '1234'
-});
+ const op = Operation.revokeSignerSponsorship({
+ account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
+ signer: {
+ ed25519PublicKey: 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ'
+ }
+})
@@ -10088,14 +11619,14 @@ Example
- (static) revokeSignerSponsorship(opts) → {xdr.Operation}
+ (static) revokeTrustlineSponsorship(opts) → {xdr.Operation}
- Create a "revoke sponsorship" operation for a signer.
+ Create a "revoke sponsorship" operation for a trustline.
@@ -10131,7 +11662,7 @@ (sta
- Source:
Parameters:
- The account ID where the signer sponsorship is being removed from.
-
-
-
-
-
-
-
-
- signer
-
-
-object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The signer whose sponsorship is being removed.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ed25519PublicKey
-
-
-string
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The ed25519 public key of the signer.
-
-
-
-
-
-
-
-
- sha256Hash
-
-
-Buffer
-|
-
-string
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- sha256 hash (Buffer or hex string).
+ The account ID which owns the trustline.
@@ -10382,16 +11785,16 @@ Parameters:
- preAuthTxasset
-Buffer
+Asset
|
-string
+LiquidityPoolId
@@ -10400,8 +11803,6 @@ Parameters:
- <optional>
-
@@ -10412,15 +11813,7 @@ Parameters:
- Hash (Buffer or hex string) of transaction.
-
-
-
-
-
-
-
-
+ The trustline asset.
@@ -10516,12 +11909,13 @@ Returns:
Example
- const op = Operation.revokeSignerSponsorship({
+ const op = Operation.revokeTrustlineSponsorship({
account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
- signer: {
- ed25519PublicKey: 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ'
- }
-})
+ asset: new StellarBase.LiquidityPoolId(
+ 'USDUSD',
+ 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
+ )
+});
@@ -10532,14 +11926,23 @@ Example
- (static) revokeTrustlineSponsorship(opts) → {xdr.Operation}
+ (static) setOptions(opts) → {xdr.SetOptionsOp}
- Create a "revoke sponsorship" operation for a trustline.
+ Returns an XDR SetOptionsOp. A "set options" operations set or clear account flags,
+set the account's inflation destination, and/or add new signers to the account.
+The flags used in opts.clearFlags and opts.setFlags can be the following:
+
+It's possible to set/clear multiple flags at once using logical or.
@@ -10575,13 +11978,20 @@ (
- Source:
- See:
+ -
+
+
+
+
@@ -10659,17 +12069,95 @@ Parameters:
-
+
+
+
+
+
+ inflationDest
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Set this account ID as the account's inflation destination.
+
+
+
+
+
+
+
+
+ clearFlags
+
+
+number
+|
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Bitmap integer for which account flags to clear.
+
+
+
+
- accountsetFlags
+number
+|
+
string
@@ -10679,6 +12167,8 @@ Parameters:
+ <optional>
+
@@ -10689,7 +12179,7 @@ Parameters:
- The account ID which owns the trustline.
+ Bitmap integer for which account flags to set.
@@ -10698,16 +12188,16 @@ Parameters:
- assetmasterWeight
-Asset
+number
|
-LiquidityPoolId
+string
@@ -10716,6 +12206,8 @@ Parameters:
+ <optional>
+
@@ -10726,7 +12218,7 @@ Parameters:
- The trustline asset.
+ The master key weight.
@@ -10735,12 +12227,15 @@ Parameters:
- sourcelowThreshold
+number
+|
+
string
@@ -10762,187 +12257,94 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
-
-
-
-
-
-
-
-
+ The sum weight for the low threshold.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
xdr.Operation
-
-
-
-
-
-
-
- xdr operation
-
-
-
-
-
-
-
-Example
-
- const op = Operation.revokeTrustlineSponsorship({
- account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
- asset: new StellarBase.LiquidityPoolId(
- 'USDUSD',
- 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
- )
-});
-
-
-
-
-
+
+
+ medThreshold(static) setOptions(opts) → {xdr.SetOptionsOp}
-
-
-
-
-
-
- Returns an XDR SetOptionsOp. A "set options" operations set or clear account flags,
-set the account's inflation destination, and/or add new signers to the account.
-The flags used in opts.clearFlags and opts.setFlags can be the following:
-
-It's possible to set/clear multiple flags at once using logical or.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+number
+|
-
+string
-
-
+
+
-
+
+
+
+ <optional>
+
-
+
-
- - Source:
-
+
-
+
-
- - See:
- -
-
-
-
-
+
+ The sum weight for the medium threshold.
+
+
+
-
-
-
-
-
+
+
+ highThreshold
+
+
+number
+|
+string
- Parameters:
-
+
+
-
-
-
-
- Name
-
+
+
+
+ <optional>
+
- Type
+
-
+
+
+
-
+
- Description
-
-
+
+ The sum weight for the high threshold.
+
+
+
-
- optssigner
@@ -10955,11 +12357,22 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- Options object
+ Add or remove a signer from the account. The signer is
+deleted if the weight is 0. Only one of ed25519PublicKey, sha256Hash, preAuthTx should be defined.
@@ -10987,7 +12400,7 @@ Parameters:
- inflationDested25519PublicKey
@@ -11014,7 +12427,7 @@ Parameters:
- Set this account ID as the account's inflation destination.
+ The ed25519 public key of the signer.
@@ -11023,13 +12436,13 @@ Parameters:
- clearFlagssha256Hash
-number
+Buffer
|
string
@@ -11053,7 +12466,7 @@ Parameters:
- Bitmap integer for which account flags to clear.
+ sha256 hash (Buffer or hex string) of preimage that will unlock funds. Preimage should be used as signature of future transaction.
@@ -11062,13 +12475,13 @@ Parameters:
- setFlagspreAuthTx
-number
+Buffer
|
string
@@ -11092,7 +12505,7 @@ Parameters:
- Bitmap integer for which account flags to set.
+ Hash (Buffer or hex string) of transaction that will unlock funds.
@@ -11101,15 +12514,12 @@ Parameters:
- masterWeighted25519SignedPayload
-number
-|
-
string
@@ -11131,7 +12541,7 @@ Parameters:
- The master key weight.
+ Signed payload signer (ed25519 public key + raw payload) for atomic transaction signature disclosure.
@@ -11140,7 +12550,7 @@ Parameters:
- lowThresholdweight
@@ -11170,7 +12580,15 @@ Parameters:
- The sum weight for the low threshold.
+ The weight of the new signer (0 to delete or 1-255)
+
+
+
+
+
+
+
+
@@ -11179,15 +12597,12 @@ Parameters:
- medThresholdhomeDomain
-number
-|
-
string
@@ -11209,7 +12624,7 @@ Parameters:
- The sum weight for the medium threshold.
+ sets the home domain used for reverse federation lookup.
@@ -11218,15 +12633,12 @@ Parameters:
- highThresholdsource
-number
-|
-
string
@@ -11248,16 +12660,172 @@ Parameters:
- The sum weight for the high threshold.
+ The source account (defaults to transaction source).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
xdr.SetOptionsOp
+
+
+
+
+
+
+
+ XDR operation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (static) setTrustLineFlags(opts) → {xdr.SetTrustLineFlagsOp}
+
+
+
+
+
+
+ Creates a trustline flag configuring operation.
+For the flags, set them to true to enable them and false to disable them. Any
+unmodified operations will be marked undefined in the result.
+Note that you can only clear the clawbackEnabled flag set; it must be set
+account-wide via operations.SetOptions (setting
+xdr.AccountFlags.clawbackEnabled).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+ - See:
+ -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
- signeropts
@@ -11270,22 +12838,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
- Add or remove a signer from the account. The signer is
-deleted if the weight is 0. Only one of ed25519PublicKey, sha256Hash, preAuthTx should be defined.
+ Options object
@@ -11313,7 +12870,7 @@ Parameters:
- ed25519PublicKeytrustor
@@ -11328,8 +12885,6 @@ Parameters:
- <optional>
-
@@ -11340,7 +12895,7 @@ Parameters:
- The ed25519 public key of the signer.
+ the account whose trustline this is
@@ -11349,16 +12904,13 @@ Parameters:
- sha256Hashasset
-Buffer
-|
-
-string
+Asset
@@ -11367,8 +12919,6 @@ Parameters:
- <optional>
-
@@ -11379,7 +12929,7 @@ Parameters:
- sha256 hash (Buffer or hex string) of preimage that will unlock funds. Preimage should be used as signature of future transaction.
+ the asset on the trustline
@@ -11388,16 +12938,13 @@ Parameters:
- preAuthTxflags
-Buffer
-|
-
-string
+object
@@ -11406,8 +12953,6 @@ Parameters:
- <optional>
-
@@ -11418,22 +12963,41 @@ Parameters:
- Hash (Buffer or hex string) of transaction that will unlock funds.
+ the set of flags to modify
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
- ed25519SignedPayloadauthorized
-string
+bool
@@ -11454,7 +13018,8 @@ Parameters:
- Signed payload signer (ed25519 public key + raw payload) for atomic transaction signature disclosure.
+ authorize account to perform
+transactions with its credit
@@ -11463,16 +13028,13 @@ Parameters:
- weightauthorizedToMaintainLiabilities
-number
-|
-
-string
+bool
@@ -11493,15 +13055,8 @@ Parameters:
- The weight of the new signer (0 to delete or 1-255)
-
-
-
-
-
-
-
-
+ authorize
+account to maintain and reduce liabilities for its credit
@@ -11510,13 +13065,13 @@ Parameters:
- homeDomainclawbackEnabled
-string
+bool
@@ -11537,7 +13092,17 @@ Parameters:
- sets the home domain used for reverse federation lookup.
+ stop claimable balances on
+this trustlines from having clawbacks enabled (this flag can only be set
+to false!)
+
+
+
+
+
+
+
+
@@ -11573,7 +13138,8 @@ Parameters:
- The source account (defaults to transaction source).
+ The source account for the operation.
+Defaults to the transaction's source account.
@@ -11614,17 +13180,13 @@ Returns:
-xdr.SetOptionsOp
+xdr.SetTrustLineFlagsOp
-
- XDR operation
-
-
@@ -11637,19 +13199,14 @@ Returns:
- (static) setTrustLineFlags(opts) → {xdr.SetTrustLineFlagsOp}
+ (static) uploadContractWasm(opts) → {xdr.Operation}
- Creates a trustline flag configuring operation.
-For the flags, set them to true to enable them and false to disable them. Any
-unmodified operations will be marked undefined in the result.
-Note that you can only clear the clawbackEnabled flag set; it must be set
-account-wide via operations.SetOptions (setting
-xdr.AccountFlags.clawbackEnabled).
+ Returns an operation that uploads WASM for a contract.
@@ -11685,7 +13242,7 @@ (static) <
Source:
(static) <
See:
@@ -11744,139 +13299,18 @@ Parameters:
-object
-
-
-
-
-
-
-
-
-
-
- Options object
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- trustor
-
-
-string
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- the account whose trustline this is
-
-
-
-
-
-
-
-
- asset
-
-
-Asset
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- the asset on the trustline
-
-
-
-
-
-
-
-
- flags
-
-
-object
+any
-
-
-
-
-
-
-
-
- the set of flags to modify
+ the set of parameters
@@ -11904,50 +13338,16 @@ Parameters:
- authorizedwasm
-bool
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- authorize account to perform
-transactions with its credit
-
-
-
-
-
-
-
-
- authorizedToMaintainLiabilitiesUint8Array
+|
-
-
-
-bool
+Buffer
@@ -11956,8 +13356,6 @@ Parameters:
- <optional>
-
@@ -11968,8 +13366,7 @@ Parameters:
- authorize
-account to maintain and reduce liabilities for its credit
+ a WASM blob to upload to the ledger
@@ -11978,13 +13375,13 @@ Parameters:
- clawbackEnabledauth
-bool
+Array.<xdr.SorobanAuthorizationEntry>
@@ -12005,17 +13402,8 @@ Parameters:
- stop claimable balances on
-this trustlines from having clawbacks enabled (this flag can only be set
-to false!)
-
-
-
-
-
-
-
-
+ an optional list
+outlining the tree of authorizations required for the call
@@ -12051,8 +13439,7 @@ Parameters:
- The source account for the operation.
-Defaults to the transaction's source account.
+ an optional source account
@@ -12093,13 +13480,18 @@ Returns:
-xdr.SetTrustLineFlagsOp
+xdr.Operation
+
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
+
+
Returns the read-only footprint entries necessary for any invocations to -this contract, for convenience when adding it to your transaction's overall -footprint or doing bump/restore operations.
+this contract, for convenience when manually adding it to your +transaction's overall footprint or doing bump/restore operations.Returns:
Array.<xdr.LedgerKey>
+xdr.LedgerKey
Returns:
-
@@ -864,7 +878,7 @@ the ledger keys containing the contract's code -(first) and its deployed contract instance (second)
+the ledger key for the deployed contract instance
Returns:
diff --git a/ContractSpec.html b/ContractSpec.html index 56ce357..ec257a3 100644 --- a/ContractSpec.html +++ b/ContractSpec.html @@ -24,7 +24,7 @@
@@ -315,7 +315,7 @@ findEntry
-
-
-findEntrySource:
funcA
Source:
Returns:
Example
- const args = {
+ ```js
+const args = {
arg1: 'value1',
arg2: 1234
};
-const scArgs = contractSpec.funcArgsToScVals('funcName', args);
+const scArgs = contractSpec.funcArgsToScVals('funcName', args);
+```
@@ -736,7 +738,7 @@ funcRe
Source:
Returns:
Example
- const resultScv = 'AAA=='; // Base64 encoded ScVal
-const result = contractSpec.funcResToNative('funcName', resultScv);
+ ```js
+const resultScv = 'AAA=='; // Base64 encoded ScVal
+const result = contractSpec.funcResToNative('funcName', resultScv);
+```
@@ -1157,7 +1161,7 @@ nativeTo
Source:
scVal
Source:
scValToN
Source:
Returns:
diff --git a/FeeBumpTransaction.html b/FeeBumpTransaction.html
index e423bfb..3a6118a 100644
--- a/FeeBumpTransaction.html
+++ b/FeeBumpTransaction.html
@@ -24,7 +24,7 @@
@@ -2040,7 +2040,7 @@ Returns:
diff --git a/Int128_Int128.html b/Int128_Int128.html
index c15cf68..8419ac1 100644
--- a/Int128_Int128.html
+++ b/Int128_Int128.html
@@ -24,7 +24,7 @@
@@ -230,7 +230,7 @@ Parameters:
diff --git a/Int256_Int256.html b/Int256_Int256.html
index 0a00e6b..eb21507 100644
--- a/Int256_Int256.html
+++ b/Int256_Int256.html
@@ -24,7 +24,7 @@
@@ -230,7 +230,7 @@ Parameters:
diff --git a/Keypair.html b/Keypair.html
index 8bfa84d..85f20bb 100644
--- a/Keypair.html
+++ b/Keypair.html
@@ -24,7 +24,7 @@
@@ -2462,7 +2462,7 @@ Returns:
diff --git a/LiquidityPoolAsset.html b/LiquidityPoolAsset.html
index fc88db3..35b4193 100644
--- a/LiquidityPoolAsset.html
+++ b/LiquidityPoolAsset.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Returns:
diff --git a/LiquidityPoolId.html b/LiquidityPoolId.html
index c7b42aa..97c983a 100644
--- a/LiquidityPoolId.html
+++ b/LiquidityPoolId.html
@@ -24,7 +24,7 @@
@@ -867,7 +867,7 @@ Returns:
diff --git a/Memo.html b/Memo.html
index edc76c0..2dfe01b 100644
--- a/Memo.html
+++ b/Memo.html
@@ -24,7 +24,7 @@
@@ -1386,7 +1386,7 @@ Returns:
diff --git a/MuxedAccount.html b/MuxedAccount.html
index b56d531..8131865 100644
--- a/MuxedAccount.html
+++ b/MuxedAccount.html
@@ -24,7 +24,7 @@
@@ -985,7 +985,7 @@ Returns:
diff --git a/Operation.html b/Operation.html
index 33871e0..622a062 100644
--- a/Operation.html
+++ b/Operation.html
@@ -24,7 +24,7 @@
@@ -99,7 +99,7 @@ new Operatio
Operation.liquidityPoolDepositOperation.liquidityPoolWithdrawOperation.invokeHostFunctionOperation.bumpFootprintExpirationOperation.extendFootprintTtlOpOperation.restoreFootprintExample
- (static) bumpFootprintExpiration(opts) → {xdr.Operation}
+ (static) bumpSequence(opts) → {xdr.BumpSequenceOp}
- Builds an operation to bump the expiration of a footprint (read and written
-ledger keys). Its only parameter is the number of ledgers to extend
-expiration for.
-The footprint itself is derived from the transaction (see
-TransactionBuilder's opts.sorobanData parameter, which is a
-xdr.SorobanTransactionData instance that contains fee data & resource
-usage as part of xdr.SorobanResources).
+ This operation bumps sequence number.
@@ -1100,7 +1094,7 @@ (sta
Source:
Parameters:
- object holding operation parameters
+ Options object
@@ -1189,13 +1183,13 @@ Parameters:
- ledgersToExpirebumpTo
-number
+string
@@ -1214,9 +1208,7 @@ Parameters:
- the number of ledgers past the LCL
-(last closed ledger) by which to extend the validity of the ledger keys in
-this transaction
+ Sequence number to bump to.
@@ -1252,7 +1244,7 @@ Parameters:
- an optional source account
+ The optional source account.
@@ -1293,7 +1285,7 @@ Returns:
-xdr.Operation
+xdr.BumpSequenceOp
@@ -1301,8 +1293,7 @@ Returns:
- a Bump Footprint Expiration operation
-(xdr.BumpFootprintExpirationOp)
+ Operation
@@ -1317,14 +1308,15 @@ Returns:
- (static) bumpSequence(opts) → {xdr.BumpSequenceOp}
+ (static) changeTrust(opts) → {xdr.ChangeTrustOp}
- This operation bumps sequence number.
+ Returns an XDR ChangeTrustOp. A "change trust" operation adds, removes, or updates a
+trust line for a given asset from the source account to another.
@@ -1360,7 +1352,7 @@ (static) Source:
Parameters:
- bumpToasset
+
+
+Asset
+|
+
+LiquidityPoolAsset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The asset for the trust line.
+
+
+
+
+
+
+
+
+ limit
@@ -1464,6 +1493,8 @@ Parameters:
+ <optional>
+
@@ -1474,7 +1505,8 @@ Parameters:
- Sequence number to bump to.
+ The limit for the asset, defaults to max int64.
+If the limit is set to "0" it deletes the trustline.
@@ -1510,7 +1542,7 @@ Parameters:
- The optional source account.
+ The source account (defaults to transaction source).
@@ -1551,7 +1583,7 @@ Returns:
-xdr.BumpSequenceOp
+xdr.ChangeTrustOp
@@ -1559,7 +1591,7 @@ Returns:
- Operation
+ Change Trust operation
@@ -1574,15 +1606,14 @@ Returns:
- (static) changeTrust(opts) → {xdr.ChangeTrustOp}
+ (static) claimClaimableBalance(opts) → {xdr.Operation}
- Returns an XDR ChangeTrustOp. A "change trust" operation adds, removes, or updates a
-trust line for a given asset from the source account to another.
+ Create a new claim claimable balance operation.
@@ -1618,7 +1649,7 @@ (static)
Source:
Parameters:
- asset
-
-
-Asset
-|
-
-LiquidityPoolAsset
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The asset for the trust line.
-
-
-
-
-
-
-
-
- limitbalanceId
@@ -1759,8 +1753,6 @@ Parameters:
- <optional>
-
@@ -1771,8 +1763,7 @@ Parameters:
- The limit for the asset, defaults to max int64.
-If the limit is set to "0" it deletes the trustline.
+ The claimable balance id to be claimed.
@@ -1808,7 +1799,7 @@ Parameters:
- The source account (defaults to transaction source).
+ The source account for the operation. Defaults to the transaction's source account.
@@ -1849,7 +1840,7 @@ Returns:
-xdr.ChangeTrustOp
+xdr.Operation
@@ -1857,7 +1848,7 @@ Returns:
- Change Trust operation
+ Claim claimable balance operation
@@ -1865,6 +1856,15 @@ Returns:
+
+Example
+
+ const op = Operation.claimClaimableBalance({
+ balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
+});
+
+
+
@@ -1872,14 +1872,14 @@ Returns:
- (static) claimClaimableBalance(opts) → {xdr.Operation}
+ (static) clawback(opts) → {xdr.ClawbackOp}
- Create a new claim claimable balance operation.
+ Creates a clawback operation.
@@ -1915,13 +1915,20 @@ (stati
Source:
See:
+
+
+
+
@@ -2004,7 +2011,41 @@ Parameters:
- balanceIdasset
+
+
+Asset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The asset being clawed back.
+
+
+
+
+
+
+
+
+ amount
@@ -2029,7 +2070,42 @@ Parameters:
- The claimable balance id to be claimed.
+ The amount of the asset to claw back.
+
+
+
+
+
+
+
+
+ from
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The public key of the (optionally-muxed)
+account to claw back from.
@@ -2065,7 +2141,8 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
+ The source account for the operation.
+Defaults to the transaction's source account.
@@ -2106,31 +2183,18 @@ Returns:
-xdr.Operation
+xdr.ClawbackOp
-
- Claim claimable balance operation
-
-
-
-Example
-
- const op = Operation.claimClaimableBalance({
- balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
-});
-
-
-
@@ -2138,14 +2202,14 @@ Example
- (static) clawback(opts) → {xdr.ClawbackOp}
+ (static) clawbackClaimableBalance(opts) → {xdr.ClawbackClaimableBalanceOp}
- Creates a clawback operation.
+ Creates a clawback operation for a claimable balance.
@@ -2181,20 +2245,13 @@ (static) cla
Source:
See:
-
-
-
-
@@ -2277,75 +2334,7 @@ Parameters:
- asset
-
-
-Asset
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The asset being clawed back.
-
-
-
-
-
-
-
-
- amount
-
-
-string
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The amount of the asset to claw back.
-
-
-
-
-
-
-
-
- frombalanceId
@@ -2370,8 +2359,7 @@ Parameters:
- The public key of the (optionally-muxed)
-account to claw back from.
+ The claimable balance ID to be clawed back.
@@ -2407,8 +2395,7 @@ Parameters:
- The source account for the operation.
-Defaults to the transaction's source account.
+ The source account for the operation. Defaults to the transaction's source account.
@@ -2449,7 +2436,7 @@ Returns:
-xdr.ClawbackOp
+xdr.ClawbackClaimableBalanceOp
@@ -2461,6 +2448,15 @@ Returns:
+
+Example
+
+ const op = Operation.clawbackClaimableBalance({
+ balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
+});
+
+
+
@@ -2468,14 +2464,14 @@ Returns:
- (static) clawbackClaimableBalance(opts) → {xdr.ClawbackClaimableBalanceOp}
+ (static) createAccount(opts) → {xdr.CreateAccountOp}
- Creates a clawback operation for a claimable balance.
+ Create and fund a non existent account.
@@ -2511,7 +2507,7 @@ (st
Source:
Parameters:
- balanceIddestination
@@ -2625,7 +2621,42 @@ Parameters:
- The claimable balance ID to be clawed back.
+ Destination account ID to create an account for.
+
+
+
+
+
+
+
+
+ startingBalance
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Amount in XLM the account should be funded for. Must be greater
+than the reserve balance amount.
@@ -2661,7 +2692,7 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
+ The source account for the payment. Defaults to the transaction's source account.
@@ -2702,26 +2733,21 @@ Returns:
-xdr.ClawbackClaimableBalanceOp
+xdr.CreateAccountOp
-
+
+ Create account operation
+
+
-
-Example
-
- const op = Operation.clawbackClaimableBalance({
- balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
-});
-
-
@@ -2730,14 +2756,14 @@ Example
- (static) createAccount(opts) → {xdr.CreateAccountOp}
+ (static) createClaimableBalance(opts) → {xdr.Operation}
- Create and fund a non existent account.
+ Create a new claimable balance operation.
@@ -2773,7 +2799,7 @@ (static) Source:
Parameters:
- destinationasset
-string
+Asset
@@ -2887,7 +2913,7 @@ Parameters:
- Destination account ID to create an account for.
+ The asset for the claimable balance.
@@ -2896,7 +2922,7 @@ Parameters:
- startingBalanceamount
@@ -2921,8 +2947,41 @@ Parameters:
- Amount in XLM the account should be funded for. Must be greater
-than the reserve balance amount.
+ Amount.
+
+
+
+
+
+
+
+
+ claimants
+
+
+Array.<Claimant>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An array of Claimants
@@ -2958,7 +3017,7 @@ Parameters:
- The source account for the payment. Defaults to the transaction's source account.
+ The source account for the operation. Defaults to the transaction's source account.
@@ -2999,7 +3058,7 @@ Returns:
-xdr.CreateAccountOp
+xdr.Operation
@@ -3007,7 +3066,7 @@ Returns:
- Create account operation
+ Create claimable balance operation
@@ -3015,6 +3074,29 @@ Returns:
+
+Example
+
+ const asset = new Asset(
+ 'USD',
+ 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
+);
+const amount = '100.0000000';
+const claimants = [
+ new Claimant(
+ 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ',
+ Claimant.predicateBeforeAbsoluteTime("4102444800000")
+ )
+];
+
+const op = Operation.createClaimableBalance({
+ asset,
+ amount,
+ claimants
+});
+
+
+
@@ -3022,14 +3104,14 @@ Returns:
- (static) createClaimableBalance(opts) → {xdr.Operation}
+ (static) createCustomContract(opts) → {xdr.Operation}
- Create a new claimable balance operation.
+ Returns an operation that creates a custom WASM contract.
@@ -3065,13 +3147,20 @@ (stat
Source:
See:
+
+
+
+
@@ -3115,7 +3204,7 @@ Parameters:
-object
+any
@@ -3126,7 +3215,7 @@ Parameters:
- Options object
+ the set of parameters
@@ -3154,13 +3243,13 @@ Parameters:
- assetaddress
-Asset
+Address
@@ -3179,7 +3268,7 @@ Parameters:
- The asset for the claimable balance.
+ the contract uploader address
@@ -3188,13 +3277,16 @@ Parameters:
- amountwasmHash
-string
+Uint8Array
+|
+
+Buffer
@@ -3213,7 +3305,9 @@ Parameters:
- Amount.
+ the SHA-256 hash of the contract
+WASM you're uploading (see hash and
+Operation.uploadContractWasm)
@@ -3222,13 +3316,16 @@ Parameters:
- claimantssalt
-Array.<Claimant>
+Uint8Array
+|
+
+Buffer
@@ -3237,6 +3334,8 @@ Parameters:
+ <optional>
+
@@ -3247,7 +3346,46 @@ Parameters:
- An array of Claimants
+ an optional, 32-byte salt to
+distinguish deployment instances of the same wasm from the same user (if
+omitted, one will be generated for you)
+
+
+
+
+
+
+
+
+ auth
+
+
+Array.<xdr.SorobanAuthorizationEntry>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ an optional list
+outlining the tree of authorizations required for the call
@@ -3283,7 +3421,7 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
+ an optional source account
@@ -3332,7 +3470,8 @@ Returns:
- Create claimable balance operation
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
@@ -3340,29 +3479,6 @@ Returns:
-
-Example
-
- const asset = new Asset(
- 'USD',
- 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
-);
-const amount = '100.0000000';
-const claimants = [
- new Claimant(
- 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ',
- Claimant.predicateBeforeAbsoluteTime("4102444800000")
- )
-];
-
-const op = Operation.createClaimableBalance({
- asset,
- amount,
- claimants
-});
-
-
-
@@ -3850,14 +3966,14 @@ Returns:
- (static) endSponsoringFutureReserves(opts) → {xdr.Operation}
+ (static) createStellarAssetContract(opts) → {xdr.Operation}
- Create an "end sponsoring future reserves" operation.
+ Returns an operation that wraps a Stellar asset into a token contract.
@@ -3893,13 +4009,26 @@
Source:
See:
+
+
+
+
@@ -3943,7 +4072,7 @@ Parameters:
-object
+any
@@ -3954,7 +4083,7 @@ Parameters:
- Options object
+ the set of parameters
@@ -3980,6 +4109,81 @@ Parameters:
+
+
+ asset
+
+
+Asset
+|
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ the Stellar asset to wrap, either as an
+Asset object or in canonical form (SEP-11, code:issuer)
+
+
+
+
+
+
+
+
+ auth
+
+
+Array.<xdr.SorobanAuthorizationEntry>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ an optional list
+outlining the tree of authorizations required for the call
+
+
+
+
+
+
sourceParameters:
- The source account for the operation. Defaults to the transaction's source account.
+ an optional source account
@@ -4058,7 +4262,8 @@ Returns:
- xdr operation
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
@@ -4066,13 +4271,6 @@ Returns:
-
-Example
-
- const op = Operation.endSponsoringFutureReserves();
-
-
-
@@ -4080,15 +4278,14 @@ Example
- (static) fromXDRObject(operation) → {Operation}
+ (static) endSponsoringFutureReserves(opts) → {xdr.Operation}
- Deconstructs the raw XDR operation object into the structured object that
-was used to create the operation (i.e. the opts parameter to most ops).
+ Create an "end sponsoring future reserves" operation.
@@ -4124,7 +4321,7 @@ (static) Source:
Parameters:
- operationopts
-xdr.Operation
+object
@@ -4185,7 +4382,70 @@ Parameters:
- An XDR Operation.
+ Options object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ source
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The source account for the operation. Defaults to the transaction's source account.
+
+
+
+
+
+
+
+
@@ -4218,33 +4478,50 @@ Returns:
-Operation
+xdr.Operation
+
+ xdr operation
+
+
-
-
-
-
+
+Example
+
+ const op = Operation.endSponsoringFutureReserves();
+
+
+
+
+
+
+
- (static) inflation(optsopt) → {xdr.InflationOp}
+ (static) extendFootprintTtl(opts) → {xdr.Operation}
- This operation generates the inflation.
+ Builds an operation to bump the expiration of a footprint (read and written
+ledger keys). Its only parameter is the number of ledgers to extend
+expiration for.
+The footprint itself is derived from the transaction (see
+TransactionBuilder's opts.sorobanData parameter, which is a
+xdr.SorobanTransactionData instance that contains fee data & resource
+usage as part of xdr.SorobanResources).
@@ -4280,7 +4557,7 @@ (static) in
Source:
Parameters:
Type
- Attributes
-
@@ -4339,21 +4614,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
- Options object
+ object holding operation parameters
@@ -4379,6 +4644,42 @@ Parameters:
+
+
+ extendTo
+
+
+number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ the number of ledgers past the LCL
+(last closed ledger) by which to extend the validity of the ledger keys in
+this transaction
+
+
+
+
+
+
sourceParameters:
- The optional source account.
+ an optional source account
@@ -4449,7 +4750,7 @@ Returns:
-xdr.InflationOp
+xdr.Operation
@@ -4457,7 +4758,8 @@ Returns:
- Inflation operation
+ a Bump Footprint Expiration operation
+(xdr.ExtendFootprintTTLOp)
@@ -4472,14 +4774,15 @@ Returns:
- (static) invokeHostFunction(opts) → {xdr.Operation}
+ (static) fromXDRObject(operation) → {Operation}
- Invokes a single smart contract function.
+ Deconstructs the raw XDR operation object into the structured object that
+was used to create the operation (i.e. the opts parameter to most ops).
@@ -4515,7 +4818,7 @@ (static)
Source:
Parameters:
- opts
-
-
-object
-
-
-
-
-
-
-
-
-
-
- options object
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- func
-
-
-xdr.HostFunction
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- host function to execute (with its
-wrapped parameters)
-
-
-
-
-
-
-
-
- auth
-
-
-Array.<xdr.SorobanAuthorizationEntry>
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- list outlining the
-tree of authorizations required for the call
-
-
-
-
-
-
-
-
- sourceoperation
-string
+xdr.Operation
-
-
- <optional>
-
-
-
-
-
-
-
- an optional source account
-
-
-
-
-
-
-
-
+ An XDR Operation.
@@ -4744,18 +4912,13 @@ Returns:
-xdr.Operation
+Operation
-
- an Invoke Host Function operation
-(xdr.InvokeHostFunctionOp)
-
-
@@ -4768,19 +4931,14 @@ Returns:
- (static) isValidAmount(value, allowZero) → {boolean}
+ (static) inflation(optsopt) → {xdr.InflationOp}
- Validates that a given amount is possible for a Stellar asset.
-Specifically, this means that the amount is well, a valid number, but also
-that it is within the int64 range and has no more than 7 decimal levels of
-precision.
-Note that while smart contracts allow larger amounts, this is oriented
-towards validating the standard Stellar operations.
+ This operation generates the inflation.
@@ -4816,7 +4974,7 @@ (static) Source:
Parameters:
Type
-
+ Attributes
- Default
+
Description
@@ -4862,60 +5020,97 @@ Parameters:
- valueopts
-string
+object
+
+
+ <optional>
+
+
+
-
-
+
+
- the amount to validate
+ Options object
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- allowZerosource
-boolean
+string
+
+
+ <optional>
+
-
-
- false
+
+
+
- optionally, whether or not zero is valid (default: no)
+ The optional source account.
+
+
+
+
+
+
+
+
@@ -4948,13 +5143,17 @@ Returns:
-boolean
+xdr.InflationOp
+
+ Inflation operation
+
+
@@ -4967,14 +5166,14 @@ Returns:
- (static) liquidityPoolDeposit(opts) → {xdr.Operation}
+ (static) invokeContractFunction(opts) → {xdr.Operation}
- Creates a liquidity pool deposit operation.
+ Returns an operation that invokes a contract function.
@@ -5010,7 +5209,7 @@ (static
Source:
(static
See:
@@ -5067,7 +5270,7 @@ Parameters:
-object
+any
@@ -5078,7 +5281,7 @@ Parameters:
- Options object
+ the set of parameters
@@ -5106,7 +5309,7 @@ Parameters:
- liquidityPoolIdcontract
@@ -5131,7 +5334,7 @@ Parameters:
- The liquidity pool ID.
+ a strkey-fied contract address (C...)
@@ -5140,7 +5343,7 @@ Parameters:
- maxAmountAfunction
@@ -5165,7 +5368,7 @@ Parameters:
- Maximum amount of first asset to deposit.
+ the name of the contract fn to invoke
@@ -5174,13 +5377,13 @@ Parameters:
- maxAmountBargs
-string
+Array.<xdr.ScVal>
@@ -5199,7 +5402,9 @@ Parameters:
- Maximum amount of second asset to deposit.
+ parameters to pass to the function
+invocation (try nativeToScVal or ScInt to make building
+these easier)
@@ -5208,22 +5413,13 @@ Parameters:
- minPriceauth
-number
-|
-
-string
-|
-
-BigNumber
-|
-
-Object
+Array.<xdr.SorobanAuthorizationEntry>
@@ -5232,6 +5428,8 @@ Parameters:
+ <optional>
+
@@ -5242,76 +5440,44 @@ Parameters:
- Minimum depositA/depositB price.
+ an optional list
+outlining the tree of authorizations required for the call
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- nsource
-number
+string
-
-
-
-
- If opts.minPrice is an object: the price numerator
+
-
-
-
-
-
-
-
- d
-
+ <optional>
-number
-
-
-
+
+
+
- If opts.minPrice is an object: the price denominator
+ an optional source account
@@ -5325,243 +5491,80 @@ Parameters:
+
+
-
-
- maxPrice
-
-
-number
-|
-string
-|
-BigNumber
-|
-Object
-
-
-
-
-
-
-
-
-
-
-
- Maximum depositA/depositB price.
-
-
-
-
-
-
- Name
-
- Type
+
+Returns:
+
+ -
+ Type:
+
+ -
+
xdr.Operation
- Description
-
-
-
-
+
+
-
-
- n
-
-
-number
+
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
+
+
+
-
-
-
+
+
+
-
- If opts.maxPrice is an object: the price numerator
-
-
-
+
+
+ (static) invokeHostFunction(opts) → {xdr.Operation}
-
-
- d
-
-
-number
+
+ Invokes a single smart contract host function.
+
-
-
-
-
-
- If opts.maxPrice is an object: the price denominator
-
-
-
+
+
-
-
-
-
-
+
-
-
- source
-
-
-string
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The source account for the operation. Defaults to the transaction's source account.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
xdr.Operation
-
-
-
-
-
-
-
- The resulting operation (xdr.LiquidityPoolDepositOp).
-
-
-
-
-
-
-
-
funcA
Source:
Returns:
Example
- const args = {
+ ```js
+const args = {
arg1: 'value1',
arg2: 1234
};
-const scArgs = contractSpec.funcArgsToScVals('funcName', args);
+const scArgs = contractSpec.funcArgsToScVals('funcName', args);
+```
@@ -736,7 +738,7 @@ funcRe
Source:
Returns:
Example
- const resultScv = 'AAA=='; // Base64 encoded ScVal
-const result = contractSpec.funcResToNative('funcName', resultScv);
+ ```js
+const resultScv = 'AAA=='; // Base64 encoded ScVal
+const result = contractSpec.funcResToNative('funcName', resultScv);
+```
@@ -1157,7 +1161,7 @@ nativeTo
Source:
scVal
Source:
scValToN
Source:
Returns:
diff --git a/FeeBumpTransaction.html b/FeeBumpTransaction.html
index e423bfb..3a6118a 100644
--- a/FeeBumpTransaction.html
+++ b/FeeBumpTransaction.html
@@ -24,7 +24,7 @@
@@ -2040,7 +2040,7 @@ Returns:
diff --git a/Int128_Int128.html b/Int128_Int128.html
index c15cf68..8419ac1 100644
--- a/Int128_Int128.html
+++ b/Int128_Int128.html
@@ -24,7 +24,7 @@
@@ -230,7 +230,7 @@ Parameters:
diff --git a/Int256_Int256.html b/Int256_Int256.html
index 0a00e6b..eb21507 100644
--- a/Int256_Int256.html
+++ b/Int256_Int256.html
@@ -24,7 +24,7 @@
@@ -230,7 +230,7 @@ Parameters:
diff --git a/Keypair.html b/Keypair.html
index 8bfa84d..85f20bb 100644
--- a/Keypair.html
+++ b/Keypair.html
@@ -24,7 +24,7 @@
@@ -2462,7 +2462,7 @@ Returns:
diff --git a/LiquidityPoolAsset.html b/LiquidityPoolAsset.html
index fc88db3..35b4193 100644
--- a/LiquidityPoolAsset.html
+++ b/LiquidityPoolAsset.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Returns:
diff --git a/LiquidityPoolId.html b/LiquidityPoolId.html
index c7b42aa..97c983a 100644
--- a/LiquidityPoolId.html
+++ b/LiquidityPoolId.html
@@ -24,7 +24,7 @@
@@ -867,7 +867,7 @@ Returns:
diff --git a/Memo.html b/Memo.html
index edc76c0..2dfe01b 100644
--- a/Memo.html
+++ b/Memo.html
@@ -24,7 +24,7 @@
@@ -1386,7 +1386,7 @@ Returns:
diff --git a/MuxedAccount.html b/MuxedAccount.html
index b56d531..8131865 100644
--- a/MuxedAccount.html
+++ b/MuxedAccount.html
@@ -24,7 +24,7 @@
@@ -985,7 +985,7 @@ Returns:
diff --git a/Operation.html b/Operation.html
index 33871e0..622a062 100644
--- a/Operation.html
+++ b/Operation.html
@@ -24,7 +24,7 @@
@@ -99,7 +99,7 @@ new Operatio
Operation.liquidityPoolDepositOperation.liquidityPoolWithdrawOperation.invokeHostFunctionOperation.bumpFootprintExpirationOperation.extendFootprintTtlOpOperation.restoreFootprintExample
- (static) bumpFootprintExpiration(opts) → {xdr.Operation}
+ (static) bumpSequence(opts) → {xdr.BumpSequenceOp}
- Builds an operation to bump the expiration of a footprint (read and written
-ledger keys). Its only parameter is the number of ledgers to extend
-expiration for.
-The footprint itself is derived from the transaction (see
-TransactionBuilder's opts.sorobanData parameter, which is a
-xdr.SorobanTransactionData instance that contains fee data & resource
-usage as part of xdr.SorobanResources).
+ This operation bumps sequence number.
@@ -1100,7 +1094,7 @@ (sta
Source:
Parameters:
- object holding operation parameters
+ Options object
@@ -1189,13 +1183,13 @@ Parameters:
- ledgersToExpirebumpTo
-number
+string
@@ -1214,9 +1208,7 @@ Parameters:
- the number of ledgers past the LCL
-(last closed ledger) by which to extend the validity of the ledger keys in
-this transaction
+ Sequence number to bump to.
@@ -1252,7 +1244,7 @@ Parameters:
- an optional source account
+ The optional source account.
@@ -1293,7 +1285,7 @@ Returns:
-xdr.Operation
+xdr.BumpSequenceOp
@@ -1301,8 +1293,7 @@ Returns:
- a Bump Footprint Expiration operation
-(xdr.BumpFootprintExpirationOp)
+ Operation
@@ -1317,14 +1308,15 @@ Returns:
- (static) bumpSequence(opts) → {xdr.BumpSequenceOp}
+ (static) changeTrust(opts) → {xdr.ChangeTrustOp}
- This operation bumps sequence number.
+ Returns an XDR ChangeTrustOp. A "change trust" operation adds, removes, or updates a
+trust line for a given asset from the source account to another.
@@ -1360,7 +1352,7 @@ (static) Source:
Parameters:
- bumpToasset
+
+
+Asset
+|
+
+LiquidityPoolAsset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The asset for the trust line.
+
+
+
+
+
+
+
+
+ limit
@@ -1464,6 +1493,8 @@ Parameters:
+ <optional>
+
@@ -1474,7 +1505,8 @@ Parameters:
- Sequence number to bump to.
+ The limit for the asset, defaults to max int64.
+If the limit is set to "0" it deletes the trustline.
@@ -1510,7 +1542,7 @@ Parameters:
- The optional source account.
+ The source account (defaults to transaction source).
@@ -1551,7 +1583,7 @@ Returns:
-xdr.BumpSequenceOp
+xdr.ChangeTrustOp
@@ -1559,7 +1591,7 @@ Returns:
- Operation
+ Change Trust operation
@@ -1574,15 +1606,14 @@ Returns:
- (static) changeTrust(opts) → {xdr.ChangeTrustOp}
+ (static) claimClaimableBalance(opts) → {xdr.Operation}
- Returns an XDR ChangeTrustOp. A "change trust" operation adds, removes, or updates a
-trust line for a given asset from the source account to another.
+ Create a new claim claimable balance operation.
@@ -1618,7 +1649,7 @@ (static)
Source:
Parameters:
- asset
-
-
-Asset
-|
-
-LiquidityPoolAsset
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The asset for the trust line.
-
-
-
-
-
-
-
-
- limitbalanceId
@@ -1759,8 +1753,6 @@ Parameters:
- <optional>
-
@@ -1771,8 +1763,7 @@ Parameters:
- The limit for the asset, defaults to max int64.
-If the limit is set to "0" it deletes the trustline.
+ The claimable balance id to be claimed.
@@ -1808,7 +1799,7 @@ Parameters:
- The source account (defaults to transaction source).
+ The source account for the operation. Defaults to the transaction's source account.
@@ -1849,7 +1840,7 @@ Returns:
-xdr.ChangeTrustOp
+xdr.Operation
@@ -1857,7 +1848,7 @@ Returns:
- Change Trust operation
+ Claim claimable balance operation
@@ -1865,6 +1856,15 @@ Returns:
+
+Example
+
+ const op = Operation.claimClaimableBalance({
+ balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
+});
+
+
+
@@ -1872,14 +1872,14 @@ Returns:
- (static) claimClaimableBalance(opts) → {xdr.Operation}
+ (static) clawback(opts) → {xdr.ClawbackOp}
- Create a new claim claimable balance operation.
+ Creates a clawback operation.
@@ -1915,13 +1915,20 @@ (stati
Source:
See:
+
+
+
+
@@ -2004,7 +2011,41 @@ Parameters:
- balanceIdasset
+
+
+Asset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The asset being clawed back.
+
+
+
+
+
+
+
+
+ amount
@@ -2029,7 +2070,42 @@ Parameters:
- The claimable balance id to be claimed.
+ The amount of the asset to claw back.
+
+
+
+
+
+
+
+
+ from
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The public key of the (optionally-muxed)
+account to claw back from.
@@ -2065,7 +2141,8 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
+ The source account for the operation.
+Defaults to the transaction's source account.
@@ -2106,31 +2183,18 @@ Returns:
-xdr.Operation
+xdr.ClawbackOp
-
- Claim claimable balance operation
-
-
-
-Example
-
- const op = Operation.claimClaimableBalance({
- balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
-});
-
-
-
@@ -2138,14 +2202,14 @@ Example
- (static) clawback(opts) → {xdr.ClawbackOp}
+ (static) clawbackClaimableBalance(opts) → {xdr.ClawbackClaimableBalanceOp}
- Creates a clawback operation.
+ Creates a clawback operation for a claimable balance.
@@ -2181,20 +2245,13 @@ (static) cla
Source:
See:
-
-
-
-
@@ -2277,75 +2334,7 @@ Parameters:
- asset
-
-
-Asset
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The asset being clawed back.
-
-
-
-
-
-
-
-
- amount
-
-
-string
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The amount of the asset to claw back.
-
-
-
-
-
-
-
-
- frombalanceId
@@ -2370,8 +2359,7 @@ Parameters:
- The public key of the (optionally-muxed)
-account to claw back from.
+ The claimable balance ID to be clawed back.
@@ -2407,8 +2395,7 @@ Parameters:
- The source account for the operation.
-Defaults to the transaction's source account.
+ The source account for the operation. Defaults to the transaction's source account.
@@ -2449,7 +2436,7 @@ Returns:
-xdr.ClawbackOp
+xdr.ClawbackClaimableBalanceOp
@@ -2461,6 +2448,15 @@ Returns:
+
+Example
+
+ const op = Operation.clawbackClaimableBalance({
+ balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
+});
+
+
+
@@ -2468,14 +2464,14 @@ Returns:
- (static) clawbackClaimableBalance(opts) → {xdr.ClawbackClaimableBalanceOp}
+ (static) createAccount(opts) → {xdr.CreateAccountOp}
- Creates a clawback operation for a claimable balance.
+ Create and fund a non existent account.
@@ -2511,7 +2507,7 @@ (st
Source:
Parameters:
- balanceIddestination
@@ -2625,7 +2621,42 @@ Parameters:
- The claimable balance ID to be clawed back.
+ Destination account ID to create an account for.
+
+
+
+
+
+
+
+
+ startingBalance
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Amount in XLM the account should be funded for. Must be greater
+than the reserve balance amount.
@@ -2661,7 +2692,7 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
+ The source account for the payment. Defaults to the transaction's source account.
@@ -2702,26 +2733,21 @@ Returns:
-xdr.ClawbackClaimableBalanceOp
+xdr.CreateAccountOp
-
+
+ Create account operation
+
+
-
-Example
-
- const op = Operation.clawbackClaimableBalance({
- balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
-});
-
-
@@ -2730,14 +2756,14 @@ Example
- (static) createAccount(opts) → {xdr.CreateAccountOp}
+ (static) createClaimableBalance(opts) → {xdr.Operation}
- Create and fund a non existent account.
+ Create a new claimable balance operation.
@@ -2773,7 +2799,7 @@ (static) Source:
Parameters:
- destinationasset
-string
+Asset
@@ -2887,7 +2913,7 @@ Parameters:
- Destination account ID to create an account for.
+ The asset for the claimable balance.
@@ -2896,7 +2922,7 @@ Parameters:
- startingBalanceamount
@@ -2921,8 +2947,41 @@ Parameters:
- Amount in XLM the account should be funded for. Must be greater
-than the reserve balance amount.
+ Amount.
+
+
+
+
+
+
+
+
+ claimants
+
+
+Array.<Claimant>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An array of Claimants
@@ -2958,7 +3017,7 @@ Parameters:
- The source account for the payment. Defaults to the transaction's source account.
+ The source account for the operation. Defaults to the transaction's source account.
@@ -2999,7 +3058,7 @@ Returns:
-xdr.CreateAccountOp
+xdr.Operation
@@ -3007,7 +3066,7 @@ Returns:
- Create account operation
+ Create claimable balance operation
@@ -3015,6 +3074,29 @@ Returns:
+
+Example
+
+ const asset = new Asset(
+ 'USD',
+ 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
+);
+const amount = '100.0000000';
+const claimants = [
+ new Claimant(
+ 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ',
+ Claimant.predicateBeforeAbsoluteTime("4102444800000")
+ )
+];
+
+const op = Operation.createClaimableBalance({
+ asset,
+ amount,
+ claimants
+});
+
+
+
@@ -3022,14 +3104,14 @@ Returns:
- (static) createClaimableBalance(opts) → {xdr.Operation}
+ (static) createCustomContract(opts) → {xdr.Operation}
- Create a new claimable balance operation.
+ Returns an operation that creates a custom WASM contract.
@@ -3065,13 +3147,20 @@ (stat
Source:
See:
+
+
+
+
@@ -3115,7 +3204,7 @@ Parameters:
-object
+any
@@ -3126,7 +3215,7 @@ Parameters:
- Options object
+ the set of parameters
@@ -3154,13 +3243,13 @@ Parameters:
- assetaddress
-Asset
+Address
@@ -3179,7 +3268,7 @@ Parameters:
- The asset for the claimable balance.
+ the contract uploader address
@@ -3188,13 +3277,16 @@ Parameters:
- amountwasmHash
-string
+Uint8Array
+|
+
+Buffer
@@ -3213,7 +3305,9 @@ Parameters:
- Amount.
+ the SHA-256 hash of the contract
+WASM you're uploading (see hash and
+Operation.uploadContractWasm)
@@ -3222,13 +3316,16 @@ Parameters:
- claimantssalt
-Array.<Claimant>
+Uint8Array
+|
+
+Buffer
@@ -3237,6 +3334,8 @@ Parameters:
+ <optional>
+
@@ -3247,7 +3346,46 @@ Parameters:
- An array of Claimants
+ an optional, 32-byte salt to
+distinguish deployment instances of the same wasm from the same user (if
+omitted, one will be generated for you)
+
+
+
+
+
+
+
+
+ auth
+
+
+Array.<xdr.SorobanAuthorizationEntry>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ an optional list
+outlining the tree of authorizations required for the call
@@ -3283,7 +3421,7 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
+ an optional source account
@@ -3332,7 +3470,8 @@ Returns:
- Create claimable balance operation
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
@@ -3340,29 +3479,6 @@ Returns:
-
-Example
-
- const asset = new Asset(
- 'USD',
- 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
-);
-const amount = '100.0000000';
-const claimants = [
- new Claimant(
- 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ',
- Claimant.predicateBeforeAbsoluteTime("4102444800000")
- )
-];
-
-const op = Operation.createClaimableBalance({
- asset,
- amount,
- claimants
-});
-
-
-
@@ -3850,14 +3966,14 @@ Returns:
- (static) endSponsoringFutureReserves(opts) → {xdr.Operation}
+ (static) createStellarAssetContract(opts) → {xdr.Operation}
- Create an "end sponsoring future reserves" operation.
+ Returns an operation that wraps a Stellar asset into a token contract.
@@ -3893,13 +4009,26 @@
Source:
See:
+
+
+
+
@@ -3943,7 +4072,7 @@ Parameters:
-object
+any
@@ -3954,7 +4083,7 @@ Parameters:
- Options object
+ the set of parameters
@@ -3980,6 +4109,81 @@ Parameters:
+
+
+ asset
+
+
+Asset
+|
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ the Stellar asset to wrap, either as an
+Asset object or in canonical form (SEP-11, code:issuer)
+
+
+
+
+
+
+
+
+ auth
+
+
+Array.<xdr.SorobanAuthorizationEntry>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ an optional list
+outlining the tree of authorizations required for the call
+
+
+
+
+
+
sourceParameters:
- The source account for the operation. Defaults to the transaction's source account.
+ an optional source account
@@ -4058,7 +4262,8 @@ Returns:
- xdr operation
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
@@ -4066,13 +4271,6 @@ Returns:
-
-Example
-
- const op = Operation.endSponsoringFutureReserves();
-
-
-
@@ -4080,15 +4278,14 @@ Example
- (static) fromXDRObject(operation) → {Operation}
+ (static) endSponsoringFutureReserves(opts) → {xdr.Operation}
- Deconstructs the raw XDR operation object into the structured object that
-was used to create the operation (i.e. the opts parameter to most ops).
+ Create an "end sponsoring future reserves" operation.
@@ -4124,7 +4321,7 @@ (static) Source:
Parameters:
- operationopts
-xdr.Operation
+object
@@ -4185,7 +4382,70 @@ Parameters:
- An XDR Operation.
+ Options object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ source
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The source account for the operation. Defaults to the transaction's source account.
+
+
+
+
+
+
+
+
@@ -4218,33 +4478,50 @@ Returns:
-Operation
+xdr.Operation
+
+ xdr operation
+
+
-
-
-
-
+
+Example
+
+ const op = Operation.endSponsoringFutureReserves();
+
+
+
+
+
+
+
- (static) inflation(optsopt) → {xdr.InflationOp}
+ (static) extendFootprintTtl(opts) → {xdr.Operation}
- This operation generates the inflation.
+ Builds an operation to bump the expiration of a footprint (read and written
+ledger keys). Its only parameter is the number of ledgers to extend
+expiration for.
+The footprint itself is derived from the transaction (see
+TransactionBuilder's opts.sorobanData parameter, which is a
+xdr.SorobanTransactionData instance that contains fee data & resource
+usage as part of xdr.SorobanResources).
@@ -4280,7 +4557,7 @@ (static) in
Source:
Parameters:
Type
- Attributes
-
@@ -4339,21 +4614,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
- Options object
+ object holding operation parameters
@@ -4379,6 +4644,42 @@ Parameters:
+
+
+ extendTo
+
+
+number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ the number of ledgers past the LCL
+(last closed ledger) by which to extend the validity of the ledger keys in
+this transaction
+
+
+
+
+
+
sourceParameters:
- The optional source account.
+ an optional source account
@@ -4449,7 +4750,7 @@ Returns:
-xdr.InflationOp
+xdr.Operation
@@ -4457,7 +4758,8 @@ Returns:
- Inflation operation
+ a Bump Footprint Expiration operation
+(xdr.ExtendFootprintTTLOp)
@@ -4472,14 +4774,15 @@ Returns:
- (static) invokeHostFunction(opts) → {xdr.Operation}
+ (static) fromXDRObject(operation) → {Operation}
- Invokes a single smart contract function.
+ Deconstructs the raw XDR operation object into the structured object that
+was used to create the operation (i.e. the opts parameter to most ops).
@@ -4515,7 +4818,7 @@ (static)
Source:
Parameters:
- opts
-
-
-object
-
-
-
-
-
-
-
-
-
-
- options object
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- func
-
-
-xdr.HostFunction
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- host function to execute (with its
-wrapped parameters)
-
-
-
-
-
-
-
-
- auth
-
-
-Array.<xdr.SorobanAuthorizationEntry>
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- list outlining the
-tree of authorizations required for the call
-
-
-
-
-
-
-
-
- sourceoperation
-string
+xdr.Operation
-
-
- <optional>
-
-
-
-
-
-
-
- an optional source account
-
-
-
-
-
-
-
-
+ An XDR Operation.
@@ -4744,18 +4912,13 @@ Returns:
-xdr.Operation
+Operation
-
- an Invoke Host Function operation
-(xdr.InvokeHostFunctionOp)
-
-
@@ -4768,19 +4931,14 @@ Returns:
- (static) isValidAmount(value, allowZero) → {boolean}
+ (static) inflation(optsopt) → {xdr.InflationOp}
- Validates that a given amount is possible for a Stellar asset.
-Specifically, this means that the amount is well, a valid number, but also
-that it is within the int64 range and has no more than 7 decimal levels of
-precision.
-Note that while smart contracts allow larger amounts, this is oriented
-towards validating the standard Stellar operations.
+ This operation generates the inflation.
@@ -4816,7 +4974,7 @@ (static) Source:
Parameters:
Type
-
+ Attributes
- Default
+
Description
@@ -4862,60 +5020,97 @@ Parameters:
- valueopts
-string
+object
+
+
+ <optional>
+
+
+
-
-
+
+
- the amount to validate
+ Options object
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- allowZerosource
-boolean
+string
+
+
+ <optional>
+
-
-
- false
+
+
+
- optionally, whether or not zero is valid (default: no)
+ The optional source account.
+
+
+
+
+
+
+
+
@@ -4948,13 +5143,17 @@ Returns:
-boolean
+xdr.InflationOp
+
+ Inflation operation
+
+
@@ -4967,14 +5166,14 @@ Returns:
- (static) liquidityPoolDeposit(opts) → {xdr.Operation}
+ (static) invokeContractFunction(opts) → {xdr.Operation}
- Creates a liquidity pool deposit operation.
+ Returns an operation that invokes a contract function.
@@ -5010,7 +5209,7 @@ (static
Source:
(static
See:
@@ -5067,7 +5270,7 @@ Parameters:
-object
+any
@@ -5078,7 +5281,7 @@ Parameters:
- Options object
+ the set of parameters
@@ -5106,7 +5309,7 @@ Parameters:
- liquidityPoolIdcontract
@@ -5131,7 +5334,7 @@ Parameters:
- The liquidity pool ID.
+ a strkey-fied contract address (C...)
@@ -5140,7 +5343,7 @@ Parameters:
- maxAmountAfunction
@@ -5165,7 +5368,7 @@ Parameters:
- Maximum amount of first asset to deposit.
+ the name of the contract fn to invoke
@@ -5174,13 +5377,13 @@ Parameters:
- maxAmountBargs
-string
+Array.<xdr.ScVal>
@@ -5199,7 +5402,9 @@ Parameters:
- Maximum amount of second asset to deposit.
+ parameters to pass to the function
+invocation (try nativeToScVal or ScInt to make building
+these easier)
@@ -5208,22 +5413,13 @@ Parameters:
- minPriceauth
-number
-|
-
-string
-|
-
-BigNumber
-|
-
-Object
+Array.<xdr.SorobanAuthorizationEntry>
@@ -5232,6 +5428,8 @@ Parameters:
+ <optional>
+
@@ -5242,76 +5440,44 @@ Parameters:
- Minimum depositA/depositB price.
+ an optional list
+outlining the tree of authorizations required for the call
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- nsource
-number
+string
-
-
-
-
- If opts.minPrice is an object: the price numerator
+
-
-
-
-
-
-
-
- d
-
+ <optional>
-number
-
-
-
+
+
+
- If opts.minPrice is an object: the price denominator
+ an optional source account
@@ -5325,243 +5491,80 @@ Parameters:
+
+
-
-
- maxPrice
-
-
-number
-|
-string
-|
-BigNumber
-|
-Object
-
-
-
-
-
-
-
-
-
-
-
- Maximum depositA/depositB price.
-
-
-
-
-
-
- Name
-
- Type
+
+Returns:
+
+ -
+ Type:
+
+ -
+
xdr.Operation
- Description
-
-
-
-
+
+
-
-
- n
-
-
-number
+
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
+
+
+
-
-
-
+
+
+
-
- If opts.maxPrice is an object: the price numerator
-
-
-
+
+
+ (static) invokeHostFunction(opts) → {xdr.Operation}
-
-
- d
-
-
-number
+
+ Invokes a single smart contract host function.
+
-
-
-
-
-
- If opts.maxPrice is an object: the price denominator
-
-
-
+
+
-
-
-
-
-
+
-
-
- source
-
-
-string
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The source account for the operation. Defaults to the transaction's source account.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
xdr.Operation
-
-
-
-
-
-
-
- The resulting operation (xdr.LiquidityPoolDepositOp).
-
-
-
-
-
-
-
-
Example
-const args = {
+ ```js
+const args = {
arg1: 'value1',
arg2: 1234
};
-const scArgs = contractSpec.funcArgsToScVals('funcName', args);
+const scArgs = contractSpec.funcArgsToScVals('funcName', args);
+```Returns:
Example
-const resultScv = 'AAA=='; // Base64 encoded ScVal
-const result = contractSpec.funcResToNative('funcName', resultScv);```js
+const resultScv = 'AAA=='; // Base64 encoded ScVal
+const result = contractSpec.funcResToNative('funcName', resultScv);
+```nativeTo
Source:
scVal
Source:
scValToN
Source:
Returns:
diff --git a/FeeBumpTransaction.html b/FeeBumpTransaction.html
index e423bfb..3a6118a 100644
--- a/FeeBumpTransaction.html
+++ b/FeeBumpTransaction.html
@@ -24,7 +24,7 @@
@@ -2040,7 +2040,7 @@ Returns:
diff --git a/Int128_Int128.html b/Int128_Int128.html
index c15cf68..8419ac1 100644
--- a/Int128_Int128.html
+++ b/Int128_Int128.html
@@ -24,7 +24,7 @@
@@ -230,7 +230,7 @@ Parameters:
diff --git a/Int256_Int256.html b/Int256_Int256.html
index 0a00e6b..eb21507 100644
--- a/Int256_Int256.html
+++ b/Int256_Int256.html
@@ -24,7 +24,7 @@
@@ -230,7 +230,7 @@ Parameters:
diff --git a/Keypair.html b/Keypair.html
index 8bfa84d..85f20bb 100644
--- a/Keypair.html
+++ b/Keypair.html
@@ -24,7 +24,7 @@
@@ -2462,7 +2462,7 @@ Returns:
diff --git a/LiquidityPoolAsset.html b/LiquidityPoolAsset.html
index fc88db3..35b4193 100644
--- a/LiquidityPoolAsset.html
+++ b/LiquidityPoolAsset.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Returns:
diff --git a/LiquidityPoolId.html b/LiquidityPoolId.html
index c7b42aa..97c983a 100644
--- a/LiquidityPoolId.html
+++ b/LiquidityPoolId.html
@@ -24,7 +24,7 @@
@@ -867,7 +867,7 @@ Returns:
diff --git a/Memo.html b/Memo.html
index edc76c0..2dfe01b 100644
--- a/Memo.html
+++ b/Memo.html
@@ -24,7 +24,7 @@
@@ -1386,7 +1386,7 @@ Returns:
diff --git a/MuxedAccount.html b/MuxedAccount.html
index b56d531..8131865 100644
--- a/MuxedAccount.html
+++ b/MuxedAccount.html
@@ -24,7 +24,7 @@
@@ -985,7 +985,7 @@ Returns:
diff --git a/Operation.html b/Operation.html
index 33871e0..622a062 100644
--- a/Operation.html
+++ b/Operation.html
@@ -24,7 +24,7 @@
@@ -99,7 +99,7 @@ new Operatio
Operation.liquidityPoolDepositOperation.liquidityPoolWithdrawOperation.invokeHostFunctionOperation.bumpFootprintExpirationOperation.extendFootprintTtlOpOperation.restoreFootprintExample
- (static) bumpFootprintExpiration(opts) → {xdr.Operation}
+ (static) bumpSequence(opts) → {xdr.BumpSequenceOp}
- Builds an operation to bump the expiration of a footprint (read and written
-ledger keys). Its only parameter is the number of ledgers to extend
-expiration for.
-The footprint itself is derived from the transaction (see
-TransactionBuilder's opts.sorobanData parameter, which is a
-xdr.SorobanTransactionData instance that contains fee data & resource
-usage as part of xdr.SorobanResources).
+ This operation bumps sequence number.
@@ -1100,7 +1094,7 @@ (sta
Source:
Parameters:
- object holding operation parameters
+ Options object
@@ -1189,13 +1183,13 @@ Parameters:
- ledgersToExpirebumpTo
-number
+string
@@ -1214,9 +1208,7 @@ Parameters:
- the number of ledgers past the LCL
-(last closed ledger) by which to extend the validity of the ledger keys in
-this transaction
+ Sequence number to bump to.
@@ -1252,7 +1244,7 @@ Parameters:
- an optional source account
+ The optional source account.
@@ -1293,7 +1285,7 @@ Returns:
-xdr.Operation
+xdr.BumpSequenceOp
@@ -1301,8 +1293,7 @@ Returns:
- a Bump Footprint Expiration operation
-(xdr.BumpFootprintExpirationOp)
+ Operation
@@ -1317,14 +1308,15 @@ Returns:
- (static) bumpSequence(opts) → {xdr.BumpSequenceOp}
+ (static) changeTrust(opts) → {xdr.ChangeTrustOp}
- This operation bumps sequence number.
+ Returns an XDR ChangeTrustOp. A "change trust" operation adds, removes, or updates a
+trust line for a given asset from the source account to another.
@@ -1360,7 +1352,7 @@ (static) Source:
Parameters:
- bumpToasset
+
+
+Asset
+|
+
+LiquidityPoolAsset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The asset for the trust line.
+
+
+
+
+
+
+
+
+ limit
@@ -1464,6 +1493,8 @@ Parameters:
+ <optional>
+
@@ -1474,7 +1505,8 @@ Parameters:
- Sequence number to bump to.
+ The limit for the asset, defaults to max int64.
+If the limit is set to "0" it deletes the trustline.
@@ -1510,7 +1542,7 @@ Parameters:
- The optional source account.
+ The source account (defaults to transaction source).
@@ -1551,7 +1583,7 @@ Returns:
-xdr.BumpSequenceOp
+xdr.ChangeTrustOp
@@ -1559,7 +1591,7 @@ Returns:
- Operation
+ Change Trust operation
@@ -1574,15 +1606,14 @@ Returns:
- (static) changeTrust(opts) → {xdr.ChangeTrustOp}
+ (static) claimClaimableBalance(opts) → {xdr.Operation}
- Returns an XDR ChangeTrustOp. A "change trust" operation adds, removes, or updates a
-trust line for a given asset from the source account to another.
+ Create a new claim claimable balance operation.
@@ -1618,7 +1649,7 @@ (static)
Source:
Parameters:
- asset
-
-
-Asset
-|
-
-LiquidityPoolAsset
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The asset for the trust line.
-
-
-
-
-
-
-
-
- limitbalanceId
@@ -1759,8 +1753,6 @@ Parameters:
- <optional>
-
@@ -1771,8 +1763,7 @@ Parameters:
- The limit for the asset, defaults to max int64.
-If the limit is set to "0" it deletes the trustline.
+ The claimable balance id to be claimed.
@@ -1808,7 +1799,7 @@ Parameters:
- The source account (defaults to transaction source).
+ The source account for the operation. Defaults to the transaction's source account.
@@ -1849,7 +1840,7 @@ Returns:
-xdr.ChangeTrustOp
+xdr.Operation
@@ -1857,7 +1848,7 @@ Returns:
- Change Trust operation
+ Claim claimable balance operation
@@ -1865,6 +1856,15 @@ Returns:
+
+Example
+
+ const op = Operation.claimClaimableBalance({
+ balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
+});
+
+
+
@@ -1872,14 +1872,14 @@ Returns:
- (static) claimClaimableBalance(opts) → {xdr.Operation}
+ (static) clawback(opts) → {xdr.ClawbackOp}
- Create a new claim claimable balance operation.
+ Creates a clawback operation.
@@ -1915,13 +1915,20 @@ (stati
Source:
See:
+
+
+
+
@@ -2004,7 +2011,41 @@ Parameters:
- balanceIdasset
+
+
+Asset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The asset being clawed back.
+
+
+
+
+
+
+
+
+ amount
@@ -2029,7 +2070,42 @@ Parameters:
- The claimable balance id to be claimed.
+ The amount of the asset to claw back.
+
+
+
+
+
+
+
+
+ from
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The public key of the (optionally-muxed)
+account to claw back from.
@@ -2065,7 +2141,8 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
+ The source account for the operation.
+Defaults to the transaction's source account.
@@ -2106,31 +2183,18 @@ Returns:
-xdr.Operation
+xdr.ClawbackOp
-
- Claim claimable balance operation
-
-
-
-Example
-
- const op = Operation.claimClaimableBalance({
- balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
-});
-
-
-
@@ -2138,14 +2202,14 @@ Example
- (static) clawback(opts) → {xdr.ClawbackOp}
+ (static) clawbackClaimableBalance(opts) → {xdr.ClawbackClaimableBalanceOp}
- Creates a clawback operation.
+ Creates a clawback operation for a claimable balance.
@@ -2181,20 +2245,13 @@ (static) cla
Source:
See:
-
-
-
-
@@ -2277,75 +2334,7 @@ Parameters:
- asset
-
-
-Asset
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The asset being clawed back.
-
-
-
-
-
-
-
-
- amount
-
-
-string
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The amount of the asset to claw back.
-
-
-
-
-
-
-
-
- frombalanceId
@@ -2370,8 +2359,7 @@ Parameters:
- The public key of the (optionally-muxed)
-account to claw back from.
+ The claimable balance ID to be clawed back.
@@ -2407,8 +2395,7 @@ Parameters:
- The source account for the operation.
-Defaults to the transaction's source account.
+ The source account for the operation. Defaults to the transaction's source account.
@@ -2449,7 +2436,7 @@ Returns:
-xdr.ClawbackOp
+xdr.ClawbackClaimableBalanceOp
@@ -2461,6 +2448,15 @@ Returns:
+
+Example
+
+ const op = Operation.clawbackClaimableBalance({
+ balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
+});
+
+
+
@@ -2468,14 +2464,14 @@ Returns:
- (static) clawbackClaimableBalance(opts) → {xdr.ClawbackClaimableBalanceOp}
+ (static) createAccount(opts) → {xdr.CreateAccountOp}
- Creates a clawback operation for a claimable balance.
+ Create and fund a non existent account.
@@ -2511,7 +2507,7 @@ (st
Source:
Parameters:
- balanceIddestination
@@ -2625,7 +2621,42 @@ Parameters:
- The claimable balance ID to be clawed back.
+ Destination account ID to create an account for.
+
+
+
+
+
+
+
+
+ startingBalance
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Amount in XLM the account should be funded for. Must be greater
+than the reserve balance amount.
@@ -2661,7 +2692,7 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
+ The source account for the payment. Defaults to the transaction's source account.
@@ -2702,26 +2733,21 @@ Returns:
-xdr.ClawbackClaimableBalanceOp
+xdr.CreateAccountOp
-
+
+ Create account operation
+
+
-
-Example
-
- const op = Operation.clawbackClaimableBalance({
- balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
-});
-
-
@@ -2730,14 +2756,14 @@ Example
- (static) createAccount(opts) → {xdr.CreateAccountOp}
+ (static) createClaimableBalance(opts) → {xdr.Operation}
- Create and fund a non existent account.
+ Create a new claimable balance operation.
@@ -2773,7 +2799,7 @@ (static) Source:
Parameters:
- destinationasset
-string
+Asset
@@ -2887,7 +2913,7 @@ Parameters:
- Destination account ID to create an account for.
+ The asset for the claimable balance.
@@ -2896,7 +2922,7 @@ Parameters:
- startingBalanceamount
@@ -2921,8 +2947,41 @@ Parameters:
- Amount in XLM the account should be funded for. Must be greater
-than the reserve balance amount.
+ Amount.
+
+
+
+
+
+
+
+
+ claimants
+
+
+Array.<Claimant>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An array of Claimants
@@ -2958,7 +3017,7 @@ Parameters:
- The source account for the payment. Defaults to the transaction's source account.
+ The source account for the operation. Defaults to the transaction's source account.
@@ -2999,7 +3058,7 @@ Returns:
-xdr.CreateAccountOp
+xdr.Operation
@@ -3007,7 +3066,7 @@ Returns:
- Create account operation
+ Create claimable balance operation
@@ -3015,6 +3074,29 @@ Returns:
+
+Example
+
+ const asset = new Asset(
+ 'USD',
+ 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
+);
+const amount = '100.0000000';
+const claimants = [
+ new Claimant(
+ 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ',
+ Claimant.predicateBeforeAbsoluteTime("4102444800000")
+ )
+];
+
+const op = Operation.createClaimableBalance({
+ asset,
+ amount,
+ claimants
+});
+
+
+
@@ -3022,14 +3104,14 @@ Returns:
- (static) createClaimableBalance(opts) → {xdr.Operation}
+ (static) createCustomContract(opts) → {xdr.Operation}
- Create a new claimable balance operation.
+ Returns an operation that creates a custom WASM contract.
@@ -3065,13 +3147,20 @@ (stat
Source:
See:
+
+
+
+
@@ -3115,7 +3204,7 @@ Parameters:
-object
+any
@@ -3126,7 +3215,7 @@ Parameters:
- Options object
+ the set of parameters
@@ -3154,13 +3243,13 @@ Parameters:
- assetaddress
-Asset
+Address
@@ -3179,7 +3268,7 @@ Parameters:
- The asset for the claimable balance.
+ the contract uploader address
@@ -3188,13 +3277,16 @@ Parameters:
- amountwasmHash
-string
+Uint8Array
+|
+
+Buffer
@@ -3213,7 +3305,9 @@ Parameters:
- Amount.
+ the SHA-256 hash of the contract
+WASM you're uploading (see hash and
+Operation.uploadContractWasm)
@@ -3222,13 +3316,16 @@ Parameters:
- claimantssalt
-Array.<Claimant>
+Uint8Array
+|
+
+Buffer
@@ -3237,6 +3334,8 @@ Parameters:
+ <optional>
+
@@ -3247,7 +3346,46 @@ Parameters:
- An array of Claimants
+ an optional, 32-byte salt to
+distinguish deployment instances of the same wasm from the same user (if
+omitted, one will be generated for you)
+
+
+
+
+
+
+
+
+ auth
+
+
+Array.<xdr.SorobanAuthorizationEntry>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ an optional list
+outlining the tree of authorizations required for the call
@@ -3283,7 +3421,7 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
+ an optional source account
@@ -3332,7 +3470,8 @@ Returns:
- Create claimable balance operation
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
@@ -3340,29 +3479,6 @@ Returns:
-
-Example
-
- const asset = new Asset(
- 'USD',
- 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
-);
-const amount = '100.0000000';
-const claimants = [
- new Claimant(
- 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ',
- Claimant.predicateBeforeAbsoluteTime("4102444800000")
- )
-];
-
-const op = Operation.createClaimableBalance({
- asset,
- amount,
- claimants
-});
-
-
-
@@ -3850,14 +3966,14 @@ Returns:
- (static) endSponsoringFutureReserves(opts) → {xdr.Operation}
+ (static) createStellarAssetContract(opts) → {xdr.Operation}
- Create an "end sponsoring future reserves" operation.
+ Returns an operation that wraps a Stellar asset into a token contract.
@@ -3893,13 +4009,26 @@
Source:
See:
+
+
+
+
@@ -3943,7 +4072,7 @@ Parameters:
-object
+any
@@ -3954,7 +4083,7 @@ Parameters:
- Options object
+ the set of parameters
@@ -3980,6 +4109,81 @@ Parameters:
+
+
+ asset
+
+
+Asset
+|
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ the Stellar asset to wrap, either as an
+Asset object or in canonical form (SEP-11, code:issuer)
+
+
+
+
+
+
+
+
+ auth
+
+
+Array.<xdr.SorobanAuthorizationEntry>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ an optional list
+outlining the tree of authorizations required for the call
+
+
+
+
+
+
sourceParameters:
- The source account for the operation. Defaults to the transaction's source account.
+ an optional source account
@@ -4058,7 +4262,8 @@ Returns:
- xdr operation
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
@@ -4066,13 +4271,6 @@ Returns:
-
-Example
-
- const op = Operation.endSponsoringFutureReserves();
-
-
-
@@ -4080,15 +4278,14 @@ Example
- (static) fromXDRObject(operation) → {Operation}
+ (static) endSponsoringFutureReserves(opts) → {xdr.Operation}
- Deconstructs the raw XDR operation object into the structured object that
-was used to create the operation (i.e. the opts parameter to most ops).
+ Create an "end sponsoring future reserves" operation.
@@ -4124,7 +4321,7 @@ (static) Source:
Parameters:
- operationopts
-xdr.Operation
+object
@@ -4185,7 +4382,70 @@ Parameters:
- An XDR Operation.
+ Options object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ source
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The source account for the operation. Defaults to the transaction's source account.
+
+
+
+
+
+
+
+
@@ -4218,33 +4478,50 @@ Returns:
-Operation
+xdr.Operation
+
+ xdr operation
+
+
-
-
-
-
+
+Example
+
+ const op = Operation.endSponsoringFutureReserves();
+
+
+
+
+
+
+
- (static) inflation(optsopt) → {xdr.InflationOp}
+ (static) extendFootprintTtl(opts) → {xdr.Operation}
- This operation generates the inflation.
+ Builds an operation to bump the expiration of a footprint (read and written
+ledger keys). Its only parameter is the number of ledgers to extend
+expiration for.
+The footprint itself is derived from the transaction (see
+TransactionBuilder's opts.sorobanData parameter, which is a
+xdr.SorobanTransactionData instance that contains fee data & resource
+usage as part of xdr.SorobanResources).
@@ -4280,7 +4557,7 @@ (static) in
Source:
Parameters:
Type
- Attributes
-
@@ -4339,21 +4614,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
- Options object
+ object holding operation parameters
@@ -4379,6 +4644,42 @@ Parameters:
+
+
+ extendTo
+
+
+number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ the number of ledgers past the LCL
+(last closed ledger) by which to extend the validity of the ledger keys in
+this transaction
+
+
+
+
+
+
sourceParameters:
- The optional source account.
+ an optional source account
@@ -4449,7 +4750,7 @@ Returns:
-xdr.InflationOp
+xdr.Operation
@@ -4457,7 +4758,8 @@ Returns:
- Inflation operation
+ a Bump Footprint Expiration operation
+(xdr.ExtendFootprintTTLOp)
@@ -4472,14 +4774,15 @@ Returns:
- (static) invokeHostFunction(opts) → {xdr.Operation}
+ (static) fromXDRObject(operation) → {Operation}
- Invokes a single smart contract function.
+ Deconstructs the raw XDR operation object into the structured object that
+was used to create the operation (i.e. the opts parameter to most ops).
@@ -4515,7 +4818,7 @@ (static)
Source:
Parameters:
- opts
-
-
-object
-
-
-
-
-
-
-
-
-
-
- options object
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- func
-
-
-xdr.HostFunction
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- host function to execute (with its
-wrapped parameters)
-
-
-
-
-
-
-
-
- auth
-
-
-Array.<xdr.SorobanAuthorizationEntry>
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- list outlining the
-tree of authorizations required for the call
-
-
-
-
-
-
-
-
- sourceoperation
-string
+xdr.Operation
-
-
- <optional>
-
-
-
-
-
-
-
- an optional source account
-
-
-
-
-
-
-
-
+ An XDR Operation.
@@ -4744,18 +4912,13 @@ Returns:
-xdr.Operation
+Operation
-
- an Invoke Host Function operation
-(xdr.InvokeHostFunctionOp)
-
-
@@ -4768,19 +4931,14 @@ Returns:
- (static) isValidAmount(value, allowZero) → {boolean}
+ (static) inflation(optsopt) → {xdr.InflationOp}
- Validates that a given amount is possible for a Stellar asset.
-Specifically, this means that the amount is well, a valid number, but also
-that it is within the int64 range and has no more than 7 decimal levels of
-precision.
-Note that while smart contracts allow larger amounts, this is oriented
-towards validating the standard Stellar operations.
+ This operation generates the inflation.
@@ -4816,7 +4974,7 @@ (static) Source:
Parameters:
Type
-
+ Attributes
- Default
+
Description
@@ -4862,60 +5020,97 @@ Parameters:
- valueopts
-string
+object
+
+
+ <optional>
+
+
+
-
-
+
+
- the amount to validate
+ Options object
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- allowZerosource
-boolean
+string
+
+
+ <optional>
+
-
-
- false
+
+
+
- optionally, whether or not zero is valid (default: no)
+ The optional source account.
+
+
+
+
+
+
+
+
@@ -4948,13 +5143,17 @@ Returns:
-boolean
+xdr.InflationOp
+
+ Inflation operation
+
+
@@ -4967,14 +5166,14 @@ Returns:
- (static) liquidityPoolDeposit(opts) → {xdr.Operation}
+ (static) invokeContractFunction(opts) → {xdr.Operation}
- Creates a liquidity pool deposit operation.
+ Returns an operation that invokes a contract function.
@@ -5010,7 +5209,7 @@ (static
Source:
(static
See:
@@ -5067,7 +5270,7 @@ Parameters:
-object
+any
@@ -5078,7 +5281,7 @@ Parameters:
- Options object
+ the set of parameters
@@ -5106,7 +5309,7 @@ Parameters:
- liquidityPoolIdcontract
@@ -5131,7 +5334,7 @@ Parameters:
- The liquidity pool ID.
+ a strkey-fied contract address (C...)
@@ -5140,7 +5343,7 @@ Parameters:
- maxAmountAfunction
@@ -5165,7 +5368,7 @@ Parameters:
- Maximum amount of first asset to deposit.
+ the name of the contract fn to invoke
@@ -5174,13 +5377,13 @@ Parameters:
- maxAmountBargs
-string
+Array.<xdr.ScVal>
@@ -5199,7 +5402,9 @@ Parameters:
- Maximum amount of second asset to deposit.
+ parameters to pass to the function
+invocation (try nativeToScVal or ScInt to make building
+these easier)
@@ -5208,22 +5413,13 @@ Parameters:
- minPriceauth
-number
-|
-
-string
-|
-
-BigNumber
-|
-
-Object
+Array.<xdr.SorobanAuthorizationEntry>
@@ -5232,6 +5428,8 @@ Parameters:
+ <optional>
+
@@ -5242,76 +5440,44 @@ Parameters:
- Minimum depositA/depositB price.
+ an optional list
+outlining the tree of authorizations required for the call
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- nsource
-number
+string
-
-
-
-
- If opts.minPrice is an object: the price numerator
+
-
-
-
-
-
-
-
- d
-
+ <optional>
-number
-
-
-
+
+
+
- If opts.minPrice is an object: the price denominator
+ an optional source account
@@ -5325,243 +5491,80 @@ Parameters:
+
+
-
-
- maxPrice
-
-
-number
-|
-string
-|
-BigNumber
-|
-Object
-
-
-
-
-
-
-
-
-
-
-
- Maximum depositA/depositB price.
-
-
-
-
-
-
- Name
-
- Type
+
+Returns:
+
+ -
+ Type:
+
+ -
+
xdr.Operation
- Description
-
-
-
-
+
+
-
-
- n
-
-
-number
+
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
+
+
+
-
-
-
+
+
+
-
- If opts.maxPrice is an object: the price numerator
-
-
-
+
+
+ (static) invokeHostFunction(opts) → {xdr.Operation}
-
-
- d
-
-
-number
+
+ Invokes a single smart contract host function.
+
-
-
-
-
-
- If opts.maxPrice is an object: the price denominator
-
-
-
+
+
-
-
-
-
-
+
-
-
- source
-
-
-string
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The source account for the operation. Defaults to the transaction's source account.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
xdr.Operation
-
-
-
-
-
-
-
- The resulting operation (xdr.LiquidityPoolDepositOp).
-
-
-
-
-
-
-
-
scValToN
Source:
Returns:
diff --git a/FeeBumpTransaction.html b/FeeBumpTransaction.html
index e423bfb..3a6118a 100644
--- a/FeeBumpTransaction.html
+++ b/FeeBumpTransaction.html
@@ -24,7 +24,7 @@
@@ -2040,7 +2040,7 @@ Returns:
diff --git a/Int128_Int128.html b/Int128_Int128.html
index c15cf68..8419ac1 100644
--- a/Int128_Int128.html
+++ b/Int128_Int128.html
@@ -24,7 +24,7 @@
@@ -230,7 +230,7 @@ Parameters:
diff --git a/Int256_Int256.html b/Int256_Int256.html
index 0a00e6b..eb21507 100644
--- a/Int256_Int256.html
+++ b/Int256_Int256.html
@@ -24,7 +24,7 @@
@@ -230,7 +230,7 @@ Parameters:
diff --git a/Keypair.html b/Keypair.html
index 8bfa84d..85f20bb 100644
--- a/Keypair.html
+++ b/Keypair.html
@@ -24,7 +24,7 @@
@@ -2462,7 +2462,7 @@ Returns:
diff --git a/LiquidityPoolAsset.html b/LiquidityPoolAsset.html
index fc88db3..35b4193 100644
--- a/LiquidityPoolAsset.html
+++ b/LiquidityPoolAsset.html
@@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@ Returns:
diff --git a/LiquidityPoolId.html b/LiquidityPoolId.html
index c7b42aa..97c983a 100644
--- a/LiquidityPoolId.html
+++ b/LiquidityPoolId.html
@@ -24,7 +24,7 @@
@@ -867,7 +867,7 @@ Returns:
diff --git a/Memo.html b/Memo.html
index edc76c0..2dfe01b 100644
--- a/Memo.html
+++ b/Memo.html
@@ -24,7 +24,7 @@
@@ -1386,7 +1386,7 @@ Returns:
diff --git a/MuxedAccount.html b/MuxedAccount.html
index b56d531..8131865 100644
--- a/MuxedAccount.html
+++ b/MuxedAccount.html
@@ -24,7 +24,7 @@
@@ -985,7 +985,7 @@ Returns:
diff --git a/Operation.html b/Operation.html
index 33871e0..622a062 100644
--- a/Operation.html
+++ b/Operation.html
@@ -24,7 +24,7 @@
@@ -99,7 +99,7 @@ new Operatio
Operation.liquidityPoolDepositOperation.liquidityPoolWithdrawOperation.invokeHostFunctionOperation.bumpFootprintExpirationOperation.extendFootprintTtlOpOperation.restoreFootprintExample
- (static) bumpFootprintExpiration(opts) → {xdr.Operation}
+ (static) bumpSequence(opts) → {xdr.BumpSequenceOp}
- Builds an operation to bump the expiration of a footprint (read and written
-ledger keys). Its only parameter is the number of ledgers to extend
-expiration for.
-The footprint itself is derived from the transaction (see
-TransactionBuilder's opts.sorobanData parameter, which is a
-xdr.SorobanTransactionData instance that contains fee data & resource
-usage as part of xdr.SorobanResources).
+ This operation bumps sequence number.
@@ -1100,7 +1094,7 @@ (sta
Source:
Parameters:
- object holding operation parameters
+ Options object
@@ -1189,13 +1183,13 @@ Parameters:
- ledgersToExpirebumpTo
-number
+string
@@ -1214,9 +1208,7 @@ Parameters:
- the number of ledgers past the LCL
-(last closed ledger) by which to extend the validity of the ledger keys in
-this transaction
+ Sequence number to bump to.
@@ -1252,7 +1244,7 @@ Parameters:
- an optional source account
+ The optional source account.
@@ -1293,7 +1285,7 @@ Returns:
-xdr.Operation
+xdr.BumpSequenceOp
@@ -1301,8 +1293,7 @@ Returns:
- a Bump Footprint Expiration operation
-(xdr.BumpFootprintExpirationOp)
+ Operation
@@ -1317,14 +1308,15 @@ Returns:
- (static) bumpSequence(opts) → {xdr.BumpSequenceOp}
+ (static) changeTrust(opts) → {xdr.ChangeTrustOp}
- This operation bumps sequence number.
+ Returns an XDR ChangeTrustOp. A "change trust" operation adds, removes, or updates a
+trust line for a given asset from the source account to another.
@@ -1360,7 +1352,7 @@ (static) Source:
Parameters:
- bumpToasset
+
+
+Asset
+|
+
+LiquidityPoolAsset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The asset for the trust line.
+
+
+
+
+
+
+
+
+ limit
@@ -1464,6 +1493,8 @@ Parameters:
+ <optional>
+
@@ -1474,7 +1505,8 @@ Parameters:
- Sequence number to bump to.
+ The limit for the asset, defaults to max int64.
+If the limit is set to "0" it deletes the trustline.
@@ -1510,7 +1542,7 @@ Parameters:
- The optional source account.
+ The source account (defaults to transaction source).
@@ -1551,7 +1583,7 @@ Returns:
-xdr.BumpSequenceOp
+xdr.ChangeTrustOp
@@ -1559,7 +1591,7 @@ Returns:
- Operation
+ Change Trust operation
@@ -1574,15 +1606,14 @@ Returns:
- (static) changeTrust(opts) → {xdr.ChangeTrustOp}
+ (static) claimClaimableBalance(opts) → {xdr.Operation}
- Returns an XDR ChangeTrustOp. A "change trust" operation adds, removes, or updates a
-trust line for a given asset from the source account to another.
+ Create a new claim claimable balance operation.
@@ -1618,7 +1649,7 @@ (static)
Source:
Parameters:
- asset
-
-
-Asset
-|
-
-LiquidityPoolAsset
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The asset for the trust line.
-
-
-
-
-
-
-
-
- limitbalanceId
@@ -1759,8 +1753,6 @@ Parameters:
- <optional>
-
@@ -1771,8 +1763,7 @@ Parameters:
- The limit for the asset, defaults to max int64.
-If the limit is set to "0" it deletes the trustline.
+ The claimable balance id to be claimed.
@@ -1808,7 +1799,7 @@ Parameters:
- The source account (defaults to transaction source).
+ The source account for the operation. Defaults to the transaction's source account.
@@ -1849,7 +1840,7 @@ Returns:
-xdr.ChangeTrustOp
+xdr.Operation
@@ -1857,7 +1848,7 @@ Returns:
- Change Trust operation
+ Claim claimable balance operation
@@ -1865,6 +1856,15 @@ Returns:
+
+Example
+
+ const op = Operation.claimClaimableBalance({
+ balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
+});
+
+
+
@@ -1872,14 +1872,14 @@ Returns:
- (static) claimClaimableBalance(opts) → {xdr.Operation}
+ (static) clawback(opts) → {xdr.ClawbackOp}
- Create a new claim claimable balance operation.
+ Creates a clawback operation.
@@ -1915,13 +1915,20 @@ (stati
Source:
See:
+
+
+
+
@@ -2004,7 +2011,41 @@ Parameters:
- balanceIdasset
+
+
+Asset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The asset being clawed back.
+
+
+
+
+
+
+
+
+ amount
@@ -2029,7 +2070,42 @@ Parameters:
- The claimable balance id to be claimed.
+ The amount of the asset to claw back.
+
+
+
+
+
+
+
+
+ from
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The public key of the (optionally-muxed)
+account to claw back from.
@@ -2065,7 +2141,8 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
+ The source account for the operation.
+Defaults to the transaction's source account.
@@ -2106,31 +2183,18 @@ Returns:
-xdr.Operation
+xdr.ClawbackOp
-
- Claim claimable balance operation
-
-
-
-Example
-
- const op = Operation.claimClaimableBalance({
- balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
-});
-
-
-
@@ -2138,14 +2202,14 @@ Example
- (static) clawback(opts) → {xdr.ClawbackOp}
+ (static) clawbackClaimableBalance(opts) → {xdr.ClawbackClaimableBalanceOp}
- Creates a clawback operation.
+ Creates a clawback operation for a claimable balance.
@@ -2181,20 +2245,13 @@ (static) cla
Source:
See:
-
-
-
-
@@ -2277,75 +2334,7 @@ Parameters:
- asset
-
-
-Asset
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The asset being clawed back.
-
-
-
-
-
-
-
-
- amount
-
-
-string
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The amount of the asset to claw back.
-
-
-
-
-
-
-
-
- frombalanceId
@@ -2370,8 +2359,7 @@ Parameters:
- The public key of the (optionally-muxed)
-account to claw back from.
+ The claimable balance ID to be clawed back.
@@ -2407,8 +2395,7 @@ Parameters:
- The source account for the operation.
-Defaults to the transaction's source account.
+ The source account for the operation. Defaults to the transaction's source account.
@@ -2449,7 +2436,7 @@ Returns:
-xdr.ClawbackOp
+xdr.ClawbackClaimableBalanceOp
@@ -2461,6 +2448,15 @@ Returns:
+
+Example
+
+ const op = Operation.clawbackClaimableBalance({
+ balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
+});
+
+
+
@@ -2468,14 +2464,14 @@ Returns:
- (static) clawbackClaimableBalance(opts) → {xdr.ClawbackClaimableBalanceOp}
+ (static) createAccount(opts) → {xdr.CreateAccountOp}
- Creates a clawback operation for a claimable balance.
+ Create and fund a non existent account.
@@ -2511,7 +2507,7 @@ (st
Source:
Parameters:
- balanceIddestination
@@ -2625,7 +2621,42 @@ Parameters:
- The claimable balance ID to be clawed back.
+ Destination account ID to create an account for.
+
+
+
+
+
+
+
+
+ startingBalance
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Amount in XLM the account should be funded for. Must be greater
+than the reserve balance amount.
@@ -2661,7 +2692,7 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
+ The source account for the payment. Defaults to the transaction's source account.
@@ -2702,26 +2733,21 @@ Returns:
-xdr.ClawbackClaimableBalanceOp
+xdr.CreateAccountOp
-
+
+ Create account operation
+
+
-
-Example
-
- const op = Operation.clawbackClaimableBalance({
- balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
-});
-
-
@@ -2730,14 +2756,14 @@ Example
- (static) createAccount(opts) → {xdr.CreateAccountOp}
+ (static) createClaimableBalance(opts) → {xdr.Operation}
- Create and fund a non existent account.
+ Create a new claimable balance operation.
@@ -2773,7 +2799,7 @@ (static) Source:
Parameters:
- destinationasset
-string
+Asset
@@ -2887,7 +2913,7 @@ Parameters:
- Destination account ID to create an account for.
+ The asset for the claimable balance.
@@ -2896,7 +2922,7 @@ Parameters:
- startingBalanceamount
@@ -2921,8 +2947,41 @@ Parameters:
- Amount in XLM the account should be funded for. Must be greater
-than the reserve balance amount.
+ Amount.
+
+
+
+
+
+
+
+
+ claimants
+
+
+Array.<Claimant>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An array of Claimants
@@ -2958,7 +3017,7 @@ Parameters:
- The source account for the payment. Defaults to the transaction's source account.
+ The source account for the operation. Defaults to the transaction's source account.
@@ -2999,7 +3058,7 @@ Returns:
-xdr.CreateAccountOp
+xdr.Operation
@@ -3007,7 +3066,7 @@ Returns:
- Create account operation
+ Create claimable balance operation
@@ -3015,6 +3074,29 @@ Returns:
+
+Example
+
+ const asset = new Asset(
+ 'USD',
+ 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
+);
+const amount = '100.0000000';
+const claimants = [
+ new Claimant(
+ 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ',
+ Claimant.predicateBeforeAbsoluteTime("4102444800000")
+ )
+];
+
+const op = Operation.createClaimableBalance({
+ asset,
+ amount,
+ claimants
+});
+
+
+
@@ -3022,14 +3104,14 @@ Returns:
- (static) createClaimableBalance(opts) → {xdr.Operation}
+ (static) createCustomContract(opts) → {xdr.Operation}
- Create a new claimable balance operation.
+ Returns an operation that creates a custom WASM contract.
@@ -3065,13 +3147,20 @@ (stat
Source:
See:
+
+
+
+
@@ -3115,7 +3204,7 @@ Parameters:
-object
+any
@@ -3126,7 +3215,7 @@ Parameters:
- Options object
+ the set of parameters
@@ -3154,13 +3243,13 @@ Parameters:
- assetaddress
-Asset
+Address
@@ -3179,7 +3268,7 @@ Parameters:
- The asset for the claimable balance.
+ the contract uploader address
@@ -3188,13 +3277,16 @@ Parameters:
- amountwasmHash
-string
+Uint8Array
+|
+
+Buffer
@@ -3213,7 +3305,9 @@ Parameters:
- Amount.
+ the SHA-256 hash of the contract
+WASM you're uploading (see hash and
+Operation.uploadContractWasm)
@@ -3222,13 +3316,16 @@ Parameters:
- claimantssalt
-Array.<Claimant>
+Uint8Array
+|
+
+Buffer
@@ -3237,6 +3334,8 @@ Parameters:
+ <optional>
+
@@ -3247,7 +3346,46 @@ Parameters:
- An array of Claimants
+ an optional, 32-byte salt to
+distinguish deployment instances of the same wasm from the same user (if
+omitted, one will be generated for you)
+
+
+
+
+
+
+
+
+ auth
+
+
+Array.<xdr.SorobanAuthorizationEntry>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ an optional list
+outlining the tree of authorizations required for the call
@@ -3283,7 +3421,7 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
+ an optional source account
@@ -3332,7 +3470,8 @@ Returns:
- Create claimable balance operation
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
@@ -3340,29 +3479,6 @@ Returns:
-
-Example
-
- const asset = new Asset(
- 'USD',
- 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
-);
-const amount = '100.0000000';
-const claimants = [
- new Claimant(
- 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ',
- Claimant.predicateBeforeAbsoluteTime("4102444800000")
- )
-];
-
-const op = Operation.createClaimableBalance({
- asset,
- amount,
- claimants
-});
-
-
-
@@ -3850,14 +3966,14 @@ Returns:
- (static) endSponsoringFutureReserves(opts) → {xdr.Operation}
+ (static) createStellarAssetContract(opts) → {xdr.Operation}
- Create an "end sponsoring future reserves" operation.
+ Returns an operation that wraps a Stellar asset into a token contract.
@@ -3893,13 +4009,26 @@
Source:
See:
+
+
+
+
@@ -3943,7 +4072,7 @@ Parameters:
-object
+any
@@ -3954,7 +4083,7 @@ Parameters:
- Options object
+ the set of parameters
@@ -3980,6 +4109,81 @@ Parameters:
+
+
+ asset
+
+
+Asset
+|
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ the Stellar asset to wrap, either as an
+Asset object or in canonical form (SEP-11, code:issuer)
+
+
+
+
+
+
+
+
+ auth
+
+
+Array.<xdr.SorobanAuthorizationEntry>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ an optional list
+outlining the tree of authorizations required for the call
+
+
+
+
+
+
sourceParameters:
- The source account for the operation. Defaults to the transaction's source account.
+ an optional source account
@@ -4058,7 +4262,8 @@ Returns:
- xdr operation
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
@@ -4066,13 +4271,6 @@ Returns:
-
-Example
-
- const op = Operation.endSponsoringFutureReserves();
-
-
-
@@ -4080,15 +4278,14 @@ Example
- (static) fromXDRObject(operation) → {Operation}
+ (static) endSponsoringFutureReserves(opts) → {xdr.Operation}
- Deconstructs the raw XDR operation object into the structured object that
-was used to create the operation (i.e. the opts parameter to most ops).
+ Create an "end sponsoring future reserves" operation.
@@ -4124,7 +4321,7 @@ (static) Source:
Parameters:
- operationopts
-xdr.Operation
+object
@@ -4185,7 +4382,70 @@ Parameters:
- An XDR Operation.
+ Options object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ source
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The source account for the operation. Defaults to the transaction's source account.
+
+
+
+
+
+
+
+
@@ -4218,33 +4478,50 @@ Returns:
-Operation
+xdr.Operation
+
+ xdr operation
+
+
-
-
-
-
+
+Example
+
+ const op = Operation.endSponsoringFutureReserves();
+
+
+
+
+
+
+
- (static) inflation(optsopt) → {xdr.InflationOp}
+ (static) extendFootprintTtl(opts) → {xdr.Operation}
- This operation generates the inflation.
+ Builds an operation to bump the expiration of a footprint (read and written
+ledger keys). Its only parameter is the number of ledgers to extend
+expiration for.
+The footprint itself is derived from the transaction (see
+TransactionBuilder's opts.sorobanData parameter, which is a
+xdr.SorobanTransactionData instance that contains fee data & resource
+usage as part of xdr.SorobanResources).
@@ -4280,7 +4557,7 @@ (static) in
Source:
Parameters:
Type
- Attributes
-
@@ -4339,21 +4614,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
- Options object
+ object holding operation parameters
@@ -4379,6 +4644,42 @@ Parameters:
+
+
+ extendTo
+
+
+number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ the number of ledgers past the LCL
+(last closed ledger) by which to extend the validity of the ledger keys in
+this transaction
+
+
+
+
+
+
sourceParameters:
- The optional source account.
+ an optional source account
@@ -4449,7 +4750,7 @@ Returns:
-xdr.InflationOp
+xdr.Operation
@@ -4457,7 +4758,8 @@ Returns:
- Inflation operation
+ a Bump Footprint Expiration operation
+(xdr.ExtendFootprintTTLOp)
@@ -4472,14 +4774,15 @@ Returns:
- (static) invokeHostFunction(opts) → {xdr.Operation}
+ (static) fromXDRObject(operation) → {Operation}
- Invokes a single smart contract function.
+ Deconstructs the raw XDR operation object into the structured object that
+was used to create the operation (i.e. the opts parameter to most ops).
@@ -4515,7 +4818,7 @@ (static)
Source:
Parameters:
- opts
-
-
-object
-
-
-
-
-
-
-
-
-
-
- options object
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- func
-
-
-xdr.HostFunction
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- host function to execute (with its
-wrapped parameters)
-
-
-
-
-
-
-
-
- auth
-
-
-Array.<xdr.SorobanAuthorizationEntry>
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- list outlining the
-tree of authorizations required for the call
-
-
-
-
-
-
-
-
- sourceoperation
-string
+xdr.Operation
-
-
- <optional>
-
-
-
-
-
-
-
- an optional source account
-
-
-
-
-
-
-
-
+ An XDR Operation.
@@ -4744,18 +4912,13 @@ Returns:
-xdr.Operation
+Operation
-
- an Invoke Host Function operation
-(xdr.InvokeHostFunctionOp)
-
-
@@ -4768,19 +4931,14 @@ Returns:
- (static) isValidAmount(value, allowZero) → {boolean}
+ (static) inflation(optsopt) → {xdr.InflationOp}
- Validates that a given amount is possible for a Stellar asset.
-Specifically, this means that the amount is well, a valid number, but also
-that it is within the int64 range and has no more than 7 decimal levels of
-precision.
-Note that while smart contracts allow larger amounts, this is oriented
-towards validating the standard Stellar operations.
+ This operation generates the inflation.
@@ -4816,7 +4974,7 @@ (static) Source:
Parameters:
Type
-
+ Attributes
- Default
+
Description
@@ -4862,60 +5020,97 @@ Parameters:
- valueopts
-string
+object
+
+
+ <optional>
+
+
+
-
-
+
+
- the amount to validate
+ Options object
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- allowZerosource
-boolean
+string
+
+
+ <optional>
+
-
-
- false
+
+
+
- optionally, whether or not zero is valid (default: no)
+ The optional source account.
+
+
+
+
+
+
+
+
@@ -4948,13 +5143,17 @@ Returns:
-boolean
+xdr.InflationOp
+
+ Inflation operation
+
+
@@ -4967,14 +5166,14 @@ Returns:
- (static) liquidityPoolDeposit(opts) → {xdr.Operation}
+ (static) invokeContractFunction(opts) → {xdr.Operation}
- Creates a liquidity pool deposit operation.
+ Returns an operation that invokes a contract function.
@@ -5010,7 +5209,7 @@ (static
Source:
(static
See:
@@ -5067,7 +5270,7 @@ Parameters:
-object
+any
@@ -5078,7 +5281,7 @@ Parameters:
- Options object
+ the set of parameters
@@ -5106,7 +5309,7 @@ Parameters:
- liquidityPoolIdcontract
@@ -5131,7 +5334,7 @@ Parameters:
- The liquidity pool ID.
+ a strkey-fied contract address (C...)
@@ -5140,7 +5343,7 @@ Parameters:
- maxAmountAfunction
@@ -5165,7 +5368,7 @@ Parameters:
- Maximum amount of first asset to deposit.
+ the name of the contract fn to invoke
@@ -5174,13 +5377,13 @@ Parameters:
- maxAmountBargs
-string
+Array.<xdr.ScVal>
@@ -5199,7 +5402,9 @@ Parameters:
- Maximum amount of second asset to deposit.
+ parameters to pass to the function
+invocation (try nativeToScVal or ScInt to make building
+these easier)
@@ -5208,22 +5413,13 @@ Parameters:
- minPriceauth
-number
-|
-
-string
-|
-
-BigNumber
-|
-
-Object
+Array.<xdr.SorobanAuthorizationEntry>
@@ -5232,6 +5428,8 @@ Parameters:
+ <optional>
+
@@ -5242,76 +5440,44 @@ Parameters:
- Minimum depositA/depositB price.
+ an optional list
+outlining the tree of authorizations required for the call
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- nsource
-number
+string
-
-
-
-
- If opts.minPrice is an object: the price numerator
+
-
-
-
-
-
-
-
- d
-
+ <optional>
-number
-
-
-
+
+
+
- If opts.minPrice is an object: the price denominator
+ an optional source account
@@ -5325,243 +5491,80 @@ Parameters:
+
+
-
-
- maxPrice
-
-
-number
-|
-string
-|
-BigNumber
-|
-Object
-
-
-
-
-
-
-
-
-
-
-
- Maximum depositA/depositB price.
-
-
-
-
-
-
- Name
-
- Type
+
+Returns:
+
+ -
+ Type:
+
+ -
+
xdr.Operation
- Description
-
-
-
-
+
+
-
-
- n
-
-
-number
+
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
+
+
+
-
-
-
+
+
+
-
- If opts.maxPrice is an object: the price numerator
-
-
-
+
+
+ (static) invokeHostFunction(opts) → {xdr.Operation}
-
-
- d
-
-
-number
+
+ Invokes a single smart contract host function.
+
-
-
-
-
-
- If opts.maxPrice is an object: the price denominator
-
-
-
+
+
-
-
-
-
-
+
-
-
- source
-
-
-string
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The source account for the operation. Defaults to the transaction's source account.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
- -
- Type:
-
- -
-
-
xdr.Operation
-
-
-
-
-
-
-
- The resulting operation (xdr.LiquidityPoolDepositOp).
-
-
-
-
-
-
-
-
Returns:
diff --git a/Int128_Int128.html b/Int128_Int128.html index c15cf68..8419ac1 100644 --- a/Int128_Int128.html +++ b/Int128_Int128.html @@ -24,7 +24,7 @@
@@ -230,7 +230,7 @@
diff --git a/Int256_Int256.html b/Int256_Int256.html index 0a00e6b..eb21507 100644 --- a/Int256_Int256.html +++ b/Int256_Int256.html @@ -24,7 +24,7 @@(static) Source:
@@ -3022,14 +3104,14 @@ Parameters:
diff --git a/Int256_Int256.html b/Int256_Int256.html index 0a00e6b..eb21507 100644 --- a/Int256_Int256.html +++ b/Int256_Int256.html @@ -24,7 +24,7 @@
@@ -230,7 +230,7 @@
diff --git a/Keypair.html b/Keypair.html index 8bfa84d..85f20bb 100644 --- a/Keypair.html +++ b/Keypair.html @@ -24,7 +24,7 @@
@@ -2730,14 +2756,14 @@ Parameters:
diff --git a/Keypair.html b/Keypair.html index 8bfa84d..85f20bb 100644 --- a/Keypair.html +++ b/Keypair.html @@ -24,7 +24,7 @@
@@ -2462,7 +2462,7 @@
diff --git a/LiquidityPoolAsset.html b/LiquidityPoolAsset.html index fc88db3..35b4193 100644 --- a/LiquidityPoolAsset.html +++ b/LiquidityPoolAsset.html @@ -24,7 +24,7 @@(st
-Returns:
diff --git a/LiquidityPoolAsset.html b/LiquidityPoolAsset.html index fc88db3..35b4193 100644 --- a/LiquidityPoolAsset.html +++ b/LiquidityPoolAsset.html @@ -24,7 +24,7 @@
@@ -919,7 +919,7 @@
diff --git a/LiquidityPoolId.html b/LiquidityPoolId.html index c7b42aa..97c983a 100644 --- a/LiquidityPoolId.html +++ b/LiquidityPoolId.html @@ -24,7 +24,7 @@(static) cla
@@ -2468,14 +2464,14 @@ Returns:
diff --git a/LiquidityPoolId.html b/LiquidityPoolId.html index c7b42aa..97c983a 100644 --- a/LiquidityPoolId.html +++ b/LiquidityPoolId.html @@ -24,7 +24,7 @@
@@ -867,7 +867,7 @@
diff --git a/Memo.html b/Memo.html index edc76c0..2dfe01b 100644 --- a/Memo.html +++ b/Memo.html @@ -24,7 +24,7 @@
@@ -2138,14 +2202,14 @@ Returns:
diff --git a/Memo.html b/Memo.html index edc76c0..2dfe01b 100644 --- a/Memo.html +++ b/Memo.html @@ -24,7 +24,7 @@
@@ -1386,7 +1386,7 @@
diff --git a/MuxedAccount.html b/MuxedAccount.html index b56d531..8131865 100644 --- a/MuxedAccount.html +++ b/MuxedAccount.html @@ -24,7 +24,7 @@(stati
-Returns:
diff --git a/MuxedAccount.html b/MuxedAccount.html index b56d531..8131865 100644 --- a/MuxedAccount.html +++ b/MuxedAccount.html @@ -24,7 +24,7 @@
@@ -985,7 +985,7 @@
diff --git a/Operation.html b/Operation.html index 33871e0..622a062 100644 --- a/Operation.html +++ b/Operation.html @@ -24,7 +24,7 @@(sta
@@ -1872,14 +1872,14 @@ Returns:
diff --git a/Operation.html b/Operation.html index 33871e0..622a062 100644 --- a/Operation.html +++ b/Operation.html @@ -24,7 +24,7 @@
@@ -99,7 +99,7 @@
@@ -1051,20 +1051,14 @@ new Operatio
Operation.liquidityPoolDepositOperation.liquidityPoolWithdrawOperation.invokeHostFunctionOperation.bumpFootprintExpirationOperation.extendFootprintTtlOpOperation.restoreFootprintExample
-(static) bumpFootprintExpiration(opts) → {xdr.Operation}
+(static) bumpSequence(opts) → {xdr.BumpSequenceOp}
-
@@ -1100,7 +1094,7 @@ Builds an operation to bump the expiration of a footprint (read and written -ledger keys). Its only parameter is the number of ledgers to extend -expiration for.
-The footprint itself is derived from the transaction (see
-TransactionBuilder's opts.sorobanData parameter, which is a
-xdr.SorobanTransactionData instance that contains fee data & resource
-usage as part of xdr.SorobanResources).
This operation bumps sequence number.
(sta
Source:
Parameters:
- object holding operation parameters
+ Options object
@@ -1189,13 +1183,13 @@ Parameters:
- ledgersToExpirebumpTo
-number
+string
@@ -1214,9 +1208,7 @@ Parameters:
- the number of ledgers past the LCL
-(last closed ledger) by which to extend the validity of the ledger keys in
-this transaction
+ Sequence number to bump to.
@@ -1252,7 +1244,7 @@ Parameters:
- an optional source account
+ The optional source account.
@@ -1293,7 +1285,7 @@ Returns:
-xdr.Operation
+xdr.BumpSequenceOp
@@ -1301,8 +1293,7 @@ Returns:
- a Bump Footprint Expiration operation
-(xdr.BumpFootprintExpirationOp)
+ Operation
@@ -1317,14 +1308,15 @@ Returns:
- (static) bumpSequence(opts) → {xdr.BumpSequenceOp}
+ (static) changeTrust(opts) → {xdr.ChangeTrustOp}
- This operation bumps sequence number.
+ Returns an XDR ChangeTrustOp. A "change trust" operation adds, removes, or updates a
+trust line for a given asset from the source account to another.
@@ -1360,7 +1352,7 @@ (static) Source:
Parameters:
- bumpToasset
+
+
+Asset
+|
+
+LiquidityPoolAsset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The asset for the trust line.
+
+
+
+
+
+
+
+
+ limit
@@ -1464,6 +1493,8 @@ Parameters:
+ <optional>
+
@@ -1474,7 +1505,8 @@ Parameters:
- Sequence number to bump to.
+ The limit for the asset, defaults to max int64.
+If the limit is set to "0" it deletes the trustline.
@@ -1510,7 +1542,7 @@ Parameters:
- The optional source account.
+ The source account (defaults to transaction source).
@@ -1551,7 +1583,7 @@ Returns:
-xdr.BumpSequenceOp
+xdr.ChangeTrustOp
@@ -1559,7 +1591,7 @@ Returns:
- Operation
+ Change Trust operation
@@ -1574,15 +1606,14 @@ Returns:
- (static) changeTrust(opts) → {xdr.ChangeTrustOp}
+ (static) claimClaimableBalance(opts) → {xdr.Operation}
- Returns an XDR ChangeTrustOp. A "change trust" operation adds, removes, or updates a
-trust line for a given asset from the source account to another.
+ Create a new claim claimable balance operation.
@@ -1618,7 +1649,7 @@ (static)
Source:
Parameters:
- asset
-
-
-Asset
-|
-
-LiquidityPoolAsset
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The asset for the trust line.
-
-
-
-
-
-
-
-
- limitbalanceId
@@ -1759,8 +1753,6 @@ Parameters:
- <optional>
-
@@ -1771,8 +1763,7 @@ Parameters:
- The limit for the asset, defaults to max int64.
-If the limit is set to "0" it deletes the trustline.
+ The claimable balance id to be claimed.
@@ -1808,7 +1799,7 @@ Parameters:
- The source account (defaults to transaction source).
+ The source account for the operation. Defaults to the transaction's source account.
@@ -1849,7 +1840,7 @@ Returns:
-xdr.ChangeTrustOp
+xdr.Operation
@@ -1857,7 +1848,7 @@ Returns:
- Change Trust operation
+ Claim claimable balance operation
@@ -1865,6 +1856,15 @@ Returns:
+
+Example
+
+ const op = Operation.claimClaimableBalance({
+ balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
+});
+
+
+
object holding operation parameters
+Options object
@@ -1189,13 +1183,13 @@Parameters:
ledgersToExpirebumpTonumber
+string
@@ -1214,9 +1208,7 @@ Parameters:
the number of ledgers past the LCL -(last closed ledger) by which to extend the validity of the ledger keys in -this transaction
+Sequence number to bump to.
an optional source account
+The optional source account.
xdr.Operation
+xdr.BumpSequenceOp
a Bump Footprint Expiration operation -(xdr.BumpFootprintExpirationOp)
+Operation
This operation bumps sequence number.
+Returns an XDR ChangeTrustOp. A "change trust" operation adds, removes, or updates a +trust line for a given asset from the source account to another.
Parameters:
bumpToassetAsset
+|
+
+LiquidityPoolAsset
+
+
+
+ The asset for the trust line.
+ +limitParameters:
+ @@ -1474,7 +1505,8 @@
Parameters:
Sequence number to bump to.
+The limit for the asset, defaults to max int64. +If the limit is set to "0" it deletes the trustline.
Parameters:
The optional source account.
+The source account (defaults to transaction source).
Returns:
xdr.BumpSequenceOp
+xdr.ChangeTrustOp
Returns:
-
@@ -1574,15 +1606,14 @@ Operation
+Change Trust operation
Returns:
-(static) changeTrust(opts) → {xdr.ChangeTrustOp}
+(static) claimClaimableBalance(opts) → {xdr.Operation}
-
@@ -1618,7 +1649,7 @@ Returns an XDR ChangeTrustOp. A "change trust" operation adds, removes, or updates a -trust line for a given asset from the source account to another.
+Create a new claim claimable balance operation.
(static)
Source:
Parameters:
- asset
-
-
-Asset
-|
-
-LiquidityPoolAsset
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The asset for the trust line.
-
-
-
-
-
-
-
-
- limitbalanceId
@@ -1759,8 +1753,6 @@ Parameters:
- <optional>
-
@@ -1771,8 +1763,7 @@ Parameters:
- The limit for the asset, defaults to max int64.
-If the limit is set to "0" it deletes the trustline.
+ The claimable balance id to be claimed.
@@ -1808,7 +1799,7 @@ Parameters:
- The source account (defaults to transaction source).
+ The source account for the operation. Defaults to the transaction's source account.
@@ -1849,7 +1840,7 @@ Returns:
-xdr.ChangeTrustOp
+xdr.Operation
@@ -1857,7 +1848,7 @@ Returns:
- Change Trust operation
+ Claim claimable balance operation
@@ -1865,6 +1856,15 @@ Returns:
+
+Example
+
+ const op = Operation.claimClaimableBalance({
+ balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
+});
+
+
+
assetAsset
-|
-
-LiquidityPoolAsset
-
-
-
- The asset for the trust line.
- -limitbalanceIdParameters:
- @@ -1771,8 +1763,7 @@
Parameters:
The limit for the asset, defaults to max int64. -If the limit is set to "0" it deletes the trustline.
+The claimable balance id to be claimed.
The source account (defaults to transaction source).
+The source account for the operation. Defaults to the transaction's source account.
xdr.ChangeTrustOp
+xdr.Operation
Change Trust operation
+Claim claimable balance operation
Example
+ +const op = Operation.claimClaimableBalance({
+ balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
+});Returns:
-(static) claimClaimableBalance(opts) → {xdr.Operation}
+(static) clawback(opts) → {xdr.ClawbackOp}
-
@@ -1915,13 +1915,20 @@ Create a new claim claimable balance operation.
+Creates a clawback operation.
(stati
Source:
See:
+
+
+
+
@@ -2004,7 +2011,41 @@ Parameters:
- balanceIdasset
+
+
+Asset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The asset being clawed back.
+
+
+
+
+
+
+
+
+ amount
@@ -2029,7 +2070,42 @@ Parameters:
- The claimable balance id to be claimed.
+ The amount of the asset to claw back.
+
+
+
+
+
+
+
+
+ from
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The public key of the (optionally-muxed)
+account to claw back from.
@@ -2065,7 +2141,8 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
+ The source account for the operation.
+Defaults to the transaction's source account.
@@ -2106,31 +2183,18 @@ Returns:
-xdr.Operation
+xdr.ClawbackOp
-
- Claim claimable balance operation
-
-
balanceIdassetAsset
+
+
+
+ The asset being clawed back.
+ +amountParameters:
The claimable balance id to be claimed.
+The amount of the asset to claw back.
+ +fromstring
+
+
+
+ The public key of the (optionally-muxed) +account to claw back from.
The source account for the operation. Defaults to the transaction's source account.
+The source account for the operation. +Defaults to the transaction's source account.
xdr.Operation
+xdr.ClawbackOp
Claim claimable balance operation
-
-
-
Example
- -const op = Operation.claimClaimableBalance({
- balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
-});Example
-(static) clawback(opts) → {xdr.ClawbackOp}
+(static) clawbackClaimableBalance(opts) → {xdr.ClawbackClaimableBalanceOp}
-
@@ -2181,20 +2245,13 @@ Creates a clawback operation.
+Creates a clawback operation for a claimable balance.
(static) cla
Source:
See:
-
-
-
-
@@ -2277,75 +2334,7 @@ Parameters:
- asset
-
-
-Asset
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The asset being clawed back.
-
-
-
-
-
-
-
-
- amount
-
-
-string
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The amount of the asset to claw back.
-
-
-
-
-
-
-
-
- frombalanceId
@@ -2370,8 +2359,7 @@ Parameters:
- The public key of the (optionally-muxed)
-account to claw back from.
+ The claimable balance ID to be clawed back.
@@ -2407,8 +2395,7 @@ Parameters:
- The source account for the operation.
-Defaults to the transaction's source account.
+ The source account for the operation. Defaults to the transaction's source account.
@@ -2449,7 +2436,7 @@ Returns:
-xdr.ClawbackOp
+xdr.ClawbackClaimableBalanceOp
@@ -2461,6 +2448,15 @@ Returns:
+
+Example
+
+ const op = Operation.clawbackClaimableBalance({
+ balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
+});
+
+
+
assetAsset
-
-
-
- The asset being clawed back.
- -amountstring
-
-
-
- The amount of the asset to claw back.
- -frombalanceIdParameters:
The public key of the (optionally-muxed) -account to claw back from.
+The claimable balance ID to be clawed back.
The source account for the operation. -Defaults to the transaction's source account.
+The source account for the operation. Defaults to the transaction's source account.
xdr.ClawbackOp
+xdr.ClawbackClaimableBalanceOp
Example
+ +const op = Operation.clawbackClaimableBalance({
+ balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
+});Returns:
-(static) clawbackClaimableBalance(opts) → {xdr.ClawbackClaimableBalanceOp}
+(static) createAccount(opts) → {xdr.CreateAccountOp}
-
@@ -2511,7 +2507,7 @@ Creates a clawback operation for a claimable balance.
+Create and fund a non existent account.
(st
Source:
Parameters:
- balanceIddestination
@@ -2625,7 +2621,42 @@ Parameters:
- The claimable balance ID to be clawed back.
+ Destination account ID to create an account for.
+
+
+
+
+
+
+
+
+ startingBalance
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Amount in XLM the account should be funded for. Must be greater
+than the reserve balance amount.
@@ -2661,7 +2692,7 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
+ The source account for the payment. Defaults to the transaction's source account.
@@ -2702,26 +2733,21 @@ Returns:
-xdr.ClawbackClaimableBalanceOp
+xdr.CreateAccountOp
-
+
+ Create account operation
+
+
balanceIddestinationParameters:
The claimable balance ID to be clawed back.
+Destination account ID to create an account for.
+ +startingBalancestring
+
+
+
+ Amount in XLM the account should be funded for. Must be greater +than the reserve balance amount.
The source account for the operation. Defaults to the transaction's source account.
+The source account for the payment. Defaults to the transaction's source account.
xdr.ClawbackClaimableBalanceOp
+xdr.CreateAccountOp
Create account operation
-
Example
- -const op = Operation.clawbackClaimableBalance({
- balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
-});Example
-(static) createAccount(opts) → {xdr.CreateAccountOp}
+(static) createClaimableBalance(opts) → {xdr.Operation}
-
@@ -2773,7 +2799,7 @@ Create and fund a non existent account.
+Create a new claimable balance operation.
(static) Source:
Parameters:
- destinationasset
-string
+Asset
@@ -2887,7 +2913,7 @@ Parameters:
- Destination account ID to create an account for.
+ The asset for the claimable balance.
@@ -2896,7 +2922,7 @@ Parameters:
- startingBalanceamount
@@ -2921,8 +2947,41 @@ Parameters:
- Amount in XLM the account should be funded for. Must be greater
-than the reserve balance amount.
+ Amount.
+
+
+
+
+
+
+
+
+ claimants
+
+
+Array.<Claimant>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ An array of Claimants
@@ -2958,7 +3017,7 @@ Parameters:
- The source account for the payment. Defaults to the transaction's source account.
+ The source account for the operation. Defaults to the transaction's source account.
@@ -2999,7 +3058,7 @@ Returns:
-xdr.CreateAccountOp
+xdr.Operation
@@ -3007,7 +3066,7 @@ Returns:
- Create account operation
+ Create claimable balance operation
@@ -3015,6 +3074,29 @@ Returns:
+
+Example
+
+ const asset = new Asset(
+ 'USD',
+ 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
+);
+const amount = '100.0000000';
+const claimants = [
+ new Claimant(
+ 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ',
+ Claimant.predicateBeforeAbsoluteTime("4102444800000")
+ )
+];
+
+const op = Operation.createClaimableBalance({
+ asset,
+ amount,
+ claimants
+});
+
+
+
destinationassetstring
+Asset
@@ -2887,7 +2913,7 @@ Parameters:
Destination account ID to create an account for.
+The asset for the claimable balance.
startingBalanceamountParameters:
Amount in XLM the account should be funded for. Must be greater -than the reserve balance amount.
+Amount.
+ +claimantsArray.<Claimant>
+
+
+
+ An array of Claimants
The source account for the payment. Defaults to the transaction's source account.
+The source account for the operation. Defaults to the transaction's source account.
xdr.CreateAccountOp
+xdr.Operation
Create account operation
+Create claimable balance operation
Example
+ +const asset = new Asset(
+ 'USD',
+ 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
+);
+const amount = '100.0000000';
+const claimants = [
+ new Claimant(
+ 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ',
+ Claimant.predicateBeforeAbsoluteTime("4102444800000")
+ )
+];
+
+const op = Operation.createClaimableBalance({
+ asset,
+ amount,
+ claimants
+});Returns:
-(static) createClaimableBalance(opts) → {xdr.Operation}
+(static) createCustomContract(opts) → {xdr.Operation}
-
@@ -3065,13 +3147,20 @@ Create a new claimable balance operation.
+Returns an operation that creates a custom WASM contract.
(stat
Source:
See:
+
+
+
+
@@ -3115,7 +3204,7 @@ Parameters:
-object
+any
@@ -3126,7 +3215,7 @@ Parameters:
- Options object
+ the set of parameters
@@ -3154,13 +3243,13 @@ Parameters:
- assetaddress
-Asset
+Address
@@ -3179,7 +3268,7 @@ Parameters:
- The asset for the claimable balance.
+ the contract uploader address
@@ -3188,13 +3277,16 @@ Parameters:
- amountwasmHash
-string
+Uint8Array
+|
+
+Buffer
@@ -3213,7 +3305,9 @@ Parameters:
- Amount.
+ the SHA-256 hash of the contract
+WASM you're uploading (see hash and
+Operation.uploadContractWasm)
@@ -3222,13 +3316,16 @@ Parameters:
- claimantssalt
-Array.<Claimant>
+Uint8Array
+|
+
+Buffer
@@ -3237,6 +3334,8 @@ Parameters:
+ <optional>
+
@@ -3247,7 +3346,46 @@ Parameters:
- An array of Claimants
+ an optional, 32-byte salt to
+distinguish deployment instances of the same wasm from the same user (if
+omitted, one will be generated for you)
+
+
+
+
+
+
+
+
+ auth
+
+
+Array.<xdr.SorobanAuthorizationEntry>
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ an optional list
+outlining the tree of authorizations required for the call
@@ -3283,7 +3421,7 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
+ an optional source account
@@ -3332,7 +3470,8 @@ Returns:
- Create claimable balance operation
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
@@ -3340,29 +3479,6 @@ Returns:
-
-Example
-
- const asset = new Asset(
- 'USD',
- 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
-);
-const amount = '100.0000000';
-const claimants = [
- new Claimant(
- 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ',
- Claimant.predicateBeforeAbsoluteTime("4102444800000")
- )
-];
-
-const op = Operation.createClaimableBalance({
- asset,
- amount,
- claimants
-});
-
-
-
object
+any
@@ -3126,7 +3215,7 @@ Parameters:
Options object
+the set of parameters
@@ -3154,13 +3243,13 @@Parameters:
assetaddressAsset
+Address
@@ -3179,7 +3268,7 @@ Parameters:
The asset for the claimable balance.
+the contract uploader address
amountwasmHashstring
+Uint8Array
+|
+
+Buffer
@@ -3213,7 +3305,9 @@ Parameters:
Amount.
+the SHA-256 hash of the contract +WASM you're uploading (see hash and +Operation.uploadContractWasm)
claimantssaltArray.<Claimant>
+Uint8Array
+|
+
+Buffer
@@ -3237,6 +3334,8 @@ Parameters:
+ @@ -3247,7 +3346,46 @@
Parameters:
An array of Claimants
+an optional, 32-byte salt to +distinguish deployment instances of the same wasm from the same user (if +omitted, one will be generated for you)
+ +authArray.<xdr.SorobanAuthorizationEntry>
+
+
+
+ + + + + + +
an optional list +outlining the tree of authorizations required for the call
The source account for the operation. Defaults to the transaction's source account.
+an optional source account
Create claimable balance operation
+an Invoke Host Function operation +(xdr.InvokeHostFunctionOp)
Example
- -const asset = new Asset(
- 'USD',
- 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
-);
-const amount = '100.0000000';
-const claimants = [
- new Claimant(
- 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ',
- Claimant.predicateBeforeAbsoluteTime("4102444800000")
- )
-];
-
-const op = Operation.createClaimableBalance({
- asset,
- amount,
- claimants
-});Create an "end sponsoring future reserves" operation.
+Returns an operation that wraps a Stellar asset into a token contract.
Parameters:
object
+any
@@ -3954,7 +4083,7 @@ Parameters:
Options object
+the set of parameters
@@ -3980,6 +4109,81 @@Parameters:
assetAsset
+|
+
+string
+
+
+
+ the Stellar asset to wrap, either as an
+Asset object or in canonical form (SEP-11, code:issuer)
authArray.<xdr.SorobanAuthorizationEntry>
+
+
+
+ + + + + + +
an optional list +outlining the tree of authorizations required for the call
+ +sourceParameters:
The source account for the operation. Defaults to the transaction's source account.
+an optional source account
Returns:
-
@@ -4066,13 +4271,6 @@ xdr operation
+an Invoke Host Function operation +(xdr.InvokeHostFunctionOp)
Returns:
-
-
-
@@ -4080,15 +4278,14 @@ Example
- -const op = Operation.endSponsoringFutureReserves();Example
-(static) fromXDRObject(operation) → {Operation}
+(static) endSponsoringFutureReserves(opts) → {xdr.Operation}
-
@@ -4124,7 +4321,7 @@ Deconstructs the raw XDR operation object into the structured object that
-was used to create the operation (i.e. the opts parameter to most ops).
Create an "end sponsoring future reserves" operation.
(static) Source:
Parameters:
- operationopts
-xdr.Operation
+object
@@ -4185,7 +4382,70 @@ Parameters:
- An XDR Operation.
+ Options object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ source
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The source account for the operation. Defaults to the transaction's source account.
+
+
+
+
+
+
+
+
@@ -4218,33 +4478,50 @@ Returns:
-Operation
+xdr.Operation
+
+ xdr operation
+
+
-
-
-
-
+
+Example
+
+ const op = Operation.endSponsoringFutureReserves();
+
+
+
+
+
+
+
- (static) inflation(optsopt) → {xdr.InflationOp}
+ (static) extendFootprintTtl(opts) → {xdr.Operation}
- This operation generates the inflation.
+ Builds an operation to bump the expiration of a footprint (read and written
+ledger keys). Its only parameter is the number of ledgers to extend
+expiration for.
+The footprint itself is derived from the transaction (see
+TransactionBuilder's opts.sorobanData parameter, which is a
+xdr.SorobanTransactionData instance that contains fee data & resource
+usage as part of xdr.SorobanResources).
@@ -4280,7 +4557,7 @@ (static) in
Source:
Parameters:
Type
- Attributes
-
@@ -4339,21 +4614,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
- Options object
+ object holding operation parameters
@@ -4379,6 +4644,42 @@ Parameters:
+
+
+ extendTo
+
+
+number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ the number of ledgers past the LCL
+(last closed ledger) by which to extend the validity of the ledger keys in
+this transaction
+
+
+
+
+
+
sourceParameters:
- The optional source account.
+ an optional source account
@@ -4449,7 +4750,7 @@ Returns:
-xdr.InflationOp
+xdr.Operation
@@ -4457,7 +4758,8 @@ Returns:
- Inflation operation
+ a Bump Footprint Expiration operation
+(xdr.ExtendFootprintTTLOp)
@@ -4472,14 +4774,15 @@ Returns:
- (static) invokeHostFunction(opts) → {xdr.Operation}
+ (static) fromXDRObject(operation) → {Operation}
- Invokes a single smart contract function.
+ Deconstructs the raw XDR operation object into the structured object that
+was used to create the operation (i.e. the opts parameter to most ops).
@@ -4515,7 +4818,7 @@ (static)
Source:
Parameters:
- opts
-
-
-object
-
-
-
-
-
-
-
-
-
-
- options object
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- func
-
-
-xdr.HostFunction
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- host function to execute (with its
-wrapped parameters)
-
-
-
-
-
-
-
-
- auth
-
-
-Array.<xdr.SorobanAuthorizationEntry>
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- list outlining the
-tree of authorizations required for the call
-
-
-
-
-
-
-
-
- sourceoperation
-string
+xdr.Operation
-
-
- <optional>
-
-
-
-
-
-
-
- an optional source account
-
-
-
-
-
-
-
-
+ An XDR Operation.
@@ -4744,18 +4912,13 @@ Returns:
-xdr.Operation
+Operation
-
- an Invoke Host Function operation
-(xdr.InvokeHostFunctionOp)
-
-
@@ -4768,19 +4931,14 @@ Returns:
- (static) isValidAmount(value, allowZero) → {boolean}
+ (static) inflation(optsopt) → {xdr.InflationOp}
- Validates that a given amount is possible for a Stellar asset.
-Specifically, this means that the amount is well, a valid number, but also
-that it is within the int64 range and has no more than 7 decimal levels of
-precision.
-Note that while smart contracts allow larger amounts, this is oriented
-towards validating the standard Stellar operations.
+ This operation generates the inflation.
@@ -4816,7 +4974,7 @@ (static) Source:
Parameters:
Type
-
+ Attributes
- Default
+
Description
@@ -4862,60 +5020,97 @@ Parameters:
- valueopts
-string
+object
+
+
+ <optional>
+
+
+
-
-
+
+
- the amount to validate
+ Options object
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- allowZerosource
-boolean
+string
+
+
+ <optional>
+
-
-
- false
+
+
+
- optionally, whether or not zero is valid (default: no)
+ The optional source account.
+
+
+
+
+
+
+
+
@@ -4948,13 +5143,17 @@ Returns:
-boolean
+xdr.InflationOp
+
+ Inflation operation
+
+
@@ -4967,14 +5166,14 @@ Returns:
- (static) liquidityPoolDeposit(opts) → {xdr.Operation}
+ (static) invokeContractFunction(opts) → {xdr.Operation}
- Creates a liquidity pool deposit operation.
+ Returns an operation that invokes a contract function.
@@ -5010,7 +5209,7 @@ (static
Source:
(static
See:
@@ -5067,7 +5270,7 @@ Parameters:
-object
+any
@@ -5078,7 +5281,7 @@ Parameters:
- Options object
+ the set of parameters
@@ -5106,7 +5309,7 @@ Parameters:
- liquidityPoolIdcontract
@@ -5131,7 +5334,7 @@ Parameters:
- The liquidity pool ID.
+ a strkey-fied contract address (C...)
@@ -5140,7 +5343,7 @@ Parameters:
- maxAmountAfunction
@@ -5165,7 +5368,7 @@ Parameters:
- Maximum amount of first asset to deposit.
+ the name of the contract fn to invoke
@@ -5174,13 +5377,13 @@ Parameters:
- maxAmountBargs
-string
+Array.<xdr.ScVal>
@@ -5199,7 +5402,9 @@ Parameters:
- Maximum amount of second asset to deposit.
+ parameters to pass to the function
+invocation (try nativeToScVal or ScInt to make building
+these easier)
@@ -5208,22 +5413,13 @@ Parameters:
- minPriceauth
-number
-|
-
-string
-|
-
-BigNumber
-|
-
-Object
+Array.<xdr.SorobanAuthorizationEntry>
@@ -5232,6 +5428,8 @@ Parameters:
+ <optional>
+
@@ -5242,76 +5440,44 @@ Parameters:
- Minimum depositA/depositB price.
+ an optional list
+outlining the tree of authorizations required for the call
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- nsource
-number
+string
-
-
-
-
- If opts.minPrice is an object: the price numerator
+
-
-
-
-
-
-
-
- d
-
+ <optional>
-number
-
-
-
+
+
+
- If opts.minPrice is an object: the price denominator
+ an optional source account
@@ -5325,243 +5491,80 @@ Parameters:
+
+
-
-
- maxPrice
-
-
-number
-|
-string
-|
-BigNumber
-|
-Object
-
-
-
-
-
-
-
-
-
-
-
- Maximum depositA/depositB price.
-
-
-
-
-
-
- Name
-
- Type
+
+Returns:
+
+ -
+ Type:
+
+ -
+
xdr.Operation
- Description
-
-
-
-
+
+
-
-
- n
-
-
-number
+
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
+
+
+
-
-
-
+
+
+
-
- If opts.maxPrice is an object: the price numerator
-
-
-
+
+
+ (static) invokeHostFunction(opts) → {xdr.Operation}
-
-
- d
-
-
-number
+
+ Invokes a single smart contract host function.
+
-
-
-
-
-
- If opts.maxPrice is an object: the price denominator
-
-
-
+
+
-
-
-
-
-
+
-
-
- source
-
-
-string
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The source account for the operation. Defaults to the transaction's source account.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-operationoptsxdr.Operation
+object
@@ -4185,7 +4382,70 @@ Parameters:
An XDR Operation.
+Options object
+ + + +| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
source |
+
+
+
+
+
+string
+
+
+
+ |
+
+
+
+
+ <optional> + + + + + + |
+
+
+
+
+
+ The source account for the operation. Defaults to the transaction's source account. + + |
+
Operation
+xdr.Operation
xdr operation
+
+
+
+Example
+ +const op = Operation.endSponsoringFutureReserves();(static) inflation(optsopt) → {xdr.InflationOp}
+(static) extendFootprintTtl(opts) → {xdr.Operation}
-
@@ -4280,7 +4557,7 @@ This operation generates the inflation.
+Builds an operation to bump the expiration of a footprint (read and written +ledger keys). Its only parameter is the number of ledgers to extend +expiration for.
+The footprint itself is derived from the transaction (see
+TransactionBuilder's opts.sorobanData parameter, which is a
+xdr.SorobanTransactionData instance that contains fee data & resource
+usage as part of xdr.SorobanResources).
(static) in
Source:
Parameters:
Type
- Attributes
-
@@ -4339,21 +4614,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
- Options object
+ object holding operation parameters
@@ -4379,6 +4644,42 @@ Parameters:
+
+
+ extendTo
+
+
+number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ the number of ledgers past the LCL
+(last closed ledger) by which to extend the validity of the ledger keys in
+this transaction
+
+
+
+
+
+
sourceParameters:
- The optional source account.
+ an optional source account
@@ -4449,7 +4750,7 @@ Returns:
-xdr.InflationOp
+xdr.Operation
@@ -4457,7 +4758,8 @@ Returns:
- Inflation operation
+ a Bump Footprint Expiration operation
+(xdr.ExtendFootprintTTLOp)
@@ -4472,14 +4774,15 @@ Returns:
- (static) invokeHostFunction(opts) → {xdr.Operation}
+ (static) fromXDRObject(operation) → {Operation}
- Invokes a single smart contract function.
+ Deconstructs the raw XDR operation object into the structured object that
+was used to create the operation (i.e. the opts parameter to most ops).
@@ -4515,7 +4818,7 @@ (static)
Source:
Parameters:
- opts
-
-
-object
-
-
-
-
-
-
-
-
-
-
- options object
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- func
-
-
-xdr.HostFunction
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- host function to execute (with its
-wrapped parameters)
-
-
-
-
-
-
-
-
- auth
-
-
-Array.<xdr.SorobanAuthorizationEntry>
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- list outlining the
-tree of authorizations required for the call
-
-
-
-
-
-
-
-
- sourceoperation
-string
+xdr.Operation
-
-
- <optional>
-
-
-
-
-
-
-
- an optional source account
-
-
-
-
-
-
-
-
+ An XDR Operation.
@@ -4744,18 +4912,13 @@ Returns:
-xdr.Operation
+Operation
-
- an Invoke Host Function operation
-(xdr.InvokeHostFunctionOp)
-
-
@@ -4768,19 +4931,14 @@ Returns:
- (static) isValidAmount(value, allowZero) → {boolean}
+ (static) inflation(optsopt) → {xdr.InflationOp}
- Validates that a given amount is possible for a Stellar asset.
-Specifically, this means that the amount is well, a valid number, but also
-that it is within the int64 range and has no more than 7 decimal levels of
-precision.
-Note that while smart contracts allow larger amounts, this is oriented
-towards validating the standard Stellar operations.
+ This operation generates the inflation.
@@ -4816,7 +4974,7 @@ (static) Source:
Parameters:
Type
-
+ Attributes
- Default
+
Description
@@ -4862,60 +5020,97 @@ Parameters:
- valueopts
-string
+object
+
+
+ <optional>
+
+
+
-
-
+
+
- the amount to validate
+ Options object
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
- allowZerosource
-boolean
+string
+
+
+ <optional>
+
-
-
- false
+
+
+
- optionally, whether or not zero is valid (default: no)
+ The optional source account.
+
+
+
+
+
+
+
+
@@ -4948,13 +5143,17 @@ Returns:
-boolean
+xdr.InflationOp
+
+ Inflation operation
+
+
@@ -4967,14 +5166,14 @@ Returns:
- (static) liquidityPoolDeposit(opts) → {xdr.Operation}
+ (static) invokeContractFunction(opts) → {xdr.Operation}
- Creates a liquidity pool deposit operation.
+ Returns an operation that invokes a contract function.
@@ -5010,7 +5209,7 @@ (static
Source:
(static
See:
@@ -5067,7 +5270,7 @@ Parameters:
-object
+any
@@ -5078,7 +5281,7 @@ Parameters:
- Options object
+ the set of parameters
@@ -5106,7 +5309,7 @@ Parameters:
- liquidityPoolIdcontract
@@ -5131,7 +5334,7 @@ Parameters:
- The liquidity pool ID.
+ a strkey-fied contract address (C...)
@@ -5140,7 +5343,7 @@ Parameters:
- maxAmountAfunction
@@ -5165,7 +5368,7 @@ Parameters:
- Maximum amount of first asset to deposit.
+ the name of the contract fn to invoke
@@ -5174,13 +5377,13 @@ Parameters:
- maxAmountBargs
-string
+Array.<xdr.ScVal>
@@ -5199,7 +5402,9 @@ Parameters:
- Maximum amount of second asset to deposit.
+ parameters to pass to the function
+invocation (try nativeToScVal or ScInt to make building
+these easier)
@@ -5208,22 +5413,13 @@ Parameters:
- minPriceauth
-number
-|
-
-string
-|
-
-BigNumber
-|
-
-Object
+Array.<xdr.SorobanAuthorizationEntry>
@@ -5232,6 +5428,8 @@ Parameters:
+ <optional>
+
@@ -5242,76 +5440,44 @@ Parameters:
- Minimum depositA/depositB price.
+ an optional list
+outlining the tree of authorizations required for the call
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- nsource
-number
+string
-
-
-
-
- If opts.minPrice is an object: the price numerator
+
-
-
-
-
-
-
-
- d
-
+ <optional>
-number
-
-
-
+
+
+
- If opts.minPrice is an object: the price denominator
+ an optional source account
@@ -5325,243 +5491,80 @@ Parameters:
+
+
-
-
- maxPrice
-
-
-number
-|
-string
-|
-BigNumber
-|
-Object
-
-
-
-
-
-
-
-
-
-
-
- Maximum depositA/depositB price.
-
-
-
-
-
-
- Name
-
- Type
+
+Returns:
+
+ -
+ Type:
+
+ -
+
xdr.Operation
- Description
-
-
-
-
+
+
-
-
- n
-
-
-number
+
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
+
+
+
-
-
-
+
+
+
-
- If opts.maxPrice is an object: the price numerator
-
-
-
+
+
+ (static) invokeHostFunction(opts) → {xdr.Operation}
-
-
- d
-
-
-number
+
+ Invokes a single smart contract host function.
+
-
-
-
-
-
- If opts.maxPrice is an object: the price denominator
-
-
-
+
+
-
-
-
-
-
+
-
-
- source
-
-
-string
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The source account for the operation. Defaults to the transaction's source account.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- - - - - -
Options object
+object holding operation parameters
@@ -4379,6 +4644,42 @@Parameters:
extendTonumber
+
+
+
+ the number of ledgers past the LCL +(last closed ledger) by which to extend the validity of the ledger keys in +this transaction
+ +sourceParameters:
The optional source account.
+an optional source account
xdr.InflationOp
+xdr.Operation
Inflation operation
+a Bump Footprint Expiration operation +(xdr.ExtendFootprintTTLOp)
Invokes a single smart contract function.
+Deconstructs the raw XDR operation object into the structured object that
+was used to create the operation (i.e. the opts parameter to most ops).
Parameters:
optsobject
-
-
-
- options object
- - - -| Name | - - -Type | - - -Attributes | - - - - -Description | -|
|---|---|---|---|---|
func |
-
-
-
-
-
-xdr.HostFunction
-
-
-
- |
-
-
- - - - - - - | - - - - -
- host function to execute (with its -wrapped parameters) - - |
- |
auth |
-
-
-
-
-
-Array.<xdr.SorobanAuthorizationEntry>
-
-
-
- |
-
-
-
-
- <optional> - - - - - - |
-
-
-
-
-
- list outlining the -tree of authorizations required for the call - - |
- |
source |
+ operation |
-string
+xdr.Operation
|
-
-
- <optional> - - - - - - |
-
- an optional source account - - |
-
An XDR Operation.
Returns:
xdr.Operation
+Operation
-
-
@@ -4768,19 +4931,14 @@ an Invoke Host Function operation -(xdr.InvokeHostFunctionOp)
-Returns:
-(static) isValidAmount(value, allowZero) → {boolean}
+(static) inflation(optsopt) → {xdr.InflationOp}
-
@@ -4816,7 +4974,7 @@ Validates that a given amount is possible for a Stellar asset.
-Specifically, this means that the amount is well, a valid number, but also -that it is within the int64 range and has no more than 7 decimal levels of -precision.
-Note that while smart contracts allow larger amounts, this is oriented -towards validating the standard Stellar operations.
+This operation generates the inflation.
(static) Source:
Parameters:
Type
-
+ Attributes
- Default
+
Description
@@ -4862,60 +5020,97 @@ Parameters:
- valueopts
-string
+object
+
+
+ <optional>
+
+
+
-
-
+
+
- the amount to validate
+ Options object
-
-
+
+
+
valueoptsstring
+object
+ + + - -
the amount to validate
+Options object
-| Name | + + +Type | + +Attributes | + + + + +Description | +||
|---|---|---|---|---|---|
allowZero |
+ source |
-boolean
+string
|
+
+
+ <optional> + - - | - false + | + +
- optionally, whether or not zero is valid (default: no) +The optional source account. + + |
+
Returns:
boolean
+xdr.InflationOp
+
+
@@ -4967,14 +5166,14 @@ Inflation operation
+Returns:
-(static) liquidityPoolDeposit(opts) → {xdr.Operation}
+(static) invokeContractFunction(opts) → {xdr.Operation}
-
@@ -5010,7 +5209,7 @@ Creates a liquidity pool deposit operation.
+Returns an operation that invokes a contract function.
(static
Source:
(static
See:
@@ -5067,7 +5270,7 @@ Parameters:
-object
+any
@@ -5078,7 +5281,7 @@ Parameters:
- Options object
+ the set of parameters
@@ -5106,7 +5309,7 @@ Parameters:
- liquidityPoolIdcontract
@@ -5131,7 +5334,7 @@ Parameters:
- The liquidity pool ID.
+ a strkey-fied contract address (C...)
@@ -5140,7 +5343,7 @@ Parameters:
- maxAmountAfunction
@@ -5165,7 +5368,7 @@ Parameters:
- Maximum amount of first asset to deposit.
+ the name of the contract fn to invoke
@@ -5174,13 +5377,13 @@ Parameters:
- maxAmountBargs
-string
+Array.<xdr.ScVal>
@@ -5199,7 +5402,9 @@ Parameters:
- Maximum amount of second asset to deposit.
+ parameters to pass to the function
+invocation (try nativeToScVal or ScInt to make building
+these easier)
@@ -5208,22 +5413,13 @@ Parameters:
- minPriceauth
-number
-|
-
-string
-|
-
-BigNumber
-|
-
-Object
+Array.<xdr.SorobanAuthorizationEntry>
@@ -5232,6 +5428,8 @@ Parameters:
+ <optional>
+
@@ -5242,76 +5440,44 @@ Parameters:
- Minimum depositA/depositB price.
+ an optional list
+outlining the tree of authorizations required for the call
-
-
-
-
-
-
- Name
-
-
- Type
-
-
-
-
-
- Description
-
-
+
+
-
- nsource
-number
+string
-
-
-
-
- If opts.minPrice is an object: the price numerator
+
-
-
-
-
-
-
-
- d
-
+ <optional>
-number
-
-
-
+
+
+
- If opts.minPrice is an object: the price denominator
+ an optional source account
@@ -5325,243 +5491,80 @@ Parameters:
+
+
-
-
- maxPrice
-
-
-number
-|
-string
-|
-BigNumber
-|
-Object
-
-
-
-
-
-
-
-
-
-
-
- Maximum depositA/depositB price.
-
-
-
-
-
-
- Name
-
- Type
+
+Returns:
+
+ -
+ Type:
+
+ -
+
xdr.Operation
- Description
-
-
-
-
+
+
-
-
- n
-
-
-number
+
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
+
+
+
-
-
-
+
+
+
-
- If opts.maxPrice is an object: the price numerator
-
-
-
+
+
+ (static) invokeHostFunction(opts) → {xdr.Operation}
-
-
- d
-
-
-number
+
+ Invokes a single smart contract host function.
+
-
-
-
-
-
- If opts.maxPrice is an object: the price denominator
-
-
-
+
+
-
-
-
-
-
+
-
-
- source
-
-
-string
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The source account for the operation. Defaults to the transaction's source account.
-
-
-
-
-
-
Parameters:
object
+any
@@ -5078,7 +5281,7 @@ Parameters:
Options object
+the set of parameters
@@ -5106,7 +5309,7 @@Parameters:
liquidityPoolIdcontractParameters:
The liquidity pool ID.
+a strkey-fied contract address (C...)
Parameters:
maxAmountAfunctionParameters:
Maximum amount of first asset to deposit.
+the name of the contract fn to invoke
Parameters:
maxAmountBargsstring
+Array.<xdr.ScVal>
@@ -5199,7 +5402,9 @@ Parameters:
Maximum amount of second asset to deposit.
+parameters to pass to the function +invocation (try nativeToScVal or ScInt to make building +these easier)
Parameters:
minPriceauthnumber
-|
-
-string
-|
-
-BigNumber
-|
-
-Object
+Array.<xdr.SorobanAuthorizationEntry>
@@ -5232,6 +5428,8 @@ Parameters:
+ @@ -5242,76 +5440,44 @@
Parameters:
Minimum depositA/depositB price.
+an optional list +outlining the tree of authorizations required for the call
- - -| Name | - - -Type | - - - - - -Description | -||
|---|---|---|---|---|
n |
+ source |
-number
+string
|
-
-
-
-
- If | - | -
d |
-
-
-
-
+ <optional> - number
-
-
- |
+
+
+
- If an optional source account |
maxPricenumber
-|
-string
-|
-BigNumber
-|
-Object
-
- Maximum depositA/depositB price.
- - -| Name | - -Type | +Description | -
|---|---|---|
n |
-
-
-
-
-number
+
+
+
+
-
- an Invoke Host Function operation +(xdr.InvokeHostFunctionOp) + |
-
+
+
+
- If |
-
d |
-
-
-
-
-number
+
+
-
- Invokes a single smart contract host function. + |
-
-
-
- If |
-
sourcestring
-
-
-
- - - - - - -
The source account for the operation. Defaults to the transaction's source account.
- -
-
-
-
-
-Returns:
- - - --
-
- - Type: - -
-
-
-
xdr.Operation- - -
-
-
-
-
-The resulting operation (xdr.LiquidityPoolDepositOp).
-
-
-
-
-
+
+
+(static) liquidityPoolWithdraw(opts) → {xdr.Operation}
- - - - - -
-
-
-
-
-
-
-Creates a liquidity pool withdraw operation.
--
-
-
-
-
-
-
-
-
+
@@ -5582,7 +5585,7 @@
- Source:
- @@ -5592,7 +5595,17 @@
- See:
-
-
-
- https://developers.stellar.org/docs/start/list-of-operations/#liquidity-pool-withdraw +
- https://soroban.stellar.org/docs/fundamentals-and-concepts/invoking-contracts-with-transactions#function + +
- Operation.invokeContractFunction + +
- Operation.createCustomContract + +
- Operation.createStellarAssetContract + +
- Operation.uploadContractWasm + +
- Contract.call
@@ -5650,7 +5663,7 @@ - @@ -5983,6 +5937,8 @@
- + Type: + +
-
+
+
boolean+ + +
+ - Source: +
- + + + + + +
- See: +
- + + + + + +
- + Type: + +
-
+
+
xdr.Operation+ + +
+ - Source: +
- + + + + + +
- See: +
- + + + + + +
- + Type: + +
-
+
+
xdr.Operation+ + +
+ - Source: +
- + + + + + + + +
- + Type: + +
-
+
+
xdr.Operation+ + +
+ - Source: +
- + + + + + + + +
- @@ -8527,8 +9850,6 @@
- Source:
- @@ -8820,7 +10173,7 @@
- @@ -9086,7 +10439,7 @@
- Source:
- @@ -9324,69 +10712,35 @@
- @@ -9625,7 +10978,7 @@
- Source:
- @@ -9919,7 +11307,7 @@
- Source:
- @@ -10245,135 +11776,7 @@
- Source:
- +
- See: +
-
+
-
+
- +
+
@@ -10659,17 +12069,95 @@ - - Type: - -
-
-
-
xdr.Operation- - -
- - Source: -
- - + +
- See: -
-
-
-
-
- -
-
+ - + Type: + +
-
+
+
xdr.SetOptionsOp+ + +
+
(stati
(stati
Parameters:
- Options object
+ options object
@@ -5678,47 +5691,13 @@ Parameters:
- liquidityPoolId
-
-
-string
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The liquidity pool ID.
-
-
-
-
-
-
-
-
- amountfunc
-string
+xdr.HostFunction
@@ -5737,7 +5716,8 @@ Parameters:
- Amount of pool shares to withdraw.
+ host function to execute (with its
+wrapped parameters)
@@ -5746,13 +5726,13 @@ Parameters:
- minAmountAauth
-string
+Array.<xdr.SorobanAuthorizationEntry>
@@ -5761,39 +5741,7 @@ Parameters:
-
-
-
-
-
-
-
-
-
-
- Minimum amount of first asset to withdraw.
-
-
-
-
-
-
-
-
- minAmountB
-
-
-string
-
-
-
-
-
-
-
+ <optional>
@@ -5805,7 +5753,8 @@ Parameters:
- Minimum amount of second asset to withdraw.
+ list outlining the
+tree of authorizations required for the call
@@ -5841,7 +5790,7 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
+ an optional source account
@@ -5890,7 +5839,8 @@ Returns:
- The resulting operation (xdr.LiquidityPoolWithdrawOp).
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
@@ -5905,15 +5855,19 @@ Returns:
- (static) manageBuyOffer(opts) → {xdr.ManageBuyOfferOp}
+ (static) isValidAmount(value, allowZero) → {boolean}
- Returns a XDR ManageBuyOfferOp. A "manage buy offer" operation creates, updates, or
-deletes a buy offer.
+ Validates that a given amount is possible for a Stellar asset.
+Specifically, this means that the amount is well, a valid number, but also
+that it is within the int64 range and has no more than 7 decimal levels of
+precision.
+Note that while smart contracts allow larger amounts, this is oriented
+towards validating the standard Stellar operations.
@@ -5949,7 +5903,7 @@ (static) Source:
Parameters:
+ Default
+
Description
@@ -5993,13 +5949,13 @@ Parameters:
- optsvalue
-object
+string
@@ -6008,43 +5964,1174 @@ Parameters:
+
+
+
+
- Options object
+ the amount to validate
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+
+
-
- sellingallowZero
-Asset
+boolean
+
+
+
+
+
+
+
+
+
+
+ false
+
+
+
+
+
+ optionally, whether or not zero is valid (default: no)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (static) liquidityPoolDeposit(opts) → {xdr.Operation}
+
+
+
+
+
+
+ Creates a liquidity pool deposit operation.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ opts
+
+
+object
+
+
+
+
+
+
+
+
+
+
+ Options object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ liquidityPoolId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The liquidity pool ID.
+
+
+
+
+
+
+
+
+ maxAmountA
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Maximum amount of first asset to deposit.
+
+
+
+
+
+
+
+
+ maxAmountB
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Maximum amount of second asset to deposit.
+
+
+
+
+
+
+
+
+ minPrice
+
+
+number
+|
+
+string
+|
+
+BigNumber
+|
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Minimum depositA/depositB price.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ n
+
+
+number
+
+
+
+
+
+
+
+
+
+
+ If opts.minPrice is an object: the price numerator
+
+
+
+
+
+
+
+
+ d
+
+
+number
+
+
+
+
+
+
+
+
+
+
+ If opts.minPrice is an object: the price denominator
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ maxPrice
+
+
+number
+|
+
+string
+|
+
+BigNumber
+|
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Maximum depositA/depositB price.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ n
+
+
+number
+
+
+
+
+
+
+
+
+
+
+ If opts.maxPrice is an object: the price numerator
+
+
+
+
+
+
+
+
+ d
+
+
+number
+
+
+
+
+
+
+
+
+
+
+ If opts.maxPrice is an object: the price denominator
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ source
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The source account for the operation. Defaults to the transaction's source account.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+ The resulting operation (xdr.LiquidityPoolDepositOp).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (static) liquidityPoolWithdraw(opts) → {xdr.Operation}
+
+
+
+
+
+
+ Creates a liquidity pool withdraw operation.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ opts
+
+
+object
+
+
+
+
+
+
+
+
+
+
+ Options object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ liquidityPoolId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The liquidity pool ID.
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Amount of pool shares to withdraw.
+
+
+
+
+
+
+
+
+ minAmountA
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Minimum amount of first asset to withdraw.
+
+
+
+
+
+
+
+
+ minAmountB
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Minimum amount of second asset to withdraw.
+
+
+
+
+
+
+
+
+ source
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The source account for the operation. Defaults to the transaction's source account.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+ The resulting operation (xdr.LiquidityPoolWithdrawOp).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (static) manageBuyOffer(opts) → {xdr.ManageBuyOfferOp}
+
+
+
+
+
+
+ Returns a XDR ManageBuyOfferOp. A "manage buy offer" operation creates, updates, or
+deletes a buy offer.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ opts
+
+
+object
+
+
+
+
+
+
+
+
+
+
+ Options object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ selling
+
+
+Asset
@@ -8289,44 +9376,265 @@ Parameters:
asset
-
-
-Asset
+
+
+
+Asset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ asset to send
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ amount to send
+
+
+
+
+
+
+
+
+ source
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The source account for the payment.
+Defaults to the transaction's source account.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+ The resulting payment operation (xdr.PaymentOp)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (static) restoreFootprint(optsopt) → {xdr.Operation}
+
+
+
+
+
+
+ Builds a footprint restoration operation.
+It takes no parameters because the relevant footprint is derived from the
+transaction itself (see TransactionBuilder's opts.sorobanData
+parameter (or TransactionBuilder.setSorobanData /
+TransactionBuilder.setLedgerKeys), which is a
+xdr.SorobanTransactionData instance that contains fee data & resource
+usage as part of xdr.SorobanTransactionData).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
+ Parameters:
+
-
+
+
+
+
+ Name
+
-
-
-
+ Type
-
+
+ Attributes
+
-
- asset to send
-
-
-
+
+ Description
+
+
+
+
- amountopts
-string
+object
@@ -8335,6 +9643,8 @@ Parameters:
+ <optional>
+
@@ -8345,11 +9655,30 @@ Parameters:
- amount to send
+ an optional set of parameters
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
@@ -8381,8 +9710,7 @@ Parameters:
- The source account for the payment.
-Defaults to the transaction's source account.
+ an optional source account
@@ -8431,7 +9759,8 @@ Returns:
- The resulting payment operation (xdr.PaymentOp)
+ a Bump Footprint Expiration operation
+(xdr.RestoreFootprintOp)
@@ -8446,20 +9775,14 @@ Returns:
- (static) restoreFootprint(optsopt) → {xdr.Operation}
+ (static) revokeAccountSponsorship(opts) → {xdr.Operation}
- Builds a footprint restoration operation.
-It takes no parameters because the relevant footprint is derived from the
-transaction itself (see TransactionBuilder's opts.sorobanData
-parameter (or TransactionBuilder.setSorobanData /
-TransactionBuilder.setLedgerKeys), which is a
-xdr.SorobanTransactionData instance that contains fee data & resource
-usage as part of xdr.SorobanTransactionData).
+ Create a "revoke sponsorship" operation for an account.
@@ -8495,7 +9818,7 @@ (static) Source:
Parameters:
Type
- Attributes
-
@@ -8554,21 +9875,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
- an optional set of parameters
+ Options object
@@ -8594,6 +9905,40 @@ Parameters:
+
+
+ account
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The sponsored account ID.
+
+
+
+
+
+
sourceParameters:
- an optional source account
+ The source account for the operation. Defaults to the transaction's source account.
@@ -8672,8 +10017,7 @@ Returns:
- a Bump Footprint Expiration operation
-(xdr.RestoreFootprintOp)
+ xdr operation
@@ -8681,6 +10025,15 @@ Returns:
+
+Example
+
+ const op = Operation.revokeAccountSponsorship({
+ account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
+});
+
+
+
@@ -8688,14 +10041,14 @@ Returns:
- (static) revokeAccountSponsorship(opts) → {xdr.Operation}
+ (static) revokeClaimableBalanceSponsorship(opts) → {xdr.Operation}
- Create a "revoke sponsorship" operation for an account.
+ Create a "revoke sponsorship" operation for a claimable balance.
@@ -8731,7 +10084,7 @@ (st
Parameters:
- accountbalanceId
@@ -8845,7 +10198,7 @@ Parameters:
- The sponsored account ID.
+ The sponsored claimable balance ID.
@@ -8941,8 +10294,8 @@ Returns:
Example
- const op = Operation.revokeAccountSponsorship({
- account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
+ const op = Operation.revokeClaimableBalanceSponsorship({
+ balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
});
@@ -8954,14 +10307,14 @@ Example
- (static) revokeClaimableBalanceSponsorship(opts) → {xdr.Operation}
+ (static) revokeDataSponsorship(opts) → {xdr.Operation}
- Create a "revoke sponsorship" operation for a claimable balance.
+ Create a "revoke sponsorship" operation for a data entry.
@@ -8997,7 +10350,7 @@ Source:
Parameters:
- balanceIdaccount
@@ -9111,7 +10464,41 @@ Parameters:
- The sponsored claimable balance ID.
+ The account ID which owns the data entry.
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The name of the data entry
@@ -9207,8 +10594,9 @@ Returns:
Example
- const op = Operation.revokeClaimableBalanceSponsorship({
- balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
+ const op = Operation.revokeDataSponsorship({
+ account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
+ name: 'foo'
});
@@ -9220,14 +10608,14 @@ Example
- (static) revokeDataSponsorship(opts) → {xdr.Operation}
+ (static) revokeLiquidityPoolSponsorship(opts) → {xdr.Operation}
- Create a "revoke sponsorship" operation for a data entry.
+ Creates a "revoke sponsorship" operation for a liquidity pool.
@@ -9263,7 +10651,7 @@ (stati
Parameters:
- Options object
+ – Options object.
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- account
-
-
-string
-
-
-
-
-
-
-
-
+
+
+ Name
+
-
+ Type
-
-
-
+
+ Attributes
+
-
+
-
- The account ID which owns the data entry.
-
-
-
+ Description
+
+
+
- nameliquidityPoolId
@@ -9411,7 +10765,7 @@ Parameters:
- The name of the data entry
+ The sponsored liquidity pool ID in 'hex' string.
@@ -9496,7 +10850,7 @@ Returns:
- xdr operation
+ xdr Operation.
@@ -9507,9 +10861,8 @@ Returns:
Example
- const op = Operation.revokeDataSponsorship({
- account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
- name: 'foo'
+ const op = Operation.revokeLiquidityPoolSponsorship({
+ liquidityPoolId: 'dd7b1ab831c273310ddbec6f97870aa83c2fbd78ce22aded37ecbf4f3380fac7',
});
@@ -9521,14 +10874,14 @@ Example
- (static) revokeLiquidityPoolSponsorship(opts) → {xdr.Operation}
+ (static) revokeOfferSponsorship(opts) → {xdr.Operation}
- Creates a "revoke sponsorship" operation for a liquidity pool.
+ Create a "revoke sponsorship" operation for an offer.
@@ -9564,7 +10917,7 @@ Source:
Parameters:
- – Options object.
+ Options object
@@ -9653,7 +11006,7 @@ Parameters:
- liquidityPoolIdseller
@@ -9678,7 +11031,41 @@ Parameters:
- The sponsored liquidity pool ID in 'hex' string.
+ The account ID which created the offer.
+
+
+
+
+
+
+
+
+ offerId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The offer ID.
@@ -9763,7 +11150,7 @@ Returns:
- xdr Operation.
+ xdr operation
@@ -9774,8 +11161,9 @@ Returns:
Example
- const op = Operation.revokeLiquidityPoolSponsorship({
- liquidityPoolId: 'dd7b1ab831c273310ddbec6f97870aa83c2fbd78ce22aded37ecbf4f3380fac7',
+ const op = Operation.revokeOfferSponsorship({
+ seller: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
+ offerId: '1234'
});
@@ -9787,14 +11175,14 @@ Example
- (static) revokeOfferSponsorship(opts) → {xdr.Operation}
+ (static) revokeSignerSponsorship(opts) → {xdr.Operation}
- Create a "revoke sponsorship" operation for an offer.
+ Create a "revoke sponsorship" operation for a signer.
@@ -9830,7 +11218,7 @@ (stat
Parameters:
- selleraccount
@@ -9944,7 +11332,7 @@ Parameters:
- The account ID which created the offer.
+ The account ID where the signer sponsorship is being removed from.
@@ -9953,7 +11341,60 @@ Parameters:
- offerIdsigner
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The signer whose sponsorship is being removed.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ ed25519PublicKey
@@ -9968,6 +11409,8 @@ Parameters:
+ <optional>
+
@@ -9978,7 +11421,93 @@ Parameters:
- The offer ID.
+ The ed25519 public key of the signer.
+
+
+
+
+
+
+
+
+ sha256Hash
+
+
+Buffer
+|
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ sha256 hash (Buffer or hex string).
+
+
+
+
+
+
+
+
+ preAuthTx
+
+
+Buffer
+|
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Hash (Buffer or hex string) of transaction.
+
+
+
+
+
+
+
+
@@ -10074,10 +11603,12 @@ Returns:
Example
- const op = Operation.revokeOfferSponsorship({
- seller: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
- offerId: '1234'
-});
+ const op = Operation.revokeSignerSponsorship({
+ account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
+ signer: {
+ ed25519PublicKey: 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ'
+ }
+})
@@ -10088,14 +11619,14 @@ Example
- (static) revokeSignerSponsorship(opts) → {xdr.Operation}
+ (static) revokeTrustlineSponsorship(opts) → {xdr.Operation}
- Create a "revoke sponsorship" operation for a signer.
+ Create a "revoke sponsorship" operation for a trustline.
@@ -10131,7 +11662,7 @@ (sta
Parameters:
- The account ID where the signer sponsorship is being removed from.
-
-
-
-
-
-
-
-
- signer
-
-
-object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The signer whose sponsorship is being removed.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ed25519PublicKey
-
-
-string
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The ed25519 public key of the signer.
-
-
-
-
-
-
-
-
- sha256Hash
-
-
-Buffer
-|
-
-string
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- sha256 hash (Buffer or hex string).
+ The account ID which owns the trustline.
@@ -10382,16 +11785,16 @@ Parameters:
- preAuthTxasset
-Buffer
+Asset
|
-string
+LiquidityPoolId
@@ -10400,8 +11803,6 @@ Parameters:
- <optional>
-
@@ -10412,15 +11813,7 @@ Parameters:
- Hash (Buffer or hex string) of transaction.
-
-
-
-
-
-
-
-
+ The trustline asset.
@@ -10516,12 +11909,13 @@ Returns:
Example
- const op = Operation.revokeSignerSponsorship({
+ const op = Operation.revokeTrustlineSponsorship({
account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
- signer: {
- ed25519PublicKey: 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ'
- }
-})
+ asset: new StellarBase.LiquidityPoolId(
+ 'USDUSD',
+ 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
+ )
+});
@@ -10532,14 +11926,23 @@ Example
- (static) revokeTrustlineSponsorship(opts) → {xdr.Operation}
+ (static) setOptions(opts) → {xdr.SetOptionsOp}
- Create a "revoke sponsorship" operation for a trustline.
+ Returns an XDR SetOptionsOp. A "set options" operations set or clear account flags,
+set the account's inflation destination, and/or add new signers to the account.
+The flags used in opts.clearFlags and opts.setFlags can be the following:
+
+It's possible to set/clear multiple flags at once using logical or.
@@ -10575,13 +11978,20 @@ (
Parameters:
-
+
+
+
+
+
+ inflationDest
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Set this account ID as the account's inflation destination.
+
+
+
+
+
+
+
+
+ clearFlags
+
+
+number
+|
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Bitmap integer for which account flags to clear.
+
+
+
+
- accountsetFlags
+number
+|
+
string
@@ -10679,6 +12167,8 @@ Parameters:
+ <optional>
+
@@ -10689,7 +12179,7 @@ Parameters:
- The account ID which owns the trustline.
+ Bitmap integer for which account flags to set.
@@ -10698,16 +12188,16 @@ Parameters:
- assetmasterWeight
-Asset
+number
|
-LiquidityPoolId
+string
@@ -10716,6 +12206,8 @@ Parameters:
+ <optional>
+
@@ -10726,7 +12218,7 @@ Parameters:
- The trustline asset.
+ The master key weight.
@@ -10735,12 +12227,15 @@ Parameters:
- sourcelowThreshold
+number
+|
+
string
@@ -10762,187 +12257,94 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
-
-
-
-
-
-
-
-
+ The sum weight for the low threshold.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
-
-
-
-
- xdr operation
-
-
-
-
-
-
-
-Example
-
- const op = Operation.revokeTrustlineSponsorship({
- account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
- asset: new StellarBase.LiquidityPoolId(
- 'USDUSD',
- 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
- )
-});
-
-
-
-
-
+
+
+ medThreshold(static) setOptions(opts) → {xdr.SetOptionsOp}
-
-
-
-
-
-
- Returns an XDR SetOptionsOp. A "set options" operations set or clear account flags,
-set the account's inflation destination, and/or add new signers to the account.
-The flags used in opts.clearFlags and opts.setFlags can be the following:
-
-It's possible to set/clear multiple flags at once using logical or.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+number
+|
-
+string
-
-
+
+
-
+
+
+
+ <optional>
+
-
+
-
-
+
-
+
-
-
+ The sum weight for the medium threshold.
+
+
+
-
-
-
-
-
+
+
+ highThreshold
+
+
+number
+|
+string
- Parameters:
-
+
+
-
-
-
-
- Name
-
+
+
+
+ <optional>
+
- Type
+
-
+
+
+
-
+
- Description
-
-
+
+ The sum weight for the high threshold.
+
+
+
-
- optssigner
@@ -10955,11 +12357,22 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- Options object
+ Add or remove a signer from the account. The signer is
+deleted if the weight is 0. Only one of ed25519PublicKey, sha256Hash, preAuthTx should be defined.
@@ -10987,7 +12400,7 @@ Parameters:
- inflationDested25519PublicKey
@@ -11014,7 +12427,7 @@ Parameters:
- Set this account ID as the account's inflation destination.
+ The ed25519 public key of the signer.
@@ -11023,13 +12436,13 @@ Parameters:
- clearFlagssha256Hash
-number
+Buffer
|
string
@@ -11053,7 +12466,7 @@ Parameters:
- Bitmap integer for which account flags to clear.
+ sha256 hash (Buffer or hex string) of preimage that will unlock funds. Preimage should be used as signature of future transaction.
@@ -11062,13 +12475,13 @@ Parameters:
- setFlagspreAuthTx
-number
+Buffer
|
string
@@ -11092,7 +12505,7 @@ Parameters:
- Bitmap integer for which account flags to set.
+ Hash (Buffer or hex string) of transaction that will unlock funds.
@@ -11101,15 +12514,12 @@ Parameters:
- masterWeighted25519SignedPayload
-number
-|
-
string
@@ -11131,7 +12541,7 @@ Parameters:
- The master key weight.
+ Signed payload signer (ed25519 public key + raw payload) for atomic transaction signature disclosure.
@@ -11140,7 +12550,7 @@ Parameters:
- lowThresholdweight
@@ -11170,7 +12580,15 @@ Parameters:
- The sum weight for the low threshold.
+ The weight of the new signer (0 to delete or 1-255)
+
+
+
+
+
+
+
+
@@ -11179,15 +12597,12 @@ Parameters:
- medThresholdhomeDomain
-number
-|
-
string
@@ -11209,7 +12624,7 @@ Parameters:
- The sum weight for the medium threshold.
+ sets the home domain used for reverse federation lookup.
@@ -11218,15 +12633,12 @@ Parameters:
- highThresholdsource
-number
-|
-
string
@@ -11248,16 +12660,172 @@ Parameters:
- The sum weight for the high threshold.
+ The source account (defaults to transaction source).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+ XDR operation
+
+
+
+
+
+
+
+
Parameters:
Options object
+options object
@@ -5678,47 +5691,13 @@Parameters:
liquidityPoolIdstring
-
-
-
- The liquidity pool ID.
- -amountfuncstring
+xdr.HostFunction
@@ -5737,7 +5716,8 @@ Parameters:
Amount of pool shares to withdraw.
+host function to execute (with its +wrapped parameters)
Parameters:
minAmountAauthstring
+Array.<xdr.SorobanAuthorizationEntry>
@@ -5761,39 +5741,7 @@ Parameters:
Minimum amount of first asset to withdraw.
- -minAmountBstring
-
-
-
- @@ -5805,7 +5753,8 @@
Parameters:
Minimum amount of second asset to withdraw.
+list outlining the +tree of authorizations required for the call
Parameters:
The source account for the operation. Defaults to the transaction's source account.
+an optional source account
Returns:
-
@@ -5905,15 +5855,19 @@ The resulting operation (xdr.LiquidityPoolWithdrawOp).
+an Invoke Host Function operation +(xdr.InvokeHostFunctionOp)
Returns:
-(static) manageBuyOffer(opts) → {xdr.ManageBuyOfferOp}
+(static) isValidAmount(value, allowZero) → {boolean}
-
@@ -5949,7 +5903,7 @@ Returns a XDR ManageBuyOfferOp. A "manage buy offer" operation creates, updates, or -deletes a buy offer.
+Validates that a given amount is possible for a Stellar asset.
+Specifically, this means that the amount is well, a valid number, but also +that it is within the int64 range and has no more than 7 decimal levels of +precision.
+Note that while smart contracts allow larger amounts, this is oriented +towards validating the standard Stellar operations.
(static) Source:
Parameters:
+ Default
+
Description
@@ -5993,13 +5949,13 @@ Parameters:
- optsvalue
-object
+string
@@ -6008,43 +5964,1174 @@ Parameters:
+
+
+
+
- Options object
+ the amount to validate
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
+
+
-
- sellingallowZero
-Asset
+boolean
+
+
+
+
+
+
+
+
+
+
+ false
+
+
+
+
+
+ optionally, whether or not zero is valid (default: no)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (static) liquidityPoolDeposit(opts) → {xdr.Operation}
+
+
+
+
+
+
+ Creates a liquidity pool deposit operation.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ opts
+
+
+object
+
+
+
+
+
+
+
+
+
+
+ Options object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ liquidityPoolId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The liquidity pool ID.
+
+
+
+
+
+
+
+
+ maxAmountA
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Maximum amount of first asset to deposit.
+
+
+
+
+
+
+
+
+ maxAmountB
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Maximum amount of second asset to deposit.
+
+
+
+
+
+
+
+
+ minPrice
+
+
+number
+|
+
+string
+|
+
+BigNumber
+|
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Minimum depositA/depositB price.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ n
+
+
+number
+
+
+
+
+
+
+
+
+
+
+ If opts.minPrice is an object: the price numerator
+
+
+
+
+
+
+
+
+ d
+
+
+number
+
+
+
+
+
+
+
+
+
+
+ If opts.minPrice is an object: the price denominator
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ maxPrice
+
+
+number
+|
+
+string
+|
+
+BigNumber
+|
+
+Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Maximum depositA/depositB price.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ n
+
+
+number
+
+
+
+
+
+
+
+
+
+
+ If opts.maxPrice is an object: the price numerator
+
+
+
+
+
+
+
+
+ d
+
+
+number
+
+
+
+
+
+
+
+
+
+
+ If opts.maxPrice is an object: the price denominator
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ source
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The source account for the operation. Defaults to the transaction's source account.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+ The resulting operation (xdr.LiquidityPoolDepositOp).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (static) liquidityPoolWithdraw(opts) → {xdr.Operation}
+
+
+
+
+
+
+ Creates a liquidity pool withdraw operation.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ opts
+
+
+object
+
+
+
+
+
+
+
+
+
+
+ Options object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ liquidityPoolId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The liquidity pool ID.
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Amount of pool shares to withdraw.
+
+
+
+
+
+
+
+
+ minAmountA
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Minimum amount of first asset to withdraw.
+
+
+
+
+
+
+
+
+ minAmountB
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Minimum amount of second asset to withdraw.
+
+
+
+
+
+
+
+
+ source
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The source account for the operation. Defaults to the transaction's source account.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+ The resulting operation (xdr.LiquidityPoolWithdrawOp).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (static) manageBuyOffer(opts) → {xdr.ManageBuyOfferOp}
+
+
+
+
+
+
+ Returns a XDR ManageBuyOfferOp. A "manage buy offer" operation creates, updates, or
+deletes a buy offer.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Parameters:
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ opts
+
+
+object
+
+
+
+
+
+
+
+
+
+
+ Options object
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ selling
+
+
+Asset
@@ -8289,44 +9376,265 @@ Parameters:
asset
-
-
-Asset
+
+
+
+Asset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ asset to send
+
+
+
+
+
+
+
+
+ amount
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ amount to send
+
+
+
+
+
+
+
+
+ source
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ The source account for the payment.
+Defaults to the transaction's source account.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+ The resulting payment operation (xdr.PaymentOp)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ (static) restoreFootprint(optsopt) → {xdr.Operation}
+
+
+
+
+
+
+ Builds a footprint restoration operation.
+It takes no parameters because the relevant footprint is derived from the
+transaction itself (see TransactionBuilder's opts.sorobanData
+parameter (or TransactionBuilder.setSorobanData /
+TransactionBuilder.setLedgerKeys), which is a
+xdr.SorobanTransactionData instance that contains fee data & resource
+usage as part of xdr.SorobanTransactionData).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
+ Parameters:
+
-
+
+
+
+
+ Name
+
-
-
-
+ Type
-
+
+ Attributes
+
-
- asset to send
-
-
-
+
+ Description
+
+
+
+
- amountopts
-string
+object
@@ -8335,6 +9643,8 @@ Parameters:
+ <optional>
+
@@ -8345,11 +9655,30 @@ Parameters:
- amount to send
+ an optional set of parameters
-
-
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
@@ -8381,8 +9710,7 @@ Parameters:
- The source account for the payment.
-Defaults to the transaction's source account.
+ an optional source account
@@ -8431,7 +9759,8 @@ Returns:
- The resulting payment operation (xdr.PaymentOp)
+ a Bump Footprint Expiration operation
+(xdr.RestoreFootprintOp)
@@ -8446,20 +9775,14 @@ Returns:
- (static) restoreFootprint(optsopt) → {xdr.Operation}
+ (static) revokeAccountSponsorship(opts) → {xdr.Operation}
- Builds a footprint restoration operation.
-It takes no parameters because the relevant footprint is derived from the
-transaction itself (see TransactionBuilder's opts.sorobanData
-parameter (or TransactionBuilder.setSorobanData /
-TransactionBuilder.setLedgerKeys), which is a
-xdr.SorobanTransactionData instance that contains fee data & resource
-usage as part of xdr.SorobanTransactionData).
+ Create a "revoke sponsorship" operation for an account.
@@ -8495,7 +9818,7 @@ (static) Source:
Parameters:
Type
- Attributes
-
@@ -8554,21 +9875,11 @@ Parameters:
-
-
- <optional>
-
-
-
-
-
-
-
- an optional set of parameters
+ Options object
@@ -8594,6 +9905,40 @@ Parameters:
+
+
+ account
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The sponsored account ID.
+
+
+
+
+
+
sourceParameters:
- an optional source account
+ The source account for the operation. Defaults to the transaction's source account.
@@ -8672,8 +10017,7 @@ Returns:
- a Bump Footprint Expiration operation
-(xdr.RestoreFootprintOp)
+ xdr operation
@@ -8681,6 +10025,15 @@ Returns:
+
+Example
+
+ const op = Operation.revokeAccountSponsorship({
+ account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
+});
+
+
+
@@ -8688,14 +10041,14 @@ Returns:
- (static) revokeAccountSponsorship(opts) → {xdr.Operation}
+ (static) revokeClaimableBalanceSponsorship(opts) → {xdr.Operation}
- Create a "revoke sponsorship" operation for an account.
+ Create a "revoke sponsorship" operation for a claimable balance.
@@ -8731,7 +10084,7 @@ (st
Parameters:
- accountbalanceId
@@ -8845,7 +10198,7 @@ Parameters:
- The sponsored account ID.
+ The sponsored claimable balance ID.
@@ -8941,8 +10294,8 @@ Returns:
Example
- const op = Operation.revokeAccountSponsorship({
- account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
+ const op = Operation.revokeClaimableBalanceSponsorship({
+ balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
});
@@ -8954,14 +10307,14 @@ Example
- (static) revokeClaimableBalanceSponsorship(opts) → {xdr.Operation}
+ (static) revokeDataSponsorship(opts) → {xdr.Operation}
- Create a "revoke sponsorship" operation for a claimable balance.
+ Create a "revoke sponsorship" operation for a data entry.
@@ -8997,7 +10350,7 @@ Source:
Parameters:
- balanceIdaccount
@@ -9111,7 +10464,41 @@ Parameters:
- The sponsored claimable balance ID.
+ The account ID which owns the data entry.
+
+
+
+
+
+
+
+
+ name
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The name of the data entry
@@ -9207,8 +10594,9 @@ Returns:
Example
- const op = Operation.revokeClaimableBalanceSponsorship({
- balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
+ const op = Operation.revokeDataSponsorship({
+ account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
+ name: 'foo'
});
@@ -9220,14 +10608,14 @@ Example
- (static) revokeDataSponsorship(opts) → {xdr.Operation}
+ (static) revokeLiquidityPoolSponsorship(opts) → {xdr.Operation}
- Create a "revoke sponsorship" operation for a data entry.
+ Creates a "revoke sponsorship" operation for a liquidity pool.
@@ -9263,7 +10651,7 @@ (stati
Parameters:
- Options object
+ – Options object.
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- account
-
-
-string
-
-
-
-
-
-
-
-
+
+
+ Name
+
-
+ Type
-
-
-
+
+ Attributes
+
-
+
-
- The account ID which owns the data entry.
-
-
-
+ Description
+
+
+
- nameliquidityPoolId
@@ -9411,7 +10765,7 @@ Parameters:
- The name of the data entry
+ The sponsored liquidity pool ID in 'hex' string.
@@ -9496,7 +10850,7 @@ Returns:
- xdr operation
+ xdr Operation.
@@ -9507,9 +10861,8 @@ Returns:
Example
- const op = Operation.revokeDataSponsorship({
- account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
- name: 'foo'
+ const op = Operation.revokeLiquidityPoolSponsorship({
+ liquidityPoolId: 'dd7b1ab831c273310ddbec6f97870aa83c2fbd78ce22aded37ecbf4f3380fac7',
});
@@ -9521,14 +10874,14 @@ Example
- (static) revokeLiquidityPoolSponsorship(opts) → {xdr.Operation}
+ (static) revokeOfferSponsorship(opts) → {xdr.Operation}
- Creates a "revoke sponsorship" operation for a liquidity pool.
+ Create a "revoke sponsorship" operation for an offer.
@@ -9564,7 +10917,7 @@ Source:
Parameters:
- – Options object.
+ Options object
@@ -9653,7 +11006,7 @@ Parameters:
- liquidityPoolIdseller
@@ -9678,7 +11031,41 @@ Parameters:
- The sponsored liquidity pool ID in 'hex' string.
+ The account ID which created the offer.
+
+
+
+
+
+
+
+
+ offerId
+
+
+string
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The offer ID.
@@ -9763,7 +11150,7 @@ Returns:
- xdr Operation.
+ xdr operation
@@ -9774,8 +11161,9 @@ Returns:
Example
- const op = Operation.revokeLiquidityPoolSponsorship({
- liquidityPoolId: 'dd7b1ab831c273310ddbec6f97870aa83c2fbd78ce22aded37ecbf4f3380fac7',
+ const op = Operation.revokeOfferSponsorship({
+ seller: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
+ offerId: '1234'
});
@@ -9787,14 +11175,14 @@ Example
- (static) revokeOfferSponsorship(opts) → {xdr.Operation}
+ (static) revokeSignerSponsorship(opts) → {xdr.Operation}
- Create a "revoke sponsorship" operation for an offer.
+ Create a "revoke sponsorship" operation for a signer.
@@ -9830,7 +11218,7 @@ (stat
Parameters:
- selleraccount
@@ -9944,7 +11332,7 @@ Parameters:
- The account ID which created the offer.
+ The account ID where the signer sponsorship is being removed from.
@@ -9953,7 +11341,60 @@ Parameters:
- offerIdsigner
+
+
+object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The signer whose sponsorship is being removed.
+
+
+
+
+
+
+
+ Name
+
+
+ Type
+
+
+ Attributes
+
+
+
+
+ Description
+
+
+
+
+
+
+
+
+ ed25519PublicKey
@@ -9968,6 +11409,8 @@ Parameters:
+ <optional>
+
@@ -9978,7 +11421,93 @@ Parameters:
- The offer ID.
+ The ed25519 public key of the signer.
+
+
+
+
+
+
+
+
+ sha256Hash
+
+
+Buffer
+|
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ sha256 hash (Buffer or hex string).
+
+
+
+
+
+
+
+
+ preAuthTx
+
+
+Buffer
+|
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Hash (Buffer or hex string) of transaction.
+
+
+
+
+
+
+
+
@@ -10074,10 +11603,12 @@ Returns:
Example
- const op = Operation.revokeOfferSponsorship({
- seller: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
- offerId: '1234'
-});
+ const op = Operation.revokeSignerSponsorship({
+ account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
+ signer: {
+ ed25519PublicKey: 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ'
+ }
+})
@@ -10088,14 +11619,14 @@ Example
- (static) revokeSignerSponsorship(opts) → {xdr.Operation}
+ (static) revokeTrustlineSponsorship(opts) → {xdr.Operation}
- Create a "revoke sponsorship" operation for a signer.
+ Create a "revoke sponsorship" operation for a trustline.
@@ -10131,7 +11662,7 @@ (sta
Parameters:
- The account ID where the signer sponsorship is being removed from.
-
-
-
-
-
-
-
-
- signer
-
-
-object
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- The signer whose sponsorship is being removed.
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- ed25519PublicKey
-
-
-string
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- The ed25519 public key of the signer.
-
-
-
-
-
-
-
-
- sha256Hash
-
-
-Buffer
-|
-
-string
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- sha256 hash (Buffer or hex string).
+ The account ID which owns the trustline.
@@ -10382,16 +11785,16 @@ Parameters:
- preAuthTxasset
-Buffer
+Asset
|
-string
+LiquidityPoolId
@@ -10400,8 +11803,6 @@ Parameters:
- <optional>
-
@@ -10412,15 +11813,7 @@ Parameters:
- Hash (Buffer or hex string) of transaction.
-
-
-
-
-
-
-
-
+ The trustline asset.
@@ -10516,12 +11909,13 @@ Returns:
Example
- const op = Operation.revokeSignerSponsorship({
+ const op = Operation.revokeTrustlineSponsorship({
account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
- signer: {
- ed25519PublicKey: 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ'
- }
-})
+ asset: new StellarBase.LiquidityPoolId(
+ 'USDUSD',
+ 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
+ )
+});
@@ -10532,14 +11926,23 @@ Example
- (static) revokeTrustlineSponsorship(opts) → {xdr.Operation}
+ (static) setOptions(opts) → {xdr.SetOptionsOp}
- Create a "revoke sponsorship" operation for a trustline.
+ Returns an XDR SetOptionsOp. A "set options" operations set or clear account flags,
+set the account's inflation destination, and/or add new signers to the account.
+The flags used in opts.clearFlags and opts.setFlags can be the following:
+
+It's possible to set/clear multiple flags at once using logical or.
@@ -10575,13 +11978,20 @@ (
Parameters:
-
+
+
+
+
+
+ inflationDest
+
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Set this account ID as the account's inflation destination.
+
+
+
+
+
+
+
+
+ clearFlags
+
+
+number
+|
+
+string
+
+
+
+
+
+
+
+
+ <optional>
+
+
+
+
+
+
+
+
+
+
+
+ Bitmap integer for which account flags to clear.
+
+
+
+
- accountsetFlags
+number
+|
+
string
@@ -10679,6 +12167,8 @@ Parameters:
+ <optional>
+
@@ -10689,7 +12179,7 @@ Parameters:
- The account ID which owns the trustline.
+ Bitmap integer for which account flags to set.
@@ -10698,16 +12188,16 @@ Parameters:
- assetmasterWeight
-Asset
+number
|
-LiquidityPoolId
+string
@@ -10716,6 +12206,8 @@ Parameters:
+ <optional>
+
@@ -10726,7 +12218,7 @@ Parameters:
- The trustline asset.
+ The master key weight.
@@ -10735,12 +12227,15 @@ Parameters:
- sourcelowThreshold
+number
+|
+
string
@@ -10762,187 +12257,94 @@ Parameters:
- The source account for the operation. Defaults to the transaction's source account.
-
-
-
-
-
-
-
-
+ The sum weight for the low threshold.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Returns:
-
-
-
-
-
-
-
-
- xdr operation
-
-
-
-
-
-
-
-Example
-
- const op = Operation.revokeTrustlineSponsorship({
- account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
- asset: new StellarBase.LiquidityPoolId(
- 'USDUSD',
- 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
- )
-});
-
-
-
-
-
+
+
+ medThreshold(static) setOptions(opts) → {xdr.SetOptionsOp}
-
-
-
-
-
-
- Returns an XDR SetOptionsOp. A "set options" operations set or clear account flags,
-set the account's inflation destination, and/or add new signers to the account.
-The flags used in opts.clearFlags and opts.setFlags can be the following:
-
-It's possible to set/clear multiple flags at once using logical or.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+number
+|
-
+string
-
-
+
+
-
+
+
+
+ <optional>
+
-
+
-
-
+
-
+
-
-
+ The sum weight for the medium threshold.
+
+
+
-
-
-
-
-
+
+
+ highThreshold
+
+
+number
+|
+string
- Parameters:
-
+
+
-
-
-
-
- Name
-
+
+
+
+ <optional>
+
- Type
+
-
+
+
+
-
+
- Description
-
-
+
+ The sum weight for the high threshold.
+
+
+
-
- optssigner
@@ -10955,11 +12357,22 @@ Parameters:
+
+
+ <optional>
+
+
+
+
+
+
+
- Options object
+ Add or remove a signer from the account. The signer is
+deleted if the weight is 0. Only one of ed25519PublicKey, sha256Hash, preAuthTx should be defined.
@@ -10987,7 +12400,7 @@ Parameters:
- inflationDested25519PublicKey
@@ -11014,7 +12427,7 @@ Parameters:
- Set this account ID as the account's inflation destination.
+ The ed25519 public key of the signer.
@@ -11023,13 +12436,13 @@ Parameters:
- clearFlagssha256Hash
-number
+Buffer
|
string
@@ -11053,7 +12466,7 @@ Parameters:
- Bitmap integer for which account flags to clear.
+ sha256 hash (Buffer or hex string) of preimage that will unlock funds. Preimage should be used as signature of future transaction.
@@ -11062,13 +12475,13 @@ Parameters:
- setFlagspreAuthTx
-number
+Buffer
|
string
@@ -11092,7 +12505,7 @@ Parameters:
- Bitmap integer for which account flags to set.
+ Hash (Buffer or hex string) of transaction that will unlock funds.
@@ -11101,15 +12514,12 @@ Parameters:
- masterWeighted25519SignedPayload
-number
-|
-
string
@@ -11131,7 +12541,7 @@ Parameters:
- The master key weight.
+ Signed payload signer (ed25519 public key + raw payload) for atomic transaction signature disclosure.
@@ -11140,7 +12550,7 @@ Parameters:
- lowThresholdweight
@@ -11170,7 +12580,15 @@ Parameters:
- The sum weight for the low threshold.
+ The weight of the new signer (0 to delete or 1-255)
+
+
+
+
+
+
+
+
@@ -11179,15 +12597,12 @@ Parameters:
- medThresholdhomeDomain
-number
-|
-
string
@@ -11209,7 +12624,7 @@ Parameters:
- The sum weight for the medium threshold.
+ sets the home domain used for reverse federation lookup.
@@ -11218,15 +12633,12 @@ Parameters:
- highThresholdsource
-number
-|
-
string
@@ -11248,16 +12660,172 @@ Parameters:
- The sum weight for the high threshold.
+ The source account (defaults to transaction source).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+
+
+
+
+ XDR operation
+
+
+
+
+
+
+
+
optsvalueobject
+string
@@ -6008,43 +5964,1174 @@ Parameters:
+Options object
+the amount to validate
- - -| Name | - - -Type | - - -Attributes | - - - - -Description | -|
|---|---|---|---|---|
selling |
+ allowZero |
-Asset
+boolean
+
+
+
+ |
+
+
+
+
+ + + false + + | + + +
+ optionally, whether or not zero is valid (default: no) + + |
+
+
+
+
+
+
+
+
+Returns:
+ + + +-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(static) liquidityPoolDeposit(opts) → {xdr.Operation}
+ + + + + +
+
+
+
+
+
+
+Creates a liquidity pool deposit operation.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+
+
+
+
+ Options object + + + +
|
+
+
+
+
+
+Returns:
+ + + +-
+
+
+
+
+The resulting operation (xdr.LiquidityPoolDepositOp).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(static) liquidityPoolWithdraw(opts) → {xdr.Operation}
+ + + + + +
+
+
+
+
+
+
+Creates a liquidity pool withdraw operation.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+
+
+
+
+ Options object + + + +
|
+
+
+
+
+
+Returns:
+ + + +-
+
+
+
+
+The resulting operation (xdr.LiquidityPoolWithdrawOp).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+(static) manageBuyOffer(opts) → {xdr.ManageBuyOfferOp}
+ + + + + +
+
+
+
+
+
+
+Returns a XDR ManageBuyOfferOp. A "manage buy offer" operation creates, updates, or +deletes a buy offer.
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +|||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
+
+
+
+
+
+object
+
+
+
+ |
+
+
+
+
+
+
+ Options object + + + +
|
+
+
+
+
+
+Returns:
+ + + +-
+
+
+
+
+The resulting payment operation (xdr.PaymentOp)
+
+
+
+
+
(static) restoreFootprint(optsopt) → {xdr.Operation}
+ + + + + +
+
+
+
+
+
+
+Builds a footprint restoration operation.
+It takes no parameters because the relevant footprint is derived from the
+transaction itself (see TransactionBuilder's opts.sorobanData
+parameter (or TransactionBuilder.setSorobanData /
+TransactionBuilder.setLedgerKeys), which is a
+xdr.SorobanTransactionData instance that contains fee data & resource
+usage as part of xdr.SorobanTransactionData).
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parameters:
+ - +| Name | + - - - +Type | - + +Attributes | + -
- asset to send - - |
- Description | + + + +|||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
amount |
+ opts |
-string
+object
@@ -8335,6 +9643,8 @@ Parameters: |
+ <optional> + @@ -8345,11 +9655,30 @@ Parameters: |
- amount to send +an optional set of parameters - |
-
| Name | + + +Type | + + +Attributes | + + + + +Description | +|||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
- The source account for the payment. -Defaults to the transaction's source account. +an optional source account |
Type | -Attributes | - @@ -8554,21 +9875,11 @@
-
- <optional> - - - - - - |
-
- an optional set of parameters +Options object @@ -8594,6 +9905,40 @@Parameters: |
+ ||||||||||||||||
account |
+
+
+
+
+
+string
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ The sponsored account ID. + + |
+ |||||||||||||||||
source |
@@ -8623,7 +9968,7 @@
- an optional source account +The source account for the operation. Defaults to the transaction's source account. |
|||||||||||||||||||
account |
+ balanceId |
@@ -8845,7 +10198,7 @@ Parameters: |
- The sponsored account ID. +The sponsored claimable balance ID. |
|||||||||||||||||
balanceId |
+ account |
@@ -9111,7 +10464,41 @@ Parameters: |
- The sponsored claimable balance ID. +The account ID which owns the data entry. + + |
+ |||||||||||||||||
name |
+
+
+
+
+
+string
+
+
+
+ |
+
+
+ + + + + + + | + + + + +
+ The name of the data entry |
- Options object +– Options object.
The sum weight for the low threshold. |
-
-
-
-
-Returns:
- - - --
-
-
-
-
-xdr operation
-
-
-
-
-
+ Example
- -const op = Operation.revokeTrustlineSponsorship({
- account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
- asset: new StellarBase.LiquidityPoolId(
- 'USDUSD',
- 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
- )
-});medThreshold
-
-
-
-
(static) setOptions(opts) → {xdr.SetOptionsOp}
- - - - - -
-
-
-
-
-
-
-Returns an XDR SetOptionsOp. A "set options" operations set or clear account flags,
-set the account's inflation destination, and/or add new signers to the account.
-The flags used in opts.clearFlags and opts.setFlags can be the following:
It's possible to set/clear multiple flags at once using logical or.
--
-
-
-
-
-
-
-
-
-
-
-
-
-
+
number
+|
-
+string
-
-
+
+ + - + - -
The sum weight for the medium threshold.
+ +highThresholdnumber
+|
+string
- Parameters:
- + +| Name | - + +
+
+ <optional> + - | Type | + - + + + - + -Description | -
+ The sum weight for the high threshold. + + |
+
-
|---|---|---|---|---|
opts |
+ signer |
@@ -10955,11 +12357,22 @@ Parameters: |
+
+
+ <optional> + + + + + + |
+
- Options object +Add or remove a signer from the account. The signer is
+deleted if the weight is 0. Only one of Parameters: |
inflationDest |
+ ed25519PublicKey |
@@ -11014,7 +12427,7 @@ Parameters: |
- Set this account ID as the account's inflation destination. +The ed25519 public key of the signer. |
|
clearFlags |
+ sha256Hash |
-number
+Buffer
|
string
@@ -11053,7 +12466,7 @@ Parameters: |
- Bitmap integer for which account flags to clear. +sha256 hash (Buffer or hex string) of preimage that will unlock funds. Preimage should be used as signature of future transaction. |
|
setFlags |
+ preAuthTx |
-number
+Buffer
|
string
@@ -11092,7 +12505,7 @@ Parameters: |
- Bitmap integer for which account flags to set. +Hash (Buffer or hex string) of transaction that will unlock funds. |
|
masterWeight |
+ ed25519SignedPayload |
-number
-|
-
string
@@ -11131,7 +12541,7 @@ Parameters: |
- The master key weight. +Signed payload signer (ed25519 public key + raw payload) for atomic transaction signature disclosure. |
|
lowThreshold |
+ weight |
@@ -11170,7 +12580,15 @@ Parameters: |
- The sum weight for the low threshold. +The weight of the new signer (0 to delete or 1-255) + + |
+
Parameters:
medThresholdhomeDomainnumber
-|
-
string
@@ -11209,7 +12624,7 @@ Parameters:
The sum weight for the medium threshold.
+sets the home domain used for reverse federation lookup.
Parameters:
highThresholdsourcenumber
-|
-
string
@@ -11248,16 +12660,172 @@ Parameters:
The sum weight for the high threshold.
+The source account (defaults to transaction source).
+ +Returns:
+ + + +-
+
+
+
+
+XDR operation
+
+
+
+
+
+
+
+
+
-
+
-
-
-
+
+
+
+
+
+
@@ -11573,7 +13138,8 @@
-
@@ -11614,17 +13180,13 @@
-
-
@@ -11637,19 +13199,14 @@ (static) setTrustLineFlags(opts) → {xdr.SetTrustLineFlagsOp}
+ + + + + +
+
+
+
+
+
+
+Creates a trustline flag configuring operation.
+For the flags, set them to true to enable them and false to disable them. Any
+unmodified operations will be marked undefined in the result.
Note that you can only clear the clawbackEnabled flag set; it must be set +account-wide via operations.SetOptions (setting +xdr.AccountFlags.clawbackEnabled).
+-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
- Source: +
- + + + + + +
- See: +
- + + + + + +
Parameters:
+ + +| Name | + + +Type | + + + + + +Description | +||
|---|---|---|---|---|
signer |
+ opts |
@@ -11270,22 +12838,11 @@ Parameters: |
-
-
- <optional> - - - - - - |
-
- Add or remove a signer from the account. The signer is
-deleted if the weight is 0. Only one of Options object @@ -11313,7 +12870,7 @@Parameters: |
ed25519PublicKey |
+ trustor |
@@ -11328,8 +12885,6 @@ Parameters: |
- <optional> - @@ -11340,7 +12895,7 @@ Parameters: |
- The ed25519 public key of the signer. +the account whose trustline this is |
sha256Hash |
+ asset |
-Buffer
-|
-
-string
+Asset
@@ -11367,8 +12919,6 @@ Parameters: |
- <optional> - @@ -11379,7 +12929,7 @@ Parameters: |
- sha256 hash (Buffer or hex string) of preimage that will unlock funds. Preimage should be used as signature of future transaction. +the asset on the trustline |
preAuthTx |
+ flags |
-Buffer
-|
-
-string
+object
@@ -11406,8 +12953,6 @@ Parameters: |
- <optional> - @@ -11418,22 +12963,41 @@ Parameters: |
- Hash (Buffer or hex string) of transaction that will unlock funds. +the set of flags to modify - |
-
| Name | + + +Type | + + +Attributes | + + + + +Description | +
|---|---|---|---|
ed25519SignedPayload |
+ authorized |
-string
+bool
@@ -11454,7 +13018,8 @@ Parameters: |
- Signed payload signer (ed25519 public key + raw payload) for atomic transaction signature disclosure. +authorize account to perform +transactions with its credit |
weight |
+ authorizedToMaintainLiabilities |
-number
-|
-
-string
+bool
@@ -11493,15 +13055,8 @@ Parameters: |
- The weight of the new signer (0 to delete or 1-255) - - |
-
authorize +account to maintain and reduce liabilities for its credit
@@ -11510,13 +13065,13 @@Parameters:
homeDomainclawbackEnabledstring
+bool
@@ -11537,7 +13092,17 @@ Parameters:
sets the home domain used for reverse federation lookup.
+stop claimable balances on +this trustlines from having clawbacks enabled (this flag can only be set +to false!)
+ +Parameters:
The source account (defaults to transaction source).
+The source account for the operation. +Defaults to the transaction's source account.
Returns:
xdr.SetOptionsOp
+xdr.SetTrustLineFlagsOp
-
-
XDR operation
-Returns:
-(static) setTrustLineFlags(opts) → {xdr.SetTrustLineFlagsOp}
+(static) uploadContractWasm(opts) → {xdr.Operation}
-
@@ -11685,7 +13242,7 @@ Creates a trustline flag configuring operation.
-For the flags, set them to true to enable them and false to disable them. Any
-unmodified operations will be marked undefined in the result.
Note that you can only clear the clawbackEnabled flag set; it must be set -account-wide via operations.SetOptions (setting -xdr.AccountFlags.clawbackEnabled).
+Returns an operation that uploads WASM for a contract.
(static) <
Source:
(static) <
See:
@@ -11744,139 +13299,18 @@ Parameters:
-object
-
-
-
-
-
-
-
-
-
-
- Options object
-
-
-
-
-
-
-
- Name
-
-
- Type
-
-
- Attributes
-
-
-
-
- Description
-
-
-
-
-
-
-
-
- trustor
-
-
-string
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- the account whose trustline this is
-
-
-
-
-
-
-
-
- asset
-
-
-Asset
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- the asset on the trustline
-
-
-
-
-
-
-
-
- flags
-
-
-object
+any
-
-
-
-
-
-
-
-
- the set of flags to modify
+ the set of parameters
@@ -11904,50 +13338,16 @@ Parameters:
- authorizedwasm
-bool
-
-
-
-
-
-
-
-
- <optional>
-
-
-
-
-
-
-
-
-
-
-
- authorize account to perform
-transactions with its credit
-
-
-
-
-
-
-
-
- authorizedToMaintainLiabilitiesUint8Array
+|
-
-
-
-bool
+Buffer
@@ -11956,8 +13356,6 @@ Parameters:
- <optional>
-
@@ -11968,8 +13366,7 @@ Parameters:
- authorize
-account to maintain and reduce liabilities for its credit
+ a WASM blob to upload to the ledger
@@ -11978,13 +13375,13 @@ Parameters:
- clawbackEnabledauth
-bool
+Array.<xdr.SorobanAuthorizationEntry>
@@ -12005,17 +13402,8 @@ Parameters:
- stop claimable balances on
-this trustlines from having clawbacks enabled (this flag can only be set
-to false!)
-
-
-
-
-
-
-
-
+ an optional list
+outlining the tree of authorizations required for the call
@@ -12051,8 +13439,7 @@ Parameters:
- The source account for the operation.
-Defaults to the transaction's source account.
+ an optional source account
@@ -12093,13 +13480,18 @@ Returns:
-xdr.SetTrustLineFlagsOp
+xdr.Operation
+
+ an Invoke Host Function operation
+(xdr.InvokeHostFunctionOp)
+
+
Parameters:
object
-
-
-
- Options object
- - - -| Name | - - -Type | - - -Attributes | - - - - -Description | -|
|---|---|---|---|---|
trustor |
-
-
-
-
-
-string
-
-
-
- |
-
-
- - - - - - - | - - - - -
- the account whose trustline this is - - |
- |
asset |
-
-
-
-
-
-Asset
-
-
-
- |
-
-
- - - - - - - | - - - - -
- the asset on the trustline - - |
- |
flags |
-
-
-
-
-
-object
+any
|
- - - - - - - | -
- the set of flags to modify +the set of parameters @@ -11904,50 +13338,16 @@Parameters: | |
authorized |
+ wasm |
-bool
-
-
-
- |
-
-
-
-
- <optional> - - - - - - |
-
-
-
-
-
- authorize account to perform -transactions with its credit - - |
-
authorizedToMaintainLiabilities |
-
+
-
-
-bool
+Buffer
@@ -11956,8 +13356,6 @@ Parameters: |
- <optional> - @@ -11968,8 +13366,7 @@ Parameters: |
- authorize -account to maintain and reduce liabilities for its credit +a WASM blob to upload to the ledger |
|
clawbackEnabled |
+ auth |
-bool
+Array.<xdr.SorobanAuthorizationEntry>
@@ -12005,17 +13402,8 @@ Parameters: |
- stop claimable balances on -this trustlines from having clawbacks enabled (this flag can only be set -to false!) - - |
-
an optional list +outlining the tree of authorizations required for the call
Parameters:
The source account for the operation. -Defaults to the transaction's source account.
+an optional source account
Returns:
xdr.SetTrustLineFlagsOp
+xdr.Operation
+
+
an Invoke Host Function operation +(xdr.InvokeHostFunctionOp)
+Returns:
diff --git a/ScInt.html b/ScInt.html index d26e353..490bc5d 100644 --- a/ScInt.html +++ b/ScInt.html @@ -24,7 +24,7 @@
@@ -403,11 +403,11 @@
Throws:
Example
-import sdk from "stellar-base";
+ import { xdr, ScInt } from "@stellar/stellar-base";
// You have an ScVal from a contract and want to parse it into JS native.
-const value = sdk.xdr.ScVal.fromXDR(someXdr, "base64");
-const bigi = sdk.ScInt.fromScVal(value); // grab it as a BigInt
+const value = xdr.ScVal.fromXDR(someXdr, "base64");
+const bigi = ScInt.fromScVal(value); // grab it as a BigInt
let sci = new ScInt(bigi);
sci.toNumber(); // gives native JS type (w/ size check)
@@ -415,7 +415,7 @@ Example
sci.toU64(); // gives ScValType-specific XDR constructs (with size checks)
// You have a number and want to shove it into a contract.
-sci = sdk.ScInt(0xdeadcafebabe);
+sci = ScInt(0xdeadcafebabe);
sci.toBigInt() // returns 244838016400062n
sci.toNumber() // throws: too large
@@ -426,16 +426,16 @@ Example
const scValU64 = sci.toU64();
// Lots of ways to initialize:
-sdk.ScInt("123456789123456789")
-sdk.ScInt(123456789123456789n);
-sdk.ScInt(1n << 140n);
-sdk.ScInt(-42);
-sdk.ScInt.fromScVal(scValU128); // from above
+ScInt("123456789123456789")
+ScInt(123456789123456789n);
+ScInt(1n << 140n);
+ScInt(-42);
+ScInt.fromScVal(scValU128); // from above
// If you know the type ahead of time (accessing `.raw` is faster than
// conversions), you can specify the type directly (otherwise, it's
// interpreted from the numbers you pass in):
-const i = sdk.ScInt(123456789n, { type: "u256" });
+const i = ScInt(123456789n, { type: "u256" });
// For example, you can use the underlying `sdk.U256` and convert it to an
// `xdr.ScVal` directly like so:
@@ -486,7 +486,7 @@ Classes
diff --git a/Server.html b/Server.html
index e550ffe..4a32768 100644
--- a/Server.html
+++ b/Server.html
@@ -24,7 +24,7 @@
@@ -825,7 +825,7 @@ Example
const key = xdr.ScVal.scvSymbol("counter");
server.getContractData(contractId, key, Durability.Temporary).then(data => {
console.log("value:", data.val);
- console.log("expirationLedgerSeq:", data.expirationLedgerSeq);
+ console.log("liveUntilLedgerSeq:", data.liveUntilLedgerSeq);
console.log("lastModified:", data.lastModifiedLedgerSeq);
console.log("latestLedger:", data.latestLedger);
});
@@ -1009,7 +1009,7 @@ Returns:
Example
server.getEvents({
- startLedger: "1000",
+ startLedger: 1000,
filters: [
{
type: "contract",
@@ -1486,7 +1486,7 @@ Example
const ledgerData = response.entries[0];
console.log("key:", ledgerData.key);
console.log("value:", ledgerData.val);
- console.log("expirationLedgerSeq:", ledgerData.expirationLedgerSeq);
+ console.log("liveUntilLedgerSeq:", ledgerData.liveUntilLedgerSeq);
console.log("lastModified:", ledgerData.lastModifiedLedgerSeq);
console.log("latestLedger:", response.latestLedger);
});
@@ -1950,7 +1950,7 @@ Parameters:
the transaction to
prepare. It should include exactly one operation, which must be one of
-xdr.InvokeHostFunctionOp, xdr.BumpFootprintExpirationOp,
+xdr.InvokeHostFunctionOp, xdr.ExtendFootprintTTLOp,
or xdr.RestoreFootprintOp.
Any provided footprint will be overwritten. However, if your operation
has existing auth entries, they will be preferred over ALL auth entries
@@ -2710,7 +2710,7 @@
Parameters:
the transaction to
simulate, which should include exactly one operation (one of
-xdr.InvokeHostFunctionOp, xdr.BumpFootprintExpirationOp,
+xdr.InvokeHostFunctionOp, xdr.ExtendFootprintTTLOp,
or xdr.RestoreFootprintOp). Any provided footprint or auth
information will be ignored.
@@ -2809,7 +2809,7 @@ Example
diff --git a/SignerKey.html b/SignerKey.html
index 4e477dc..441d9c4 100644
--- a/SignerKey.html
+++ b/SignerKey.html
@@ -24,7 +24,7 @@
@@ -497,7 +497,7 @@ Returns:
diff --git a/SorobanDataBuilder.html b/SorobanDataBuilder.html
index 5ae714f..d7f9912 100644
--- a/SorobanDataBuilder.html
+++ b/SorobanDataBuilder.html
@@ -24,7 +24,7 @@
@@ -48,10 +48,9 @@
Supports building xdr.SorobanTransactionData structures with various
items set to specific values.
This is recommended for when you are building
-Operation.bumpFootprintExpiration /
-Operation.restoreFootprint operations and need to
-TransactionBuilder.setSorobanData to avoid (re)building the entire
-data structure from scratch.
+Operation.extendFootprintTtl / Operation.restoreFootprint
+operations and need to TransactionBuilder.setSorobanData to avoid
+(re)building the entire data structure from scratch.
@@ -105,7 +104,7 @@ new
Source:
append
Source:
buildSource:
getFootpr
Source:
getReadOnl
Source:
getReadWr
Source:
setFootpr
Source:
setReadOnl
Source:
setReadWr
Source:
Returns:
- setRefundableFee(fee) → {SorobanDataBuilder}
+ setResourceFee(fee) → {SorobanDataBuilder}
- Sets the "refundable" fee portion of the Soroban data.
+ Sets the resource fee portion of the Soroban data.
@@ -1429,7 +1428,7 @@ setRe
Source:
Parameters:
- the refundable fee to set (int64)
+ the resource fee to set (int64)
@@ -1593,7 +1592,7 @@ setResour
Source:
(static) from
Source:
Returns:
diff --git a/SorobanRpc.html b/SorobanRpc.html
index 2a465b4..41beac8 100644
--- a/SorobanRpc.html
+++ b/SorobanRpc.html
@@ -24,7 +24,7 @@
@@ -85,7 +85,7 @@
Source:
diff --git a/StrKey.html b/StrKey.html
index f097d7c..1803bbf 100644
--- a/StrKey.html
+++ b/StrKey.html
@@ -24,7 +24,7 @@
@@ -3145,7 +3145,7 @@ Returns:
diff --git a/Transaction.html b/Transaction.html
index cdb1040..84279f8 100644
--- a/Transaction.html
+++ b/Transaction.html
@@ -24,7 +24,7 @@
@@ -284,7 +284,7 @@ (readonly)
- array of extra signers (@{link StrKey}s)
+ array of extra signers (StrKeys)
@@ -320,7 +320,7 @@ (readonly) Source:
(readonly) memoSource:
(readonly)
Source:
(readon
Source:
(
Source:
(readonly)
Source:
(readonly) se
Source:
(readonly) sour
Source:
Returns:
diff --git a/TransactionBuilder.html b/TransactionBuilder.html
index 813c3df..34cbc30 100644
--- a/TransactionBuilder.html
+++ b/TransactionBuilder.html
@@ -24,7 +24,7 @@
@@ -3658,7 +3658,7 @@ Returns:
diff --git a/Uint128_Uint128.html b/Uint128_Uint128.html
index 6c02da9..ae79a1e 100644
--- a/Uint128_Uint128.html
+++ b/Uint128_Uint128.html
@@ -24,7 +24,7 @@
@@ -230,7 +230,7 @@ Parameters:
diff --git a/Uint256_Uint256.html b/Uint256_Uint256.html
index a080065..032ad7d 100644
--- a/Uint256_Uint256.html
+++ b/Uint256_Uint256.html
@@ -24,7 +24,7 @@
@@ -230,7 +230,7 @@ Parameters:
diff --git a/XdrLargeInt.html b/XdrLargeInt.html
index 8bdf62f..0c9febf 100644
--- a/XdrLargeInt.html
+++ b/XdrLargeInt.html
@@ -24,7 +24,7 @@
@@ -290,7 +290,7 @@ intSource:
type
-
-- one of i64, u64, i128, u128, i256, or u256
-
-
-
@@ -366,7 +360,7 @@ typeSource:
toBigIntSource:
toI128Source:
toI256Source:
toI64Source:
toNumberSource:
toScValSource:
toU128Source:
toU256Source:
toU64Source:
(static) getT
Source:
Returns:
diff --git a/global.html b/global.html
index 3515c06..564d99d 100644
--- a/global.html
+++ b/global.html
@@ -24,7 +24,7 @@
@@ -3327,6 +3327,110 @@ Returns:
+
+
+
+
+
+
+
+ getSalty() → {Buffer}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ - Source:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+Returns:
+
+
+
+
+ -
+ Type:
+
+ -
+
+
Buffer
+
+
+
+
+
+
+
+ a random 256-bit "salt" value.
+
+
+
+
+
+
+
@@ -4332,7 +4436,7 @@ par
Source:
Returns:
diff --git a/index.html b/index.html
index 560917c..69f32c2 100644
--- a/index.html
+++ b/index.html
@@ -24,7 +24,7 @@
@@ -59,16 +59,18 @@ js-soroban-client
-js-soroban-client is a Javascript library for communicating with a
-Soroban RPC server.
-It is used for building Stellar apps either on Node.js or in the browser.
-It provides:
+Deprecation Notice
+This repository has been deprecated in favor of the stellar-sdk package. Please read the migration guide for how to upgrade to that package. Future changes will only be made there.
+
+js-soroban-client is a JavaScript library for communicating with a
+Soroban RPC server and building Stellar apps. It provides:
- a networking layer API for soroban-rpc methods.
- facilities for building and signing transactions, for communicating with a
soroban-rpc instance, and for submitting transactions or querying network
state.
+
soroban-client vs stellar-base
soroban-client is a high-level library that serves as client-side API for Horizon.
stellar-base is lower-level
@@ -209,7 +211,8 @@
Publishing to npm
License
js-soroban-client is licensed under an Apache-2.0 license. See the
LICENSE file
-for details.
+for details.
+
@@ -222,7 +225,7 @@ License
diff --git a/js-stellar-base_src_account.js.html b/js-stellar-base_src_account.js.html
index 541a1c5..5a7026a 100644
--- a/js-stellar-base_src_account.js.html
+++ b/js-stellar-base_src_account.js.html
@@ -24,7 +24,7 @@
@@ -113,7 +113,7 @@ js-stellar-base/src/account.js
diff --git a/js-stellar-base_src_address.js.html b/js-stellar-base_src_address.js.html
index 1679720..358dd8f 100644
--- a/js-stellar-base_src_address.js.html
+++ b/js-stellar-base_src_address.js.html
@@ -24,7 +24,7 @@
@@ -189,7 +189,7 @@ js-stellar-base/src/address.js
diff --git a/js-stellar-base_src_asset.js.html b/js-stellar-base_src_asset.js.html
index b1f512f..155881c 100644
--- a/js-stellar-base_src_asset.js.html
+++ b/js-stellar-base_src_asset.js.html
@@ -24,7 +24,7 @@
@@ -345,7 +345,7 @@ js-stellar-base/src/asset.js
diff --git a/js-stellar-base_src_auth.js.html b/js-stellar-base_src_auth.js.html
index 74edba9..61bdd2c 100644
--- a/js-stellar-base_src_auth.js.html
+++ b/js-stellar-base_src_auth.js.html
@@ -24,7 +24,7 @@
@@ -285,7 +285,7 @@ js-stellar-base/src/auth.js
diff --git a/js-stellar-base_src_claimant.js.html b/js-stellar-base_src_claimant.js.html
index f06c14a..b233b6e 100644
--- a/js-stellar-base_src_claimant.js.html
+++ b/js-stellar-base_src_claimant.js.html
@@ -24,7 +24,7 @@
@@ -223,7 +223,7 @@ js-stellar-base/src/claimant.js
diff --git a/js-stellar-base_src_contract.js.html b/js-stellar-base_src_contract.js.html
index 085566a..bf1ff57 100644
--- a/js-stellar-base_src_contract.js.html
+++ b/js-stellar-base_src_contract.js.html
@@ -24,7 +24,7 @@
@@ -94,41 +94,36 @@ js-stellar-base/src/contract.js
*
* @returns {xdr.Operation} an InvokeHostFunctionOp operation to call the
* contract with the given method and parameters
+ *
+ * @see Operation.invokeHostFunction
+ * @see Operation.invokeContractFunction
+ * @see Operation.createCustomContract
+ * @see Operation.createStellarAssetContract
+ * @see Operation.uploadContractWasm
*/
call(method, ...params) {
- return Operation.invokeHostFunction({
- func: xdr.HostFunction.hostFunctionTypeInvokeContract(
- new xdr.InvokeContractArgs({
- contractAddress: this.address().toScAddress(),
- functionName: method,
- args: params
- })
- ),
- auth: []
+ return Operation.invokeContractFunction({
+ contract: this.address().toString(),
+ function: method,
+ args: params
});
}
/**
* Returns the read-only footprint entries necessary for any invocations to
- * this contract, for convenience when adding it to your transaction's overall
- * footprint or doing bump/restore operations.
+ * this contract, for convenience when manually adding it to your
+ * transaction's overall footprint or doing bump/restore operations.
*
- * @returns {xdr.LedgerKey[]} the ledger keys containing the contract's code
- * (first) and its deployed contract instance (second)
+ * @returns {xdr.LedgerKey} the ledger key for the deployed contract instance
*/
getFootprint() {
- return [
- xdr.LedgerKey.contractCode(
- new xdr.LedgerKeyContractCode({ hash: this._id })
- ),
- xdr.LedgerKey.contractData(
- new xdr.LedgerKeyContractData({
- contract: this.address().toScAddress(),
- key: xdr.ScVal.scvLedgerKeyContractInstance(),
- durability: xdr.ContractDataDurability.persistent()
- })
- )
- ];
+ return xdr.LedgerKey.contractData(
+ new xdr.LedgerKeyContractData({
+ contract: this.address().toScAddress(),
+ key: xdr.ScVal.scvLedgerKeyContractInstance(),
+ durability: xdr.ContractDataDurability.persistent()
+ })
+ );
}
}
@@ -143,7 +138,7 @@ js-stellar-base/src/contract.js
diff --git a/js-stellar-base_src_events.js.html b/js-stellar-base_src_events.js.html
index 6861cd8..09ccd76 100644
--- a/js-stellar-base_src_events.js.html
+++ b/js-stellar-base_src_events.js.html
@@ -24,7 +24,7 @@
@@ -95,7 +95,7 @@ js-stellar-base/src/events.js
diff --git a/js-stellar-base_src_fee_bump_transaction.js.html b/js-stellar-base_src_fee_bump_transaction.js.html
index c3070d7..b900709 100644
--- a/js-stellar-base_src_fee_bump_transaction.js.html
+++ b/js-stellar-base_src_fee_bump_transaction.js.html
@@ -24,7 +24,7 @@
@@ -166,7 +166,7 @@ js-stellar-base/src/fee_bump_transaction.js
diff --git a/js-stellar-base_src_get_liquidity_pool_id.js.html b/js-stellar-base_src_get_liquidity_pool_id.js.html
index 53a6832..3c0d0b4 100644
--- a/js-stellar-base_src_get_liquidity_pool_id.js.html
+++ b/js-stellar-base_src_get_liquidity_pool_id.js.html
@@ -24,7 +24,7 @@
@@ -105,7 +105,7 @@ js-stellar-base/src/get_liquidity_pool_id.js
diff --git a/js-stellar-base_src_invocation.js.html b/js-stellar-base_src_invocation.js.html
index 7fc3ae6..32b9303 100644
--- a/js-stellar-base_src_invocation.js.html
+++ b/js-stellar-base_src_invocation.js.html
@@ -24,7 +24,7 @@
@@ -176,7 +176,7 @@ js-stellar-base/src/invocation.js
break;
}
- // contractExecutableToken
+ // contractExecutableStellarAsset
case 1:
output.args.type = 'sac';
output.args.asset = Asset.fromOperation(
@@ -249,7 +249,7 @@ js-stellar-base/src/invocation.js
diff --git a/js-stellar-base_src_keypair.js.html b/js-stellar-base_src_keypair.js.html
index b8965e9..beac306 100644
--- a/js-stellar-base_src_keypair.js.html
+++ b/js-stellar-base_src_keypair.js.html
@@ -24,7 +24,7 @@
@@ -327,7 +327,7 @@ js-stellar-base/src/keypair.js
diff --git a/js-stellar-base_src_liquidity_pool_asset.js.html b/js-stellar-base_src_liquidity_pool_asset.js.html
index 9538c2b..4476c40 100644
--- a/js-stellar-base_src_liquidity_pool_asset.js.html
+++ b/js-stellar-base_src_liquidity_pool_asset.js.html
@@ -24,7 +24,7 @@
@@ -171,7 +171,7 @@ js-stellar-base/src/liquidity_pool_asset.js
diff --git a/js-stellar-base_src_liquidity_pool_id.js.html b/js-stellar-base_src_liquidity_pool_id.js.html
index 9e62eae..d0522af 100644
--- a/js-stellar-base_src_liquidity_pool_id.js.html
+++ b/js-stellar-base_src_liquidity_pool_id.js.html
@@ -24,7 +24,7 @@
@@ -128,7 +128,7 @@ js-stellar-base/src/liquidity_pool_id.js
diff --git a/js-stellar-base_src_memo.js.html b/js-stellar-base_src_memo.js.html
index a72e1c3..f0724ca 100644
--- a/js-stellar-base_src_memo.js.html
+++ b/js-stellar-base_src_memo.js.html
@@ -24,7 +24,7 @@
@@ -39,7 +39,7 @@ js-stellar-base/src/memo.js
-