@argonprotocol/mainchain 1.4.3-dev.cd7db477 → 1.4.3-dev.e162cc56

package/lib/index.d.cts

@@ -12891,7 +12891,11 @@ declare class TxResult {
     private parseEvents;
 }
 
-type ISubmittableOptions = Partial<SignerOptions> & {
+type TxSigningAccount = KeyringPair | {
+    address: string;
+    signer: NonNullable<SignerOptions['signer']>;
+};
+type ISubmittableOptions = Partial<Omit<SignerOptions, 'signer'>> & {
     tip?: bigint;
     logResults?: boolean;
     useLatestNonce?: boolean;
@@ -12901,8 +12905,9 @@ type ISubmittableOptions = Partial<SignerOptions> & {
 declare class TxSubmitter {
     readonly client: ArgonClient;
     tx: SubmittableExtrinsic$1;
-    pair: KeyringPair;
-    constructor(client: ArgonClient, tx: SubmittableExtrinsic$1, pair: KeyringPair);
+    readonly account: TxSigningAccount;
+    readonly address: string;
+    constructor(client: ArgonClient, tx: SubmittableExtrinsic$1, account: TxSigningAccount);
     feeEstimate(tip?: bigint): Promise<bigint>;
     canAfford(options?: {
         tip?: bigint;
@@ -12913,6 +12918,8 @@ declare class TxSubmitter {
         availableBalance: bigint;
         txFee: bigint;
     }>;
+    sign(options?: ISubmittableOptions): Promise<SubmittableExtrinsic$1>;
+    submitSigned(signedTx: SubmittableExtrinsic$1, options?: ISubmittableOptions): Promise<TxResult>;
     submit(options?: ISubmittableOptions): Promise<TxResult>;
     private logRequest;
 }
@@ -12978,7 +12985,7 @@ declare class Vault {
     activatedSecuritizationPerSlot(): bigint;
     calculateBitcoinFee(amount: bigint): bigint;
     static get(client: ArgonClient | ApiDecoration<'promise'>, vaultId: number, tickDurationMillis?: number): Promise<Vault>;
-    static create(client: ArgonClient, keypair: KeyringPair, args: {
+    static create(client: ArgonClient, txSigner: TxSigningAccount, args: {
         securitization: bigint | number;
         securitizationRatio: number;
         annualPercentRate: number;
@@ -12993,7 +13000,7 @@ declare class Vault {
         getVault(): Promise<Vault>;
         txResult: TxResult;
     }>;
-    static setName(client: ArgonClient, keypair: KeyringPair, args: {
+    static setName(client: ArgonClient, txSigner: TxSigningAccount, args: {
         name?: string | null;
     } & ISubmittableOptions): Promise<TxResult>;
 }
@@ -13075,7 +13082,7 @@ declare class BitcoinLock implements IBitcoinLock {
     ratchet(args: {
         client: ArgonClient;
         priceIndex: PriceIndex;
-        argonKeyring: KeyringPair;
+        txSigner: TxSigningAccount;
         vault: Vault;
         microgonsPerBtc?: bigint;
     } & ISubmittableOptions): Promise<{
@@ -13096,7 +13103,7 @@ declare class BitcoinLock implements IBitcoinLock {
         client: ArgonClient;
         priceIndex: PriceIndex;
         releaseRequest: IReleaseRequest;
-        argonKeyring: KeyringPair;
+        txSigner: TxSigningAccount;
     } & ISubmittableOptions): Promise<TxResult>;
     getReleaseRequest(client: IQueryableClient): Promise<IReleaseRequestDetails | undefined>;
     /**
@@ -13122,7 +13129,7 @@ declare class BitcoinLock implements IBitcoinLock {
         client: ArgonClient;
         utxoId: number;
         vaultSignature: Uint8Array;
-        argonKeyring: KeyringPair;
+        txSigner: TxSigningAccount;
     } & ISubmittableOptions): Promise<TxResult>;
     static createIncreaseSecuritizationTx(args: {
         utxoId: number;
@@ -13153,7 +13160,7 @@ declare class BitcoinLock implements IBitcoinLock {
         priceIndex: PriceIndex;
         ownerBitcoinPubkey: Uint8Array;
         satoshis: bigint;
-        argonKeyring: KeyringPair;
+        txSigner: TxSigningAccount;
         reducedBalanceBy?: bigint;
         microgonsPerBtc?: bigint;
         tip?: bigint;
@@ -13171,7 +13178,7 @@ declare class BitcoinLock implements IBitcoinLock {
         vault: Vault;
         priceIndex: PriceIndex;
         ownerBitcoinPubkey: Uint8Array;
-        argonKeyring: KeyringPair;
+        txSigner: TxSigningAccount;
         satoshis: bigint;
     } & ISubmittableOptions): Promise<{
         getLock(): Promise<{
@@ -13244,4 +13251,4 @@ declare function waitForLoad(): Promise<void>;
 declare function getClient(host: string, options?: ApiOptions): Promise<ArgonClient>;
 declare function getOfflineRegistry(): TypeRegistry;
 
-export { type ArgonClient, BitcoinLock, ExtrinsicError, FIXED_U128_DECIMALS, type IBitcoinLock, type IBitcoinLockConfig, type IReleaseRequest, type IReleaseRequestDetails, type ISubmittableOptions, type ITerms, type ITxProgressCallback, MICROGONS_PER_ARGON, PERMILL_DECIMALS, PriceIndex, SATS_PER_BTC, TxResult, TxSubmitter, Vault, WageProtector, checkForExtrinsicSuccess, createKeyringPair, dispatchErrorToExtrinsicError, dispatchErrorToString, formatArgons, fromFixedNumber, getAuthorFromHeader, getClient, getFrameInfoFromHeader, getOfflineRegistry, getTickFromHeader, gettersToObject, keyringFromSuri, toFixedNumber, waitForLoad };
+export { type ArgonClient, BitcoinLock, ExtrinsicError, FIXED_U128_DECIMALS, type IBitcoinLock, type IBitcoinLockConfig, type IReleaseRequest, type IReleaseRequestDetails, type ISubmittableOptions, type ITerms, type ITxProgressCallback, MICROGONS_PER_ARGON, PERMILL_DECIMALS, PriceIndex, SATS_PER_BTC, TxResult, type TxSigningAccount, TxSubmitter, Vault, WageProtector, checkForExtrinsicSuccess, createKeyringPair, dispatchErrorToExtrinsicError, dispatchErrorToString, formatArgons, fromFixedNumber, getAuthorFromHeader, getClient, getFrameInfoFromHeader, getOfflineRegistry, getTickFromHeader, gettersToObject, keyringFromSuri, toFixedNumber, waitForLoad };

package/lib/index.d.ts

@@ -12891,7 +12891,11 @@ declare class TxResult {
     private parseEvents;
 }
 
-type ISubmittableOptions = Partial<SignerOptions> & {
+type TxSigningAccount = KeyringPair | {
+    address: string;
+    signer: NonNullable<SignerOptions['signer']>;
+};
+type ISubmittableOptions = Partial<Omit<SignerOptions, 'signer'>> & {
     tip?: bigint;
     logResults?: boolean;
     useLatestNonce?: boolean;
@@ -12901,8 +12905,9 @@ type ISubmittableOptions = Partial<SignerOptions> & {
 declare class TxSubmitter {
     readonly client: ArgonClient;
     tx: SubmittableExtrinsic$1;
-    pair: KeyringPair;
-    constructor(client: ArgonClient, tx: SubmittableExtrinsic$1, pair: KeyringPair);
+    readonly account: TxSigningAccount;
+    readonly address: string;
+    constructor(client: ArgonClient, tx: SubmittableExtrinsic$1, account: TxSigningAccount);
     feeEstimate(tip?: bigint): Promise<bigint>;
     canAfford(options?: {
         tip?: bigint;
@@ -12913,6 +12918,8 @@ declare class TxSubmitter {
         availableBalance: bigint;
         txFee: bigint;
     }>;
+    sign(options?: ISubmittableOptions): Promise<SubmittableExtrinsic$1>;
+    submitSigned(signedTx: SubmittableExtrinsic$1, options?: ISubmittableOptions): Promise<TxResult>;
     submit(options?: ISubmittableOptions): Promise<TxResult>;
     private logRequest;
 }
@@ -12978,7 +12985,7 @@ declare class Vault {
     activatedSecuritizationPerSlot(): bigint;
     calculateBitcoinFee(amount: bigint): bigint;
     static get(client: ArgonClient | ApiDecoration<'promise'>, vaultId: number, tickDurationMillis?: number): Promise<Vault>;
-    static create(client: ArgonClient, keypair: KeyringPair, args: {
+    static create(client: ArgonClient, txSigner: TxSigningAccount, args: {
         securitization: bigint | number;
         securitizationRatio: number;
         annualPercentRate: number;
@@ -12993,7 +13000,7 @@ declare class Vault {
         getVault(): Promise<Vault>;
         txResult: TxResult;
     }>;
-    static setName(client: ArgonClient, keypair: KeyringPair, args: {
+    static setName(client: ArgonClient, txSigner: TxSigningAccount, args: {
         name?: string | null;
     } & ISubmittableOptions): Promise<TxResult>;
 }
@@ -13075,7 +13082,7 @@ declare class BitcoinLock implements IBitcoinLock {
     ratchet(args: {
         client: ArgonClient;
         priceIndex: PriceIndex;
-        argonKeyring: KeyringPair;
+        txSigner: TxSigningAccount;
         vault: Vault;
         microgonsPerBtc?: bigint;
     } & ISubmittableOptions): Promise<{
@@ -13096,7 +13103,7 @@ declare class BitcoinLock implements IBitcoinLock {
         client: ArgonClient;
         priceIndex: PriceIndex;
         releaseRequest: IReleaseRequest;
-        argonKeyring: KeyringPair;
+        txSigner: TxSigningAccount;
     } & ISubmittableOptions): Promise<TxResult>;
     getReleaseRequest(client: IQueryableClient): Promise<IReleaseRequestDetails | undefined>;
     /**
@@ -13122,7 +13129,7 @@ declare class BitcoinLock implements IBitcoinLock {
         client: ArgonClient;
         utxoId: number;
         vaultSignature: Uint8Array;
-        argonKeyring: KeyringPair;
+        txSigner: TxSigningAccount;
     } & ISubmittableOptions): Promise<TxResult>;
     static createIncreaseSecuritizationTx(args: {
         utxoId: number;
@@ -13153,7 +13160,7 @@ declare class BitcoinLock implements IBitcoinLock {
         priceIndex: PriceIndex;
         ownerBitcoinPubkey: Uint8Array;
         satoshis: bigint;
-        argonKeyring: KeyringPair;
+        txSigner: TxSigningAccount;
         reducedBalanceBy?: bigint;
         microgonsPerBtc?: bigint;
         tip?: bigint;
@@ -13171,7 +13178,7 @@ declare class BitcoinLock implements IBitcoinLock {
         vault: Vault;
         priceIndex: PriceIndex;
         ownerBitcoinPubkey: Uint8Array;
-        argonKeyring: KeyringPair;
+        txSigner: TxSigningAccount;
         satoshis: bigint;
     } & ISubmittableOptions): Promise<{
         getLock(): Promise<{
@@ -13244,4 +13251,4 @@ declare function waitForLoad(): Promise<void>;
 declare function getClient(host: string, options?: ApiOptions): Promise<ArgonClient>;
 declare function getOfflineRegistry(): TypeRegistry;
 
-export { type ArgonClient, BitcoinLock, ExtrinsicError, FIXED_U128_DECIMALS, type IBitcoinLock, type IBitcoinLockConfig, type IReleaseRequest, type IReleaseRequestDetails, type ISubmittableOptions, type ITerms, type ITxProgressCallback, MICROGONS_PER_ARGON, PERMILL_DECIMALS, PriceIndex, SATS_PER_BTC, TxResult, TxSubmitter, Vault, WageProtector, checkForExtrinsicSuccess, createKeyringPair, dispatchErrorToExtrinsicError, dispatchErrorToString, formatArgons, fromFixedNumber, getAuthorFromHeader, getClient, getFrameInfoFromHeader, getOfflineRegistry, getTickFromHeader, gettersToObject, keyringFromSuri, toFixedNumber, waitForLoad };
+export { type ArgonClient, BitcoinLock, ExtrinsicError, FIXED_U128_DECIMALS, type IBitcoinLock, type IBitcoinLockConfig, type IReleaseRequest, type IReleaseRequestDetails, type ISubmittableOptions, type ITerms, type ITxProgressCallback, MICROGONS_PER_ARGON, PERMILL_DECIMALS, PriceIndex, SATS_PER_BTC, TxResult, type TxSigningAccount, TxSubmitter, Vault, WageProtector, checkForExtrinsicSuccess, createKeyringPair, dispatchErrorToExtrinsicError, dispatchErrorToString, formatArgons, fromFixedNumber, getAuthorFromHeader, getClient, getFrameInfoFromHeader, getOfflineRegistry, getTickFromHeader, gettersToObject, keyringFromSuri, toFixedNumber, waitForLoad };

package/lib/index.js

@@ -346,18 +346,20 @@ var TxResult = class {
 
 // src/TxSubmitter.ts
 var TxSubmitter = class {
-  constructor(client, tx, pair) {
+  constructor(client, tx, account) {
     this.client = client;
     this.tx = tx;
-    this.pair = pair;
+    this.account = account;
+    this.address = account.address;
   }
+  address;
   async feeEstimate(tip) {
-    const { partialFee } = await this.tx.paymentInfo(this.pair, { tip });
+    const { partialFee } = await this.tx.paymentInfo(this.address, { tip });
     return partialFee.toBigInt();
   }
   async canAfford(options = {}) {
     const { tip, unavailableBalance } = options;
-    const account = await this.client.query.system.account(this.pair.address);
+    const account = await this.client.query.system.account(this.address);
     let availableBalance = account.data.free.toBigInt();
     const userBalance = availableBalance;
     if (unavailableBalance) {
@@ -369,26 +371,32 @@ var TxSubmitter = class {
     const canAfford = availableBalance >= totalCharge + existentialDeposit;
     return { canAfford, availableBalance: userBalance, txFee: fees };
   }
-  async submit(options = {}) {
+  async sign(options = {}) {
     const { useLatestNonce, ...apiOptions } = options;
     await waitForLoad();
+    if (useLatestNonce && apiOptions.nonce === void 0) {
+      apiOptions.nonce = await this.client.rpc.system.accountNextIndex(this.address);
+    }
+    if ("signer" in this.account) {
+      return await this.tx.signAsync(this.address, { ...apiOptions, signer: this.account.signer });
+    }
+    return await this.tx.signAsync(this.account, apiOptions);
+  }
+  async submitSigned(signedTx, options = {}) {
     const blockHeight = await this.client.rpc.chain.getHeader().then((h) => h.number.toNumber());
     if (options.logResults) {
       this.logRequest();
     }
-    if (useLatestNonce && !apiOptions.nonce) {
-      apiOptions.nonce = await this.client.rpc.system.accountNextIndex(this.pair.address);
-    }
-    const signedTx = await this.tx.signAsync(this.pair, apiOptions);
     const txHash = signedTx.hash.toHex();
     const result2 = new TxResult(this.client, {
       signedHash: txHash,
       method: signedTx.method.toHuman(),
-      accountAddress: this.pair.address,
+      accountAddress: this.address,
       submittedTime: /* @__PURE__ */ new Date(),
       submittedAtBlockNumber: blockHeight,
       nonce: signedTx.nonce.toNumber()
     });
+    result2.txProgressCallback = options.txProgressCallback;
     if (options.disableAutomaticTxTracking !== true) {
       await signedTx.send(result2.onSubscriptionResult.bind(result2));
     } else {
@@ -401,6 +409,10 @@ var TxSubmitter = class {
     }
     return result2;
   }
+  async submit(options = {}) {
+    const signedTx = await this.sign(options);
+    return await this.submitSigned(signedTx, options);
+  }
   logRequest() {
     let toHuman = this.tx.toHuman().method;
     const txString = [];
@@ -419,7 +431,7 @@ var TxSubmitter = class {
       args.push(toHuman.args);
     }
     args.unshift(txString.join("->"));
-    console.log("Submitting transaction from %s:", this.pair.address, ...args);
+    console.log("Submitting transaction from %s:", this.address, ...args);
   }
 };
 function formatCall(call) {
@@ -621,7 +633,7 @@ var Vault = class _Vault {
     const tickDuration = tickDurationMillis ?? await client.query.ticks.genesisTicker().then((x) => x.tickDurationMillis.toNumber());
     return new _Vault(vaultId, rawVault.unwrap(), tickDuration);
   }
-  static async create(client, keypair, args, config = {}) {
+  static async create(client, txSigner, args, config = {}) {
     const {
       securitization,
       securitizationRatio,
@@ -658,7 +670,7 @@ var Vault = class _Vault {
       bitcoinXpubkey: xpubBytes,
       name: encodedName
     };
-    const tx = new TxSubmitter(client, client.tx.vaults.create(vaultParams), keypair);
+    const tx = new TxSubmitter(client, client.tx.vaults.create(vaultParams), txSigner);
     if (doNotExceedBalance) {
       const finalTip = tip ?? 0n;
       let txFee = await tx.feeEstimate(finalTip);
@@ -694,11 +706,11 @@ var Vault = class _Vault {
     }
     return { getVault, txResult: result2 };
   }
-  static async setName(client, keypair, args) {
+  static async setName(client, txSigner, args) {
     const tx = new TxSubmitter(
       client,
       client.tx.vaults.setName(encodeVaultName(args.name)),
-      keypair
+      txSigner
     );
     return tx.submit({
       ...args,
@@ -721,7 +733,7 @@ function encodeVaultName(name) {
       "Vault name must start with a capital letter and contain at most 18 alphanumeric characters"
     );
   }
-  return new TextEncoder().encode(name);
+  return name;
 }
 
 // src/convert.ts
@@ -853,10 +865,10 @@ var BitcoinLock = class _BitcoinLock {
     };
   }
   async ratchet(args) {
-    const { priceIndex, argonKeyring, tip = 0n, vault, client, microgonsPerBtc = null } = args;
+    const { priceIndex, txSigner, tip = 0n, vault, client, microgonsPerBtc = null } = args;
     const ratchetPrice = await this.getRatchetPrice(client, priceIndex, vault);
     const tx = client.tx.bitcoinLocks.ratchet(this.utxoId, { V1: { microgonsPerBtc } });
-    const txSubmitter = new TxSubmitter(client, tx, argonKeyring);
+    const txSubmitter = new TxSubmitter(client, tx, txSigner);
     const canAfford = await txSubmitter.canAfford({
       tip,
       unavailableBalance: BigInt(ratchetPrice.burnAmount + ratchetPrice.ratchetingFee)
@@ -914,7 +926,7 @@ var BitcoinLock = class _BitcoinLock {
     const {
       priceIndex,
       releaseRequest: { bitcoinNetworkFee, toScriptPubkey },
-      argonKeyring,
+      txSigner,
       tip = 0n,
       client
     } = args;
@@ -924,7 +936,7 @@ var BitcoinLock = class _BitcoinLock {
     const submitter = new TxSubmitter(
       client,
       client.tx.bitcoinLocks.requestRelease(this.utxoId, toScriptPubkey, bitcoinNetworkFee),
-      argonKeyring
+      txSigner
     );
     const redemptionPrice = await _BitcoinLock.getRedemptionRate(priceIndex, this);
     const canAfford = await submitter.canAfford({
@@ -1065,7 +1077,7 @@ var BitcoinLock = class _BitcoinLock {
     return await client.query.bitcoinUtxos.confirmedBitcoinBlockTip().then((x) => x.value?.blockHeight.toNumber() ?? 0);
   }
   static async submitVaultSignature(args) {
-    const { utxoId, vaultSignature, argonKeyring, client } = args;
+    const { utxoId, vaultSignature, txSigner, client } = args;
     if (!vaultSignature || vaultSignature.byteLength < 70 || vaultSignature.byteLength > 73) {
       throw new Error(
         `Invalid vault signature length: ${vaultSignature.byteLength}. Must be 70-73 bytes.`
@@ -1073,7 +1085,7 @@ var BitcoinLock = class _BitcoinLock {
     }
     const signature = u8aToHex(vaultSignature);
     const tx = client.tx.bitcoinLocks.cosignRelease(utxoId, signature);
-    const submitter = new TxSubmitter(client, tx, argonKeyring);
+    const submitter = new TxSubmitter(client, tx, txSigner);
     return await submitter.submit(args);
   }
   static async createIncreaseSecuritizationTx(args) {
@@ -1203,7 +1215,7 @@ var BitcoinLock = class _BitcoinLock {
     const {
       vault,
       priceIndex,
-      argonKeyring,
+      txSigner,
       satoshis,
       tip = 0n,
       ownerBitcoinPubkey,
@@ -1236,9 +1248,9 @@ var BitcoinLock = class _BitcoinLock {
         }
       });
     }
-    const submitter = new TxSubmitter(client, tx, argonKeyring);
+    const submitter = new TxSubmitter(client, tx, txSigner);
     const marketPrice = await this.getMarketRate(priceIndex, satoshis);
-    const isVaultOwner = argonKeyring.address === vault.operatorAccountId;
+    const isVaultOwner = txSigner.address === vault.operatorAccountId;
     const securityFee = isVaultOwner ? 0n : vault.calculateBitcoinFee(marketPrice);
     const { canAfford, availableBalance, txFee } = await submitter.canAfford({
       tip,
@@ -1255,14 +1267,14 @@ var BitcoinLock = class _BitcoinLock {
     };
   }
   static async initialize(args) {
-    const { argonKeyring, client } = args;
+    const { txSigner, client } = args;
     const { tx, securityFee, canAfford, txFeePlusTip } = await this.createInitializeTx(args);
     if (!canAfford) {
       throw new Error(
         `Insufficient funds to initialize bitcoin lock. Required security fee: ${formatArgons(securityFee)}, Tx fee plus tip: ${formatArgons(txFeePlusTip)}`
       );
     }
-    const submitter = new TxSubmitter(client, tx, argonKeyring);
+    const submitter = new TxSubmitter(client, tx, txSigner);
     const txResult = await submitter.submit({ logResults: true, ...args });
     return {
       getLock: () => this.getBitcoinLockFromTxResult(client, txResult),