Documentation GitHub npm

Source

js-stellar-base/src/operations/revoke_sponsorship.js

  1. import xdr from '../xdr';
  2. import { StrKey } from '../strkey';
  3. import { Keypair } from '../keypair';
  4. import { Asset } from '../asset';
  5. import { LiquidityPoolId } from '../liquidity_pool_id';
  7. /**
  8.  * Create a "revoke sponsorship" operation for an account.
  9.  *
  10.  * @function
  11.  * @alias Operation.revokeAccountSponsorship
  12.  * @param {object} opts Options object
  13.  * @param {string} opts.account - The sponsored account ID.
  14.  * @param {string} [opts.source] - The source account for the operation. Defaults to the transaction's source account.
  15.  * @returns {xdr.Operation} xdr operation
  16.  *
  17.  * @example
  18.  * const op = Operation.revokeAccountSponsorship({
  19.  *   account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
  20.  * });
  21.  *
  22.  */
  23. export function revokeAccountSponsorship(opts = {}) {
  24.   if (!StrKey.isValidEd25519PublicKey(opts.account)) {
  25.     throw new Error('account is invalid');
  26.   }
  28.   const ledgerKey = xdr.LedgerKey.account(
  29.     new xdr.LedgerKeyAccount({
  30.       accountId: Keypair.fromPublicKey(opts.account).xdrAccountId()
  31.     })
  32.   );
  33.   const op = xdr.RevokeSponsorshipOp.revokeSponsorshipLedgerEntry(ledgerKey);
  34.   const opAttributes = {};
  35.   opAttributes.body = xdr.OperationBody.revokeSponsorship(op);
  36.   this.setSourceAccount(opAttributes, opts);
  38.   return new xdr.Operation(opAttributes);
  39. }
  41. /**
  42.  * Create a "revoke sponsorship" operation for a trustline.
  43.  *
  44.  * @function
  45.  * @alias Operation.revokeTrustlineSponsorship
  46.  * @param {object} opts Options object
  47.  * @param {string} opts.account - The account ID which owns the trustline.
  48.  * @param {Asset | LiquidityPoolId} opts.asset - The trustline asset.
  49.  * @param {string} [opts.source] - The source account for the operation. Defaults to the transaction's source account.
  50.  * @returns {xdr.Operation} xdr operation
  51.  *
  52.  * @example
  53.  * const op = Operation.revokeTrustlineSponsorship({
  54.  *   account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
  55.  *   asset: new StellarBase.LiquidityPoolId(
  56.  *     'USDUSD',
  57.  *     'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7'
  58.  *   )
  59.  * });
  60.  *
  61.  */
  62. export function revokeTrustlineSponsorship(opts = {}) {
  63.   if (!StrKey.isValidEd25519PublicKey(opts.account)) {
  64.     throw new Error('account is invalid');
  65.   }
  67.   let asset;
  68.   if (opts.asset instanceof Asset) {
  69.     asset = opts.asset.toTrustLineXDRObject();
  70.   } else if (opts.asset instanceof LiquidityPoolId) {
  71.     asset = opts.asset.toXDRObject();
  72.   } else {
  73.     throw new TypeError('asset must be an Asset or LiquidityPoolId');
  74.   }
  76.   const ledgerKey = xdr.LedgerKey.trustline(
  77.     new xdr.LedgerKeyTrustLine({
  78.       accountId: Keypair.fromPublicKey(opts.account).xdrAccountId(),
  79.       asset
  80.     })
  81.   );
  82.   const op = xdr.RevokeSponsorshipOp.revokeSponsorshipLedgerEntry(ledgerKey);
  83.   const opAttributes = {};
  84.   opAttributes.body = xdr.OperationBody.revokeSponsorship(op);
  85.   this.setSourceAccount(opAttributes, opts);
  87.   return new xdr.Operation(opAttributes);
  88. }
  90. /**
  91.  * Create a "revoke sponsorship" operation for an offer.
  92.  *
  93.  * @function
  94.  * @alias Operation.revokeOfferSponsorship
  95.  * @param {object} opts Options object
  96.  * @param {string} opts.seller - The account ID which created the offer.
  97.  * @param {string} opts.offerId - The offer ID.
  98.  * @param {string} [opts.source] - The source account for the operation. Defaults to the transaction's source account.
  99.  * @returns {xdr.Operation} xdr operation
  100.  *
  101.  * @example
  102.  * const op = Operation.revokeOfferSponsorship({
  103.  *   seller: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
  104.  *   offerId: '1234'
  105.  * });
  106.  *
  107.  */
  108. export function revokeOfferSponsorship(opts = {}) {
  109.   if (!StrKey.isValidEd25519PublicKey(opts.seller)) {
  110.     throw new Error('seller is invalid');
  111.   }
  112.   if (typeof opts.offerId !== 'string') {
  113.     throw new Error('offerId is invalid');
  114.   }
  116.   const ledgerKey = xdr.LedgerKey.offer(
  117.     new xdr.LedgerKeyOffer({
  118.       sellerId: Keypair.fromPublicKey(opts.seller).xdrAccountId(),
  119.       offerId: xdr.Int64.fromString(opts.offerId)
  120.     })
  121.   );
  122.   const op = xdr.RevokeSponsorshipOp.revokeSponsorshipLedgerEntry(ledgerKey);
  123.   const opAttributes = {};
  124.   opAttributes.body = xdr.OperationBody.revokeSponsorship(op);
  125.   this.setSourceAccount(opAttributes, opts);
  127.   return new xdr.Operation(opAttributes);
  128. }
  130. /**
  131.  * Create a "revoke sponsorship" operation for a data entry.
  132.  *
  133.  * @function
  134.  * @alias Operation.revokeDataSponsorship
  135.  * @param {object} opts Options object
  136.  * @param {string} opts.account - The account ID which owns the data entry.
  137.  * @param {string} opts.name - The name of the data entry
  138.  * @param {string} [opts.source] - The source account for the operation. Defaults to the transaction's source account.
  139.  * @returns {xdr.Operation} xdr operation
  140.  *
  141.  * @example
  142.  * const op = Operation.revokeDataSponsorship({
  143.  *   account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
  144.  *   name: 'foo'
  145.  * });
  146.  *
  147.  */
  148. export function revokeDataSponsorship(opts = {}) {
  149.   if (!StrKey.isValidEd25519PublicKey(opts.account)) {
  150.     throw new Error('account is invalid');
  151.   }
  152.   if (typeof opts.name !== 'string' || opts.name.length > 64) {
  153.     throw new Error('name must be a string, up to 64 characters');
  154.   }
  156.   const ledgerKey = xdr.LedgerKey.data(
  157.     new xdr.LedgerKeyData({
  158.       accountId: Keypair.fromPublicKey(opts.account).xdrAccountId(),
  159.       dataName: opts.name
  160.     })
  161.   );
  162.   const op = xdr.RevokeSponsorshipOp.revokeSponsorshipLedgerEntry(ledgerKey);
  163.   const opAttributes = {};
  164.   opAttributes.body = xdr.OperationBody.revokeSponsorship(op);
  165.   this.setSourceAccount(opAttributes, opts);
  167.   return new xdr.Operation(opAttributes);
  168. }
  170. /**
  171.  * Create a "revoke sponsorship" operation for a claimable balance.
  172.  *
  173.  * @function
  174.  * @alias Operation.revokeClaimableBalanceSponsorship
  175.  * @param {object} opts Options object
  176.  * @param {string} opts.balanceId - The sponsored claimable balance ID.
  177.  * @param {string} [opts.source] - The source account for the operation. Defaults to the transaction's source account.
  178.  * @returns {xdr.Operation} xdr operation
  179.  *
  180.  * @example
  181.  * const op = Operation.revokeClaimableBalanceSponsorship({
  182.  *   balanceId: '00000000da0d57da7d4850e7fc10d2a9d0ebc731f7afb40574c03395b17d49149b91f5be',
  183.  * });
  184.  *
  185.  */
  186. export function revokeClaimableBalanceSponsorship(opts = {}) {
  187.   if (typeof opts.balanceId !== 'string') {
  188.     throw new Error('balanceId is invalid');
  189.   }
  191.   const ledgerKey = xdr.LedgerKey.claimableBalance(
  192.     new xdr.LedgerKeyClaimableBalance({
  193.       balanceId: xdr.ClaimableBalanceId.fromXDR(opts.balanceId, 'hex')
  194.     })
  195.   );
  196.   const op = xdr.RevokeSponsorshipOp.revokeSponsorshipLedgerEntry(ledgerKey);
  197.   const opAttributes = {};
  198.   opAttributes.body = xdr.OperationBody.revokeSponsorship(op);
  199.   this.setSourceAccount(opAttributes, opts);
  201.   return new xdr.Operation(opAttributes);
  202. }
  204. /**
  205.  * Creates a "revoke sponsorship" operation for a liquidity pool.
  206.  *
  207.  * @function
  208.  * @alias Operation.revokeLiquidityPoolSponsorship
  209.  * @param {object} opts – Options object.
  210.  * @param {string} opts.liquidityPoolId - The sponsored liquidity pool ID in 'hex' string.
  211.  * @param {string} [opts.source] - The source account for the operation. Defaults to the transaction's source account.
  212.  * @returns {xdr.Operation} xdr Operation.
  213.  *
  214.  * @example
  215.  * const op = Operation.revokeLiquidityPoolSponsorship({
  216.  *   liquidityPoolId: 'dd7b1ab831c273310ddbec6f97870aa83c2fbd78ce22aded37ecbf4f3380fac7',
  217.  * });
  218.  *
  219.  */
  220. export function revokeLiquidityPoolSponsorship(opts = {}) {
  221.   if (typeof opts.liquidityPoolId !== 'string') {
  222.     throw new Error('liquidityPoolId is invalid');
  223.   }
  225.   const ledgerKey = xdr.LedgerKey.liquidityPool(
  226.     new xdr.LedgerKeyLiquidityPool({
  227.       liquidityPoolId: xdr.PoolId.fromXDR(opts.liquidityPoolId, 'hex')
  228.     })
  229.   );
  231.   const op = xdr.RevokeSponsorshipOp.revokeSponsorshipLedgerEntry(ledgerKey);
  232.   const opAttributes = {
  233.     body: xdr.OperationBody.revokeSponsorship(op)
  234.   };
  235.   this.setSourceAccount(opAttributes, opts);
  237.   return new xdr.Operation(opAttributes);
  238. }
  240. /**
  241.  * Create a "revoke sponsorship" operation for a signer.
  242.  *
  243.  * @function
  244.  * @alias Operation.revokeSignerSponsorship
  245.  * @param {object} opts Options object
  246.  * @param {string} opts.account - The account ID where the signer sponsorship is being removed from.
  247.  * @param {object} opts.signer - The signer whose sponsorship is being removed.
  248.  * @param {string} [opts.signer.ed25519PublicKey] - The ed25519 public key of the signer.
  249.  * @param {Buffer|string} [opts.signer.sha256Hash] - sha256 hash (Buffer or hex string).
  250.  * @param {Buffer|string} [opts.signer.preAuthTx] - Hash (Buffer or hex string) of transaction.
  251.  * @param {string} [opts.source] - The source account for the operation. Defaults to the transaction's source account.
  252.  * @returns {xdr.Operation} xdr operation
  253.  *
  254.  * @example
  255.  * const op = Operation.revokeSignerSponsorship({
  256.  *   account: 'GDGU5OAPHNPU5UCLE5RDJHG7PXZFQYWKCFOEXSXNMR6KRQRI5T6XXCD7
  257.  *   signer: {
  258.  *     ed25519PublicKey: 'GCEZWKCA5VLDNRLN3RPRJMRZOX3Z6G5CHCGSNFHEYVXM3XOJMDS674JZ'
  259.  *   }
  260.  * })
  261.  *
  262.  */
  263. export function revokeSignerSponsorship(opts = {}) {
  264.   if (!StrKey.isValidEd25519PublicKey(opts.account)) {
  265.     throw new Error('account is invalid');
  266.   }
  267.   let key;
  268.   if (opts.signer.ed25519PublicKey) {
  269.     if (!StrKey.isValidEd25519PublicKey(opts.signer.ed25519PublicKey)) {
  270.       throw new Error('signer.ed25519PublicKey is invalid.');
  271.     }
  272.     const rawKey = StrKey.decodeEd25519PublicKey(opts.signer.ed25519PublicKey);
  274.     key = new xdr.SignerKey.signerKeyTypeEd25519(rawKey);
  275.   } else if (opts.signer.preAuthTx) {
  276.     let buffer;
  277.     if (typeof opts.signer.preAuthTx === 'string') {
  278.       buffer = Buffer.from(opts.signer.preAuthTx, 'hex');
  279.     } else {
  280.       buffer = opts.signer.preAuthTx;
  281.     }
  283.     if (!(Buffer.isBuffer(buffer) && buffer.length === 32)) {
  284.       throw new Error('signer.preAuthTx must be 32 bytes Buffer.');
  285.     }
  287.     key = new xdr.SignerKey.signerKeyTypePreAuthTx(buffer);
  288.   } else if (opts.signer.sha256Hash) {
  289.     let buffer;
  290.     if (typeof opts.signer.sha256Hash === 'string') {
  291.       buffer = Buffer.from(opts.signer.sha256Hash, 'hex');
  292.     } else {
  293.       buffer = opts.signer.sha256Hash;
  294.     }
  296.     if (!(Buffer.isBuffer(buffer) && buffer.length === 32)) {
  297.       throw new Error('signer.sha256Hash must be 32 bytes Buffer.');
  298.     }
  300.     key = new xdr.SignerKey.signerKeyTypeHashX(buffer);
  301.   } else {
  302.     throw new Error('signer is invalid');
  303.   }
  305.   const signer = new xdr.RevokeSponsorshipOpSigner({
  306.     accountId: Keypair.fromPublicKey(opts.account).xdrAccountId(),
  307.     signerKey: key
  308.   });
  310.   const op = xdr.RevokeSponsorshipOp.revokeSponsorshipSigner(signer);
  311.   const opAttributes = {};
  312.   opAttributes.body = xdr.OperationBody.revokeSponsorship(op);
  313.   this.setSourceAccount(opAttributes, opts);
  315.   return new xdr.Operation(opAttributes);
  316. }