Optional rate: numberStatic getGenerated using TypeDoc
Optional rate: numberStatic getGenerated using TypeDoc
Optional petnameOptional relayStatic findStatic fromStatic mergeStatic removeStatic toStatic toGenerated using TypeDoc
Optional petnameOptional relayStatic findStatic fromStatic mergeStatic removeStatic toStatic toGenerated using TypeDoc
Static fromStatic fromStatic fromStatic toGenerated using TypeDoc
Static fromStatic fromStatic fromStatic toGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional eoseOptional getGenerated using TypeDoc
Optional eoseOptional getGenerated using TypeDoc
Optional publicKeys: string | string[]Optional generatedOptional lastOptional vaultOptional frozenOptional policyOptional utxos?: string[]Static fromOptional publicKeys: string | string[]Generated using TypeDoc
Optional publicKeys: string | string[]Optional generatedOptional lastOptional vaultOptional frozenOptional policyOptional utxos?: string[]Static fromOptional publicKeys: string | string[]Generated using TypeDoc
Changes the fiat currency used to fetch the Bitcoin exchange rate.
The fiat currency to use.
changeFiatCurrency("usd");
Method to check if a proposal's PSBTs can be finalized.
This method retrieves all approvals for a given proposal ID, filters out the approvals that are expired, and checks if the PSBTs for the active approvals can be finalized.
The ID of the proposal to check.
A Promise that resolves to a boolean indicating whether the PSBTs for the given proposal can be finalized.
-Asynchronously deletes approvals with the given IDs.
+Asynchronously deletes approvals with the given IDs.
Single or multiple approval IDs to be deleted.
void when the operation is successful.await deleteApprovals('some-approval-id');
Asynchronously deletes completed proposals with the given IDs.
Single or multiple completed proposal IDs to be deleted.
void when the operation is successful.await
Example
await deleteCompletedProposals('some-completed-proposal-id');
-Asynchronously deletes policies with the given IDs.
Single or multiple policy IDs to be deleted.
void when the operation is successful.await
Example
await deletePolicies('some-policy-id');
-Asynchronously deletes proposals with the given IDs.
Single or multiple proposal IDs to be deleted.
void when the operation is successful.await
Example
await deleteProposals('some-proposal-id');
-Asynchronously deletes signers with the given IDs.
Single or multiple signer IDs to be deleted.
void when the operation is successful.await
Example
await deleteSigners('some-signer-id');
-Method to finalize a spending proposal.
+Method to finalize a spending proposal.
This method finalizes a spending proposal by doing the following:
awaitParameters
proposalId: string
The ID of the spending proposal to finalize.
Returns Promise<CompletedPublishedProposal>
A Promise that resolves to a CompletedPublishedProposal object representing the finalized proposal.
Throws
An error if the proposal or policy cannot be found, if there are no approvals for the proposal, if the PSBTs cannot be finalized, or if the proposal cannot be broadcast.
-get
- get
Returns the active fiat currency
+
get
- get
Returns the active fiat currency
Returns FiatCurrency
Example
const currency = getActiveFiatCurrency();
-
get
- get
Parameters
policyId: string
type: ProposalType
Returns Promise<ActivePublishedProposal[]>
get
- get
Asynchronously fetches approvals associated with given proposal IDs.
+
get
- get
Parameters
policyId: string
type: ProposalType
Returns Promise<ActivePublishedProposal[]>
get
- get
Asynchronously fetches approvals associated with given proposal IDs.
Parameters
Optional proposal_ids: string | string[]
Optional proposal IDs to filter the approvals by.
Returns Promise<Map<string, PublishedApprovedProposal[]>>
-
A Promise that resolves to a Map. Each key in the map is a proposal ID, and the corresponding value is an array
@@ -192,7 +192,7 @@
Example
awaitThrows
- Throws an error if there is a failure in fetching approvals.
-
Asynchronously fetches approved proposals by their associated policy IDs.
+Asynchronously fetches approved proposals by their associated policy IDs.
A single policy ID or an array of policy IDs for which to fetch approved proposals. If this is not specified, the function fetches approvals for all available policy IDs.
// Fetch approvals for a single policy ID
const approvals = await getApprovalsByPolicyId('some-policy-id');
// Fetch approvals for multiple policy IDs
const approvals = await getApprovalsByPolicyId(['policy-id-1', 'policy-id-2']);
SmartVaultsTypes.PublishedApprovedProposal - For the structure of a PublishedApprovedProposal object.
-Retrieves a completed proposal based on the provided transaction details.
+Retrieves a completed proposal based on the provided transaction details.
Object containing the transaction details.
A Promise that resolves with the completed proposal, if found, or null.
getCompletedProposalByTx
getCompletedProposalByTx({txid: '1234', confirmation_time: {confirmedAt: new Date()}, net: -1})
Asynchronously fetches all completed proposals, optionally with pagination.
+Asynchronously fetches all completed proposals, optionally with pagination.
Optional paginationOpts: PaginationOpts = {}Optional pagination options to control the returned data.
getCompletedPr
Example
// Fetch completed proposals with default settings
const proposals = await getCompletedProposals();
// Fetch completed proposals with pagination
const proposals = await getCompletedProposals({ limit: 5 });
See
SmartVaultsTypes.CompletedPublishedProposal - For the structure of a CompletedPublishedProposal object.
-Asynchronously fetches completed proposals by their IDs.
+Asynchronously fetches completed proposals by their IDs.
The IDs of the completed proposals to fetch.
Optional paginationOpts: PaginationOpts = {}Optional pagination options to limit the number of returned proposals or to fetch from a specific offset.
SmartVaultsTypes.CompletedPublishedProposal - For the structure o
// Fetch a single proposal by ID
const proposals = await getCompletedProposalsById("some-proposal-id");
// Fetch multiple proposals by IDs with pagination
const proposals = await getCompletedProposalsById(["id1", "id2"], { since: new Date() });
SmartVaultsTypes.CompletedPublishedProposal - For the structure of a CompletedPublishedProposal object.
-Asynchronously fetches completed proposals by their associated policy IDs.
+Asynchronously fetches completed proposals by their associated policy IDs.
The policy IDs corresponding to the completed proposals to fetch.
Optional paginationOpts: PaginationOpts = {}Optional pagination options to limit the number of returned proposals or to fetch from a specific offset.
SmartVaultsTypes.CompletedPublishedProposal - For the structure o
// Fetch a single proposal by policy ID
const proposals = await getCompletedProposalsByPolicyId("some-policy-id");
// Fetch multiple proposals by policy IDs with pagination
const proposals = await getCompletedProposalsByPolicyId(["policy-id1", "policy-id2"], { since : new Date() });
SmartVaultsTypes.PublishedCompletedSpendingProposal - For the structure of a PublishedCompletedSpendingProposal object.
-Retrieves profiles for given contacts or for all contacts if none are provided.
+Retrieves profiles for given contacts or for all contacts if none are provided.
Optional contacts: Contact[]Optional array of contacts.
const contactProfiles = await getContactProfiles([{ publicKey: 'key1' }, { publicKey: 'key2' }]);
Returns the number of contacts that have shared their signer.
The Nostr hex public key of user for which to fetch the number of contacts that have shared their signer.
- A promise that resolves to the number of contacts that have shared their signer.
const howManySigners = await getContactSignersCount("hexPubKey");
Retrieves all contacts for the authenticated user.
+Optional signerDescriptors: string[]Asynchronously retrieves one or more labels by their IDs.
+Optional signerDescriptors: string[]Asynchronously retrieves one or more labels by their IDs.
The label IDs to fetch.
Optional paginationOpts: PaginationOpts = {}Optional pagination options.
- A promise that resolves to a map where the keys are label IDs and the values are the corresponding labels.
const labelsMap = await getLabelById(['label1', 'label2']);
Asynchronously retrieves a label given its label data.
+Asynchronously retrieves a label given its label data.
The policy ID associaded with the label.
The label data (could be an address a trxid, etc).
- A promise that resolves to a PublishedLabel.
const labels = await getLabelByLabelData("policyId","trxid");
Asynchronously retrieves labels based on the given pagination options.
+Asynchronously retrieves labels based on the given pagination options.
Optional paginationOpts: PaginationOpts = {}Optional pagination options for fetching labels.
const labels = await getLabels();
Asynchronously retrieves labels associated with one or more policy IDs.
+Asynchronously retrieves labels associated with one or more policy IDs.
This method first converts the input into an array of policy IDs (if not already), builds the appropriate filter with pagination options, and then fetches the labels.
The policy IDs to filter labels by.
@@ -298,7 +298,7 @@SmartVaultsTypes.PublishedCompletedSpendingProposal - For the str A promise that resolves to a map where the keys are policy IDs and the values are the associated labels.
const labelsMap = await getLabelsByPolicyId(['policy1', 'policy2']);
Optional signerDescriptor: stringAsynchronously fetches signers the user has shared. +
Optional signerDescriptor: stringAsynchronously fetches signers the user has shared. If IDs are provided, the method fetches signers corresponding to those IDs. Otherwise, it fetches all shared signers based.
Optional id: string | string[]Optional ID(s) of the signers to fetch.
@@ -309,11 +309,11 @@SmartVaultsTypes.PublishedCompletedSpendingProposal - For the str
// Fetch a single shared signer by ID
const result = await getMySharedSigners("some-signer-id");
// Fetch multiple shared signers by IDs
const result = await getMySharedSigners(["id1", "id2"]);
// Fetch all shared signers
const result = await getMySharedSigners();
SmartVaultsTypes.MySharedSigner - For the structure of MySharedSigner objects.
-Optional signerOfferingIds: string[]Optional signerDescriptors: string[]Optional signerFingerprints: string[]Fetches signers owned by the user and returns them as an array of BaseOwnedSigner objects.
+Optional signerOfferingIds: string[]Optional signerDescriptors: string[]Optional signerFingerprints: string[]Fetches signers owned by the user and returns them as an array of BaseOwnedSigner objects.
A promise that resolves to an array of BaseOwnedSigner objects. Each BaseOwnedSigner object represents an owned signer and contains all the properties of the base signer object, plus `ownerPubKey' and 'createdAt' properties.
Throws an error if there's an issue in fetching signer events or decrypting content.
-Asynchronously retrieves policies within a specified pagination scope.
+Asynchronously retrieves policies within a specified pagination scope.
Optional paginationOpts: PaginationOpts = {}Pagination options for fetching policies.
Asynchronously retrieves policies by their IDs.
+Asynchronously retrieves policies by their IDs.
An array of policy IDs.
const
Example
const ids = ['id1', 'id2'];
const policiesById = await getPoliciesById(ids);
-Retrieves a profile by a given public key or uses the instance's public key if not provided.
+Retrieves a profile by a given public key or uses the instance's public key if not provided.
Optional publicKey: stringOptional public key to fetch the profile.
const profile = await getProfile('publicKey123');
Retrieves multiple profiles by their public keys.
+Method to retrieve and decrypt not completed proposals.
+Method to retrieve and decrypt not completed proposals.
This method retrieves all not completed proposals.
A Promise that resolves to an array of decrypted proposals.
-Asynchronously fetches proposals by their IDs.
+Asynchronously fetches proposals by their IDs.
A single proposal ID or an array of proposal IDs to fetch.
Optional paginationOpts: PaginationOpts = {}Optional pagination options.
const
Example
const proposalsById = await getProposalsById('some-proposal-id');
-Asynchronously fetches proposals by associated policy IDs.
+Asynchronously fetches proposals by associated policy IDs.
A single policy ID or an array of policy IDs for which to fetch proposals.
Optional paginationOpts: PaginationOpts = {}Optional pagination options.
const
Example
const proposalsByPolicyId = await getProposalsByPolicyId('some-policy-id');
-Retrieves a list of recommended contacts based on shared signers.
+Asynchronously retrieves shared keys by their IDs.
+Asynchronously retrieves shared keys by their IDs.
An array of shared key IDs.
const
Example
const ids = ['id1', 'id2'];
const sharedKeysById = await getSharedKeysById(ids);
-Asynchronously fetches signers shared with the user based on specified public keys. +
Asynchronously fetches signers shared with the user based on specified public keys. Returns them as an array of PublishedSharedSigner objects, each containing details such as owner's public key and creation time.
Optional publicKeys: string | string[]Optional public keys to filter the fetched signers. Can be a single string or an array of strings.
constExample// Fetch shared signers by a specific public key
const result = await getSharedSigners("some-public-key");
// Fetch shared signers by multiple public keys
const result = await getSharedSigners(["key1", "key2"]);
// Fetch all shared signers
const result = await getSharedSigners();
See
SmartVaultsTypes.PublishedSharedSigner - For the structure of PublishedSharedSigner objects.
-Optional publicKeys: string | string[]Optional fromVerifiedKeyAgents: booleanOptional paginationOpts: PaginationOptsOptional signerOfferingIds: string[]Optional fromVerifiedKeyAgents: booleanOptional paginationOpts: PaginationOptsOptional keyAgentsPubKeys: string[]Optional fromVerifiedKeyAgents: booleanOptional paginationOpts: PaginationOptsOptional period: PeriodOptional publicKeys: string | string[]Optional fromVerifiedKeyAgents: booleanOptional paginationOpts: PaginationOptsOptional signerOfferingIds: string[]Optional fromVerifiedKeyAgents: booleanOptional paginationOpts: PaginationOptsOptional keyAgentsPubKeys: string[]Optional fromVerifiedKeyAgents: booleanOptional paginationOpts: PaginationOptsOptional period: PeriodAsynchronously removes contacts by publicKey and publishes a Contacts event.
publicKeys of contacts to remove.
SmartVaultsTypes.PublishedSharedSigner - For the structure of Pub
await removeContacts('somePubKey');
await removeContacts(['somePubKey', 'otherPubKey']);
Asynchronously revokes shared signers with the given IDs.
Single or multiple shared signer IDs to be revoked ( not signer ids ).
void when the operation is successful.await
Example
await revokeMySharedSigners('some-shared-signer-id');
-Asynchronously saves a label associated with a given policy ID.
+Asynchronously saves a label associated with a given policy ID.
The method creates and publishes a Labels event.
The ID of the policy to which the label is to be associated.
The label object containing the data to be saved.
@@ -435,7 +435,7 @@await
Example
const publishedLabel = await saveLabel('some-policy-id', { data: { 'Address': 'some-address' }, text: 'some-label-text' });
-Asynchronously saves an owned signer by encrypting its properties, building a new event, +
Asynchronously saves an owned signer by encrypting its properties, building a new event,
and publishing it via NostrClient.
Parameters for the owned signer, including description, descriptor,
fingerprint, name, t.
constAsync
Throws
Will throw an error if the event publishing fails.
Example
const signer = await saveOwnedSigner({description, descriptor, fingerprint, name, t});
-Asynchronously saves a new policy and associated shared keys, then publishes the policy event.
+Asynchronously saves a new policy and associated shared keys, then publishes the policy event.
Payload containing policy details.
const
Example
const payload = {
name: 'My Policy',
description: 'Description here',
miniscript: 'miniscriptString',
nostrPublicKeys: ['key1', 'key2'],
createdAt: new Date()
};
const publishedPolicy = await savePolicy(payload);
-Asynchronously creates and publishes a 'SharedSigners' event.
+Asynchronously creates and publishes a 'SharedSigners' event.
A promise that resolves to a PublishedSharedSigner object, includes the owner's public key and shared date.
Will throw an error if the event publishing fails or if the user tries to share a signer with themselves.
const signer = await saveSharedSigner({descriptor, fingerprint}, pubKey);
Optional confirmationComponent: (() => Promise<boolean>)Sets the profile metadata and publishes a Metadata event.
+Optional confirmationComponent: (() => Promise<boolean>)Sets the profile metadata and publishes a Metadata event.
Metadata for the profile.
const
Example
await setProfile({ name: 'Alice', about: 'Learning about Smart Vaults' });
-Asynchronously initiates a spending proposal.
+Asynchronously initiates a spending proposal.
Payload for the spending proposal.
const payload = {
policy,
to_address: "abc123",
description: "A spending proposal",
amountDescriptor: 10,
feeRatePriority: 'high',
policyPath: new Map([['nodeId',[0,1,2]]]),
utxos: ["utxo1", "utxo2"],
useFrozenUtxos: false
};
const spendingProposal = await spend(payload);
Subscribes to specified kinds of events and handles them using a provided callback function.
The event kinds to subscribe to. This can either be an array or a single value.
The callback function to handle incoming events. It receives the kind of event and the associated payload.
const
Example
const kindsToSubscribe = [SmartVaultsKind.Policy, SmartVaultsKind.Proposal];
const myCallback = (kind, payload) => {
console.log(`Received event of kind ${kind} with payload:`, payload);
};
const mySubscription = subscribe(kindsToSubscribe, myCallback);
// To unsubscribe
mySubscription.disconnect();
-Asynchronously upserts contacts and publishes a Contacts event.
const
Example
const contact = new Contact({ publicKey: 'somePubKey', relay: 'some.relay.com' });
await upsertContacts(contact);
-Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Static createStatic createGenerated using TypeDoc
Static emptyStatic isGenerated using TypeDoc
Static emptyStatic isGenerated using TypeDoc
Generated using TypeDoc
Static addStatic addStatic fromStatic fromStatic fromStatic getStatic toStatic toStatic toGenerated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Optional transformerFn: ((params) => any)Generated using TypeDoc
Optional transformerFn: ((params) => any)Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
const isNip05Verified = await isNip05Verified(alice@smartvaults.app, aliciesPublicKey);
Generated using TypeDoc
Changes the fiat currency used to fetch the Bitcoin exchange rate.
+