@umbra-privacy/sdk 3.0.0 → 4.0.0

package/dist/index.d.cts

@@ -251,21 +251,21 @@ interface GetUmbraClientArgs {
      * Whether to defer the master seed signing prompt to first use.
      *
      * @remarks
-     * When `true` (the default), `getUmbraClient` resolves immediately
-     * without prompting the wallet. The signing prompt for master seed derivation
-     * fires lazily on the first call to `client.masterSeed.getMasterSeed()`, which
-     * occurs automatically the first time any service function needs a derived key.
+     * When `false` (the default), the factory awaits master seed derivation
+     * before resolving. The wallet signing prompt fires immediately during
+     * construction so that by the time the returned `Promise` resolves, the
+     * master seed is already cached and no further wallet prompts will occur
+     * for key derivation.
      *
-     * When `false`, the factory awaits master seed derivation before resolving.
-     * The wallet signing prompt fires immediately during construction so that by
-     * the time the returned `Promise` resolves, the master seed is already cached
-     * and no further wallet prompts will occur for key derivation.
+     * When `true`, `getUmbraClient` resolves immediately without prompting
+     * the wallet. The signing prompt for master seed derivation fires lazily
+     * on the first call to `client.masterSeed.getMasterSeed()`, which occurs
+     * automatically the first time any service function needs a derived key.
      *
-     * Use `false` when you want to authenticate the user upfront — for example,
-     * at app launch — and guarantee that all subsequent operations proceed without
-     * unexpected signing interruptions.
+     * Use `true` when you want the client to be available instantly (e.g. at
+     * wallet connect time) and defer the signing prompt to the first operation.
      *
-     * @defaultValue `true`
+     * @defaultValue `false`
      */
     readonly deferMasterSeedSignature?: boolean;
 }
@@ -427,7 +427,7 @@ declare function getUmbraClient(args: GetUmbraClientArgs, deps?: GetUmbraClientD
  *
  * @public
  */
-declare const UMBRA_MESSAGE_TO_SIGN = "Umbra Protocol \u2013 User Consent & Acknowledgement\n\nPlease read carefully before continuing. Umbra is a non-custodial, open-source protocol. Umbra does not hold, control, manage, or access your digital assets, private keys, viewing keys, transactions, or personal data. All interactions with the Umbra protocol occur through autonomous smart contracts and wallet-signed transactions executed directly on the blockchain.\n\nBy using the Umbra protocol, you acknowledge and agree that:\n\n1. You are solely responsible for managing your wallet, private keys, privacy settings, viewing key disclosures, and any transactions or interactions you authorize.\n2. Blockchain transactions are generally irreversible, and smart contracts may contain bugs, vulnerabilities, or unintended behavior.\n3. Errors, misuse, misconfiguration, third-party tools, relayers, or loss of keys may result in permanent and unrecoverable loss of assets or privacy.\n4. Privacy features are designed to enhance confidentiality but do not guarantee absolute or unconditional anonymity.\n5. Transactions may involve independent relayers or third-party infrastructure that Umbra does not operate, control, or supervise.\n6. By clicking \"I Agree\", you confirm that you have read, understood, and accepted all applicable terms, policies, risk disclosures, notices, and other documentation governing your access to and use of the Umbra protocol, as published or made available by Umbra from time to time.\n\nYou acknowledge that such documentation may be updated or modified, and that continued access to or use of the Umbra Protocol constitutes acceptance of the then-current versions. If you do not agree, do not proceed and discontinue use of the Umbra protocol.";
+declare const UMBRA_MESSAGE_TO_SIGN = "\nUmbra Protocol \u2013 User Consent & Acknowledgement\n\nPlease read carefully before continuing. Umbra is a non-custodial, open-source protocol. Umbra does not hold, control, manage, or access your digital assets, private keys, viewing keys, transactions, or personal data. All interactions with the Umbra protocol occur through autonomous smart contracts and wallet-signed transactions executed directly on the blockchain.\n\nBy using the Umbra protocol, you acknowledge and agree that:\n\n1. You are solely responsible for managing your wallet, private keys, privacy settings, viewing key disclosures, and any transactions or interactions you authorize.\n2.Blockchain transactions are generally irreversible, and smart contracts may contain bugs, vulnerabilities, or unintended behavior.\n3. Errors, misuse, misconfiguration, third-party tools, relayers, or loss of keys may result in permanent and unrecoverable loss of assets or privacy.\n4. Privacy features are designed to enhance confidentiality but do not guarantee absolute or unconditional anonymity.\n5. Transactions may involve independent relayers or third-party infrastructure that Umbra does not operate, control, or supervise.\n6. By clicking \"I Agree\", you confirm that you have read, understood, and accepted all applicable terms, policies, risk disclosures, notices, and other documentation governing your access to and use of the Umbra protocol, as published or made available by Umbra from time to time.\nYou acknowledge that such documentation may be updated or modified, and that continued access to or use of the Umbra Protocol constitutes acceptance of the then-current versions. If you do not agree, do not proceed and discontinue use of the Umbra protocol.\n";
 /**
  * Offset discriminators used when deriving PDAs for fee-related on-chain accounts.
  *

package/dist/index.d.ts

@@ -251,21 +251,21 @@ interface GetUmbraClientArgs {
      * Whether to defer the master seed signing prompt to first use.
      *
      * @remarks
-     * When `true` (the default), `getUmbraClient` resolves immediately
-     * without prompting the wallet. The signing prompt for master seed derivation
-     * fires lazily on the first call to `client.masterSeed.getMasterSeed()`, which
-     * occurs automatically the first time any service function needs a derived key.
+     * When `false` (the default), the factory awaits master seed derivation
+     * before resolving. The wallet signing prompt fires immediately during
+     * construction so that by the time the returned `Promise` resolves, the
+     * master seed is already cached and no further wallet prompts will occur
+     * for key derivation.
      *
-     * When `false`, the factory awaits master seed derivation before resolving.
-     * The wallet signing prompt fires immediately during construction so that by
-     * the time the returned `Promise` resolves, the master seed is already cached
-     * and no further wallet prompts will occur for key derivation.
+     * When `true`, `getUmbraClient` resolves immediately without prompting
+     * the wallet. The signing prompt for master seed derivation fires lazily
+     * on the first call to `client.masterSeed.getMasterSeed()`, which occurs
+     * automatically the first time any service function needs a derived key.
      *
-     * Use `false` when you want to authenticate the user upfront — for example,
-     * at app launch — and guarantee that all subsequent operations proceed without
-     * unexpected signing interruptions.
+     * Use `true` when you want the client to be available instantly (e.g. at
+     * wallet connect time) and defer the signing prompt to the first operation.
      *
-     * @defaultValue `true`
+     * @defaultValue `false`
      */
     readonly deferMasterSeedSignature?: boolean;
 }
@@ -427,7 +427,7 @@ declare function getUmbraClient(args: GetUmbraClientArgs, deps?: GetUmbraClientD
  *
  * @public
  */
-declare const UMBRA_MESSAGE_TO_SIGN = "Umbra Protocol \u2013 User Consent & Acknowledgement\n\nPlease read carefully before continuing. Umbra is a non-custodial, open-source protocol. Umbra does not hold, control, manage, or access your digital assets, private keys, viewing keys, transactions, or personal data. All interactions with the Umbra protocol occur through autonomous smart contracts and wallet-signed transactions executed directly on the blockchain.\n\nBy using the Umbra protocol, you acknowledge and agree that:\n\n1. You are solely responsible for managing your wallet, private keys, privacy settings, viewing key disclosures, and any transactions or interactions you authorize.\n2. Blockchain transactions are generally irreversible, and smart contracts may contain bugs, vulnerabilities, or unintended behavior.\n3. Errors, misuse, misconfiguration, third-party tools, relayers, or loss of keys may result in permanent and unrecoverable loss of assets or privacy.\n4. Privacy features are designed to enhance confidentiality but do not guarantee absolute or unconditional anonymity.\n5. Transactions may involve independent relayers or third-party infrastructure that Umbra does not operate, control, or supervise.\n6. By clicking \"I Agree\", you confirm that you have read, understood, and accepted all applicable terms, policies, risk disclosures, notices, and other documentation governing your access to and use of the Umbra protocol, as published or made available by Umbra from time to time.\n\nYou acknowledge that such documentation may be updated or modified, and that continued access to or use of the Umbra Protocol constitutes acceptance of the then-current versions. If you do not agree, do not proceed and discontinue use of the Umbra protocol.";
+declare const UMBRA_MESSAGE_TO_SIGN = "\nUmbra Protocol \u2013 User Consent & Acknowledgement\n\nPlease read carefully before continuing. Umbra is a non-custodial, open-source protocol. Umbra does not hold, control, manage, or access your digital assets, private keys, viewing keys, transactions, or personal data. All interactions with the Umbra protocol occur through autonomous smart contracts and wallet-signed transactions executed directly on the blockchain.\n\nBy using the Umbra protocol, you acknowledge and agree that:\n\n1. You are solely responsible for managing your wallet, private keys, privacy settings, viewing key disclosures, and any transactions or interactions you authorize.\n2.Blockchain transactions are generally irreversible, and smart contracts may contain bugs, vulnerabilities, or unintended behavior.\n3. Errors, misuse, misconfiguration, third-party tools, relayers, or loss of keys may result in permanent and unrecoverable loss of assets or privacy.\n4. Privacy features are designed to enhance confidentiality but do not guarantee absolute or unconditional anonymity.\n5. Transactions may involve independent relayers or third-party infrastructure that Umbra does not operate, control, or supervise.\n6. By clicking \"I Agree\", you confirm that you have read, understood, and accepted all applicable terms, policies, risk disclosures, notices, and other documentation governing your access to and use of the Umbra protocol, as published or made available by Umbra from time to time.\nYou acknowledge that such documentation may be updated or modified, and that continued access to or use of the Umbra Protocol constitutes acceptance of the then-current versions. If you do not agree, do not proceed and discontinue use of the Umbra protocol.\n";
 /**
  * Offset discriminators used when deriving PDAs for fee-related on-chain accounts.
  *

package/dist/index.js

@@ -29,20 +29,21 @@ import { keccak_256 } from '@noble/hashes/sha3.js';
 import { getCreateUserGrantInstructionAsync, getDeleteUserGrantInstructionAsync, getReencryptUserGrantV11InstructionAsync, getReencryptNetworkGrantForNetworkBalanceV11InstructionAsync, getReencryptNetworkGrantForSharedBalanceV11InstructionAsync, decodeEncryptedTokenAccount, getConvertNetworkBalanceToSharedBalanceV11InstructionAsync, getReencryptSharedBalanceV11InstructionAsync, decodeEncryptedUserAccount, getResetSharedEncryptedTokenAccountQueueV11InstructionAsync, getResetNetworkEncryptedTokenAccountQueueV11InstructionAsync, getDepositFromPublicBalanceIntoExistingSharedBalanceV11InstructionAsync, getDepositFromPublicBalanceIntoNewSharedBalanceV11InstructionAsync, getDepositFromPublicBalanceIntoExistingNetworkBalanceV11InstructionAsync, getDepositFromPublicBalanceIntoNewNetworkBalanceV11InstructionAsync, getCloseStealthPoolDepositInputBufferInstructionAsync, getCreateStealthPoolDepositInputBufferInstructionAsync, getDepositIntoStealthPoolFromSharedBalanceV11InstructionAsync, getClosePublicStealthPoolDepositInputBufferInstructionAsync, getCreatePublicStealthPoolDepositInputBufferInstructionAsync, getDepositIntoStealthPoolFromPublicBalanceInstructionAsync, getClaimStagedSolFromPoolInstructionAsync, getClaimStagedSplFromPoolInstructionAsync, getEncryptedUserAccountSize, ENCRYPTED_USER_ACCOUNT_DISCRIMINATOR, getInitialiseEncryptedUserAccountInstructionAsync, getRegisterTokenPublicKeyInstructionAsync, getRegisterUserForAnonymousUsageV11InstructionAsync, getUpdateRandomGenerationSeedInstructionAsync, getUpdateTokenAccountRandomGenerationSeedInstructionAsync, getWithdrawFromSharedBalanceIntoPublicBalanceV11InstructionAsync } from '@umbra-privacy/umbra-codama';
 
 // src/umbra/constants.ts
-var UMBRA_MESSAGE_TO_SIGN = `Umbra Protocol – User Consent & Acknowledgement
+var UMBRA_MESSAGE_TO_SIGN = `
+Umbra Protocol – User Consent & Acknowledgement
 
 Please read carefully before continuing. Umbra is a non-custodial, open-source protocol. Umbra does not hold, control, manage, or access your digital assets, private keys, viewing keys, transactions, or personal data. All interactions with the Umbra protocol occur through autonomous smart contracts and wallet-signed transactions executed directly on the blockchain.
 
 By using the Umbra protocol, you acknowledge and agree that:
 
 1. You are solely responsible for managing your wallet, private keys, privacy settings, viewing key disclosures, and any transactions or interactions you authorize.
-2. Blockchain transactions are generally irreversible, and smart contracts may contain bugs, vulnerabilities, or unintended behavior.
+2.Blockchain transactions are generally irreversible, and smart contracts may contain bugs, vulnerabilities, or unintended behavior.
 3. Errors, misuse, misconfiguration, third-party tools, relayers, or loss of keys may result in permanent and unrecoverable loss of assets or privacy.
 4. Privacy features are designed to enhance confidentiality but do not guarantee absolute or unconditional anonymity.
 5. Transactions may involve independent relayers or third-party infrastructure that Umbra does not operate, control, or supervise.
 6. By clicking "I Agree", you confirm that you have read, understood, and accepted all applicable terms, policies, risk disclosures, notices, and other documentation governing your access to and use of the Umbra protocol, as published or made available by Umbra from time to time.
-
-You acknowledge that such documentation may be updated or modified, and that continued access to or use of the Umbra Protocol constitutes acceptance of the then-current versions. If you do not agree, do not proceed and discontinue use of the Umbra protocol.`;
+You acknowledge that such documentation may be updated or modified, and that continued access to or use of the Umbra Protocol constitutes acceptance of the then-current versions. If you do not agree, do not proceed and discontinue use of the Umbra protocol.
+`;
 var FEE_OFFSETS = {
   /**
    * Offset used in `FeeVault` PDA derivation for the unified protocol fees pool.