vaults-multichain-sdk 1.1.0 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.cjs +2 -2
- package/dist/index.d.cts +214 -1
- package/dist/index.d.ts +214 -1
- package/dist/index.js +2 -2
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -801,6 +801,73 @@ interface OrgWalletItem {
|
|
|
801
801
|
interface OrgWalletsResponse {
|
|
802
802
|
wallets: OrgWalletItem[];
|
|
803
803
|
}
|
|
804
|
+
/**
|
|
805
|
+
* `GET /sdk/organization/wallets/me` — wallets assigned to the calling member
|
|
806
|
+
* within their active organization. Structurally identical to
|
|
807
|
+
* `OrgWalletsResponse` but kept distinct so a future divergence on either
|
|
808
|
+
* endpoint doesn't silently change the other.
|
|
809
|
+
*/
|
|
810
|
+
interface OrgMyWalletsResponse {
|
|
811
|
+
wallets: OrgWalletItem[];
|
|
812
|
+
}
|
|
813
|
+
/**
|
|
814
|
+
* Vault row returned by `GET /sdk/organization/vaults/me` and
|
|
815
|
+
* `GET /sdk/organization/vaults`. Flatter shape than the internal
|
|
816
|
+
* `MultisigsItem` — owners are bare addresses, address/name are nullable
|
|
817
|
+
* for undeployed vaults.
|
|
818
|
+
*/
|
|
819
|
+
interface OrgVaultItem {
|
|
820
|
+
id: string;
|
|
821
|
+
/** Chain-native address, or `null` when the vault is not yet deployed. */
|
|
822
|
+
address: string | null;
|
|
823
|
+
/** `null` when the vault is not yet deployed. */
|
|
824
|
+
name: string | null;
|
|
825
|
+
chainType: ChainType;
|
|
826
|
+
/** Numeric for EVM ("1", "137", ...), chain-specific otherwise. */
|
|
827
|
+
chainId: string;
|
|
828
|
+
/** Required signature count, serialized as a string. */
|
|
829
|
+
threshold: string;
|
|
830
|
+
isDeployed: boolean;
|
|
831
|
+
/** Owner wallet addresses. */
|
|
832
|
+
owners: string[];
|
|
833
|
+
}
|
|
834
|
+
/** Response of `GET /sdk/organization/vaults/me`. */
|
|
835
|
+
interface OrgMyVaultsResponse {
|
|
836
|
+
vaults: OrgVaultItem[];
|
|
837
|
+
}
|
|
838
|
+
/** Response of `GET /sdk/organization/vaults` (Master-only). */
|
|
839
|
+
interface OrgVaultsResponse {
|
|
840
|
+
vaults: OrgVaultItem[];
|
|
841
|
+
}
|
|
842
|
+
/** Per-chain wallet/vault quota inside an `OrgLimitGroup`. */
|
|
843
|
+
interface OrgLimitGroupChainLimit {
|
|
844
|
+
wallets: number;
|
|
845
|
+
vaults: number;
|
|
846
|
+
}
|
|
847
|
+
/**
|
|
848
|
+
* Limit-group configuration assigned to an organization. Only chains the org
|
|
849
|
+
* has a quota for appear in `limits`.
|
|
850
|
+
*/
|
|
851
|
+
interface OrgLimitGroup {
|
|
852
|
+
id: string;
|
|
853
|
+
name: string;
|
|
854
|
+
limits: Partial<Record<ChainType, OrgLimitGroupChainLimit>>;
|
|
855
|
+
}
|
|
856
|
+
/**
|
|
857
|
+
* Response of `GET /sdk/organization/limit-group`. `limitGroup` is `null`
|
|
858
|
+
* when no group is configured — this is a legitimate response, not an error.
|
|
859
|
+
*/
|
|
860
|
+
interface OrgLimitGroupEnvelopeResponse {
|
|
861
|
+
limitGroup: OrgLimitGroup | null;
|
|
862
|
+
}
|
|
863
|
+
/**
|
|
864
|
+
* Response of `GET /sdk/organization/wallets/:walletAddress/utxos/:chainType/:chain`.
|
|
865
|
+
* UTXO shape is chain-specific (BTC: `BtcUtxo`-like; ADA: `{ txHash, outputIndex, ... }`).
|
|
866
|
+
* Returned as an untyped array — cast based on `chainType` at the call site.
|
|
867
|
+
*/
|
|
868
|
+
interface OrgWalletUtxosResponse {
|
|
869
|
+
utxos: unknown[];
|
|
870
|
+
}
|
|
804
871
|
/**
|
|
805
872
|
* `GET /sdk/organization/policies` — current org security policy.
|
|
806
873
|
* Returned fields are partially optional/nullable when the corresponding
|
|
@@ -1402,6 +1469,58 @@ interface DeleteOrgAddressBookEntryInput {
|
|
|
1402
1469
|
/** UUID of the org address-book entry to remove. */
|
|
1403
1470
|
addressId: string;
|
|
1404
1471
|
}
|
|
1472
|
+
/**
|
|
1473
|
+
* Body of `POST /sdk/organization/wallets`. Mirrors personal
|
|
1474
|
+
* `/sdk/wallets/create` — pass `key` per entry to import an existing
|
|
1475
|
+
* private key, omit it to generate a new MPC-split key on the backend.
|
|
1476
|
+
*/
|
|
1477
|
+
interface CreateOrgWalletInput {
|
|
1478
|
+
wallets: Array<{
|
|
1479
|
+
chain: EChainType;
|
|
1480
|
+
key?: string;
|
|
1481
|
+
}>;
|
|
1482
|
+
}
|
|
1483
|
+
/** Path params for `GET /sdk/organization/wallets/:walletAddress`. */
|
|
1484
|
+
interface GetOrgWalletInput {
|
|
1485
|
+
walletAddress: string;
|
|
1486
|
+
}
|
|
1487
|
+
/** Body for `POST /sdk/organization/wallets/update/name`. */
|
|
1488
|
+
interface RenameOrgWalletInput {
|
|
1489
|
+
chainType: EChainType;
|
|
1490
|
+
address: string;
|
|
1491
|
+
name: string;
|
|
1492
|
+
}
|
|
1493
|
+
/** Path params for `DELETE /sdk/organization/wallets/:chainType/:address`. */
|
|
1494
|
+
interface DeleteOrgWalletInput {
|
|
1495
|
+
chainType: EChainType;
|
|
1496
|
+
address: string;
|
|
1497
|
+
}
|
|
1498
|
+
/**
|
|
1499
|
+
* Path params for
|
|
1500
|
+
* `GET /sdk/organization/wallets/:walletAddress/portfolio/:chainType/:chain`.
|
|
1501
|
+
* Note the **address-first** order — differs from the personal route shape.
|
|
1502
|
+
*/
|
|
1503
|
+
interface GetOrgWalletPortfolioInput {
|
|
1504
|
+
walletAddress: string;
|
|
1505
|
+
chainType: EChainType;
|
|
1506
|
+
/** Numeric chain id as a string ("1", "137", ...). */
|
|
1507
|
+
chain: string;
|
|
1508
|
+
}
|
|
1509
|
+
/**
|
|
1510
|
+
* Path params for
|
|
1511
|
+
* `GET /sdk/organization/wallets/:walletAddress/utxos/:chainType/:chain`.
|
|
1512
|
+
* UTXO-bearing chains only (BTC, ADA).
|
|
1513
|
+
*/
|
|
1514
|
+
interface GetOrgWalletUtxosInput {
|
|
1515
|
+
walletAddress: string;
|
|
1516
|
+
chainType: EChainType;
|
|
1517
|
+
chain: string;
|
|
1518
|
+
}
|
|
1519
|
+
/** Path params for `GET /sdk/organization/vaults/:id`. */
|
|
1520
|
+
interface GetOrgVaultByIdInput {
|
|
1521
|
+
/** Vault UUID (not address). */
|
|
1522
|
+
id: string;
|
|
1523
|
+
}
|
|
1405
1524
|
declare class AfridaxSDK {
|
|
1406
1525
|
private readonly resolvedConfig;
|
|
1407
1526
|
private readonly rpcConfig;
|
|
@@ -1653,6 +1772,100 @@ declare class AfridaxSDK {
|
|
|
1653
1772
|
* Server route: `GET /sdk/organization/wallets`.
|
|
1654
1773
|
*/
|
|
1655
1774
|
listOrgWallets(): Promise<OrgWalletsResponse>;
|
|
1775
|
+
/**
|
|
1776
|
+
* List wallets assigned to the calling member within their active
|
|
1777
|
+
* organization. Available to Master or Employee accounts.
|
|
1778
|
+
*
|
|
1779
|
+
* Server route: `GET /sdk/organization/wallets/me`.
|
|
1780
|
+
*/
|
|
1781
|
+
listMyOrgWallets(): Promise<OrgMyWalletsResponse>;
|
|
1782
|
+
/**
|
|
1783
|
+
* List active vaults in the caller's organization that include any of the
|
|
1784
|
+
* caller's assigned wallets as owners. Available to Master or Employee
|
|
1785
|
+
* accounts.
|
|
1786
|
+
*
|
|
1787
|
+
* Server route: `GET /sdk/organization/vaults/me`.
|
|
1788
|
+
*/
|
|
1789
|
+
listMyOrgVaults(): Promise<OrgMyVaultsResponse>;
|
|
1790
|
+
/**
|
|
1791
|
+
* List every active vault tagged to the caller's organization, regardless
|
|
1792
|
+
* of personal ownership. **Master-only** — Employees receive
|
|
1793
|
+
* `PermissionDeniedError`.
|
|
1794
|
+
*
|
|
1795
|
+
* Server route: `GET /sdk/organization/vaults`.
|
|
1796
|
+
*/
|
|
1797
|
+
listOrgVaults(): Promise<OrgVaultsResponse>;
|
|
1798
|
+
/**
|
|
1799
|
+
* Get a single org vault by UUID. Master sees any org vault; Employees
|
|
1800
|
+
* only see vaults whose owners include one of their assigned wallets.
|
|
1801
|
+
*
|
|
1802
|
+
* Server route: `GET /sdk/organization/vaults/:id`.
|
|
1803
|
+
*/
|
|
1804
|
+
getOrgVaultById(input: GetOrgVaultByIdInput): Promise<OrgVaultItem>;
|
|
1805
|
+
/**
|
|
1806
|
+
* Create one or more org-owned wallets. Master-only.
|
|
1807
|
+
*
|
|
1808
|
+
* Server route: `POST /sdk/organization/wallets`.
|
|
1809
|
+
*/
|
|
1810
|
+
createOrgWallet(input: CreateOrgWalletInput): Promise<CreateWalletResponse>;
|
|
1811
|
+
/**
|
|
1812
|
+
* Get a single org wallet by address. Employees only see wallets assigned
|
|
1813
|
+
* to them; Master sees any.
|
|
1814
|
+
*
|
|
1815
|
+
* Server route: `GET /sdk/organization/wallets/:walletAddress`.
|
|
1816
|
+
*/
|
|
1817
|
+
getOrgWallet(input: GetOrgWalletInput): Promise<TWallet>;
|
|
1818
|
+
/**
|
|
1819
|
+
* Rename an org wallet. Master-only.
|
|
1820
|
+
*
|
|
1821
|
+
* Server route: `POST /sdk/organization/wallets/update/name`.
|
|
1822
|
+
*/
|
|
1823
|
+
renameOrgWallet(input: RenameOrgWalletInput): Promise<WalletRenameResponse>;
|
|
1824
|
+
/**
|
|
1825
|
+
* Delete an org wallet. Master-only. Triggers MPC share cleanup
|
|
1826
|
+
* server-side.
|
|
1827
|
+
*
|
|
1828
|
+
* Server route: `DELETE /sdk/organization/wallets/:chainType/:address`.
|
|
1829
|
+
*/
|
|
1830
|
+
deleteOrgWallet(input: DeleteOrgWalletInput): Promise<DeleteResponse>;
|
|
1831
|
+
/**
|
|
1832
|
+
* Aggregate USD value across the org's wallets. Master or Employee.
|
|
1833
|
+
*
|
|
1834
|
+
* Server route: `GET /sdk/organization/wallets/total-asset-value`.
|
|
1835
|
+
*/
|
|
1836
|
+
getOrgTotalAssetValue(): Promise<TotalAssetValueResponse>;
|
|
1837
|
+
/**
|
|
1838
|
+
* Batch portfolio for org wallets. Master or Employee. Employees without
|
|
1839
|
+
* `ViewBalances` get each entry with `tokens: []`.
|
|
1840
|
+
*
|
|
1841
|
+
* Server route: `POST /sdk/organization/wallets/portfolio`.
|
|
1842
|
+
*/
|
|
1843
|
+
getOrgWalletsPortfolio(requests: PortfolioRequest[]): Promise<WalletPortfolioResponse[]>;
|
|
1844
|
+
/**
|
|
1845
|
+
* Portfolio for a single org wallet. Master or Employee (assignment-gated).
|
|
1846
|
+
*
|
|
1847
|
+
* Server route:
|
|
1848
|
+
* `GET /sdk/organization/wallets/:walletAddress/portfolio/:chainType/:chain`
|
|
1849
|
+
* — note **address-first** path order, differing from the personal route.
|
|
1850
|
+
*/
|
|
1851
|
+
getOrgWalletPortfolio(input: GetOrgWalletPortfolioInput): Promise<WalletPortfolioResponse>;
|
|
1852
|
+
/**
|
|
1853
|
+
* UTXO list for a BTC/ADA org wallet. Master or Employee
|
|
1854
|
+
* (assignment-gated). Entries are chain-specific — cast based on
|
|
1855
|
+
* `chainType`.
|
|
1856
|
+
*
|
|
1857
|
+
* Server route:
|
|
1858
|
+
* `GET /sdk/organization/wallets/:walletAddress/utxos/:chainType/:chain`.
|
|
1859
|
+
*/
|
|
1860
|
+
getOrgWalletUtxos(input: GetOrgWalletUtxosInput): Promise<OrgWalletUtxosResponse>;
|
|
1861
|
+
/**
|
|
1862
|
+
* Get the wallet/vault limit-group configured for the caller's organization,
|
|
1863
|
+
* or `{ limitGroup: null }` when none is set (legitimate response — do not
|
|
1864
|
+
* treat as an error). Available to Master or Employee accounts.
|
|
1865
|
+
*
|
|
1866
|
+
* Server route: `GET /sdk/organization/limit-group`.
|
|
1867
|
+
*/
|
|
1868
|
+
getOrgLimitGroup(): Promise<OrgLimitGroupEnvelopeResponse>;
|
|
1656
1869
|
/**
|
|
1657
1870
|
* 7.8 Read the org's current security policy. Master-only.
|
|
1658
1871
|
*
|
|
@@ -1952,4 +2165,4 @@ declare class NotFoundError extends AfridaxBaseError {
|
|
|
1952
2165
|
*/
|
|
1953
2166
|
declare function isAfridaxError(error: unknown): error is AfridaxBaseError;
|
|
1954
2167
|
|
|
1955
|
-
export { type ActivateMultisigInput, type ActivateMultisigOutput, type ActivateXrpTrustLineInput, type ActivateXrpTrustLineOutput, type AdaNativeInstruction, type AdaTokenInstruction, type AddOrgAddressResponse, type AddressBookEntry, type AddressBookEntryType, type AddressTypeResponse, AfridaxBaseError, AfridaxSDK, ApiError, type AssignOrgWalletInput, type AssignOrgWalletResponse, type ChainIdValue, ChainNotSupportedError, type ChainType, type CreateAddressBookEntryInput, type CreateMultisigInput, type CreateOrderInput, type CreateOrderOutput, type CreateOrgAddressInput, type CreateWalletInput, type CreateWalletOutput, type CreateWalletResponse, type DeleteAddressBookEntryInput, type DeleteMultisigInput, type DeleteOrderInput, type DeleteOrgAddressBookEntryInput, type DeleteResponse, type DeleteWalletInput, EAdaInstructionType, EAddressBookEntryType, EChainType, EXrpOrderType, type EstimateActivationFeeInput, type EstimateFeeInput, type EstimateOrderExecutionFeeInput, type EstimatedFee, type ExecuteOrderInput, type ExecuteOrderOutput, type ExportWalletInput, type ExportWalletOutput, type GetAddressBookEntriesInput, type GetAddressTypeInput, type GetMultisigByIdInput, type GetMultisigTxHistoryInput, type GetMultisigsInput, type GetOrderByIdInput, type GetOrdersInput, type GetOrgAuditLogsInput, type GetPaginatedMultisigsInput, type GetPortfolioInput, type GetSupportedTokensInput, type GetWalletHistoryInput, type GetWalletInput, type GetWalletsInput, type GetXrpAccountReserveInput, type GetXrpTrustLinesInput, type GroupedMultisigResponseDTO, type HistoryResponse, type ImportWalletInput, InsufficientBalanceError, InvalidInputError, type InviteOrgMemberInput, type InviteOrgMemberResponse, KeyMismatchError, type ListOrgMemberWalletsInput, MEMO_MAX_LENGTH, MEMO_SUPPORTED_CHAINS, type MemoValidationResult, type MultisigBaseDTO, MultisigStatus, type MultisigsItem, NetworkError, NotFoundError, ORG_POLICY_CODES, type Order, type OrderInstruction, type OrderMethodType, type OrderParamsAda, type OrderParamsXrp, type OrderSigner, OrderStatus, type OrgAddressBookEntry, type OrgAddressRecipientType, type OrgAddressWalletType, type OrgAuditEventType, type OrgAuditLogItem, type OrgAuditLogsResponse, type OrgMemberKycStatus, type OrgMemberRole, type OrgMemberStatus, type OrgPolicy, type OrgPolicyCode, OrgPolicyRejectedError, type OrgTeamDirectoryResponse, type OrgTeamMember, type OrgWalletItem, type OrgWalletsResponse, type PaginatedMultisigsWithTokensResponse, type PaginatedOrdersResponse, type PaginatedWalletsResponse, PermissionDeniedError, type RejectOrderInput, type RemoveOrgMemberInput, type SDKConfig, type SendTransactionInput, type SendTransactionOutput, type SignOrderInput, type SignOrderOutput, type SingleWalletDetailsResponse, StatusFilterEnum, type SupportedTokensResponse, type TAdaCommandInstruction, type TWallet, type TXrpCommandInstruction, type TokenInfo, type TotalAssetValueResponse, TransactionEstimatingType, type TransactionHistoryItem, type TxHistoryCombinedResponse, type UnassignOrgWalletInput, UnauthorizedError, type UpdateAddressBookEntryInput, type UpdateMultisigNameInput, type UpdateOrgAddressBookEntryInput, type UpdateOrgAddressInput, type UpdateOrgPolicyInput, type UpdateWalletNameInput, type WalletPortfolioResponse, type WalletRenameResponse, XRP_MAX_DESTINATION_TAG, type XrpAccountReserveInfo, type XrpAssetInstruction, type XrpChangeThresholdInstruction, type XrpNativeInstruction, type XrpRemoveTrustLineInstruction, type XrpSetTrustLineInstruction, type TrustLineInfo as XrpTrustLineInfo, type XrpUpdateOwnerThresholdInstruction, type XrpUpdateOwnersInstruction, AfridaxSDK as default, getBtcChainType, getMemoPlaceholder, isAfridaxError, isMemoSupported, validateMemo };
|
|
2168
|
+
export { type ActivateMultisigInput, type ActivateMultisigOutput, type ActivateXrpTrustLineInput, type ActivateXrpTrustLineOutput, type AdaNativeInstruction, type AdaTokenInstruction, type AddOrgAddressResponse, type AddressBookEntry, type AddressBookEntryType, type AddressTypeResponse, AfridaxBaseError, AfridaxSDK, ApiError, type AssignOrgWalletInput, type AssignOrgWalletResponse, type ChainIdValue, ChainNotSupportedError, type ChainType, type CreateAddressBookEntryInput, type CreateMultisigInput, type CreateOrderInput, type CreateOrderOutput, type CreateOrgAddressInput, type CreateOrgWalletInput, type CreateWalletInput, type CreateWalletOutput, type CreateWalletResponse, type DeleteAddressBookEntryInput, type DeleteMultisigInput, type DeleteOrderInput, type DeleteOrgAddressBookEntryInput, type DeleteOrgWalletInput, type DeleteResponse, type DeleteWalletInput, EAdaInstructionType, EAddressBookEntryType, EChainType, EXrpOrderType, type EstimateActivationFeeInput, type EstimateFeeInput, type EstimateOrderExecutionFeeInput, type EstimatedFee, type ExecuteOrderInput, type ExecuteOrderOutput, type ExportWalletInput, type ExportWalletOutput, type GetAddressBookEntriesInput, type GetAddressTypeInput, type GetMultisigByIdInput, type GetMultisigTxHistoryInput, type GetMultisigsInput, type GetOrderByIdInput, type GetOrdersInput, type GetOrgAuditLogsInput, type GetOrgVaultByIdInput, type GetOrgWalletInput, type GetOrgWalletPortfolioInput, type GetOrgWalletUtxosInput, type GetPaginatedMultisigsInput, type GetPortfolioInput, type GetSupportedTokensInput, type GetWalletHistoryInput, type GetWalletInput, type GetWalletsInput, type GetXrpAccountReserveInput, type GetXrpTrustLinesInput, type GroupedMultisigResponseDTO, type HistoryResponse, type ImportWalletInput, InsufficientBalanceError, InvalidInputError, type InviteOrgMemberInput, type InviteOrgMemberResponse, KeyMismatchError, type ListOrgMemberWalletsInput, MEMO_MAX_LENGTH, MEMO_SUPPORTED_CHAINS, type MemoValidationResult, type MultisigBaseDTO, MultisigStatus, type MultisigsItem, NetworkError, NotFoundError, ORG_POLICY_CODES, type Order, type OrderInstruction, type OrderMethodType, type OrderParamsAda, type OrderParamsXrp, type OrderSigner, OrderStatus, type OrgAddressBookEntry, type OrgAddressRecipientType, type OrgAddressWalletType, type OrgAuditEventType, type OrgAuditLogItem, type OrgAuditLogsResponse, type OrgLimitGroup, type OrgLimitGroupChainLimit, type OrgLimitGroupEnvelopeResponse, type OrgMemberKycStatus, type OrgMemberRole, type OrgMemberStatus, type OrgMyVaultsResponse, type OrgMyWalletsResponse, type OrgPolicy, type OrgPolicyCode, OrgPolicyRejectedError, type OrgTeamDirectoryResponse, type OrgTeamMember, type OrgVaultItem, type OrgVaultsResponse, type OrgWalletItem, type OrgWalletUtxosResponse, type OrgWalletsResponse, type PaginatedMultisigsWithTokensResponse, type PaginatedOrdersResponse, type PaginatedWalletsResponse, PermissionDeniedError, type RejectOrderInput, type RemoveOrgMemberInput, type RenameOrgWalletInput, type SDKConfig, type SendTransactionInput, type SendTransactionOutput, type SignOrderInput, type SignOrderOutput, type SingleWalletDetailsResponse, StatusFilterEnum, type SupportedTokensResponse, type TAdaCommandInstruction, type TWallet, type TXrpCommandInstruction, type TokenInfo, type TotalAssetValueResponse, TransactionEstimatingType, type TransactionHistoryItem, type TxHistoryCombinedResponse, type UnassignOrgWalletInput, UnauthorizedError, type UpdateAddressBookEntryInput, type UpdateMultisigNameInput, type UpdateOrgAddressBookEntryInput, type UpdateOrgAddressInput, type UpdateOrgPolicyInput, type UpdateWalletNameInput, type WalletPortfolioResponse, type WalletRenameResponse, XRP_MAX_DESTINATION_TAG, type XrpAccountReserveInfo, type XrpAssetInstruction, type XrpChangeThresholdInstruction, type XrpNativeInstruction, type XrpRemoveTrustLineInstruction, type XrpSetTrustLineInstruction, type TrustLineInfo as XrpTrustLineInfo, type XrpUpdateOwnerThresholdInstruction, type XrpUpdateOwnersInstruction, AfridaxSDK as default, getBtcChainType, getMemoPlaceholder, isAfridaxError, isMemoSupported, validateMemo };
|
package/dist/index.d.ts
CHANGED
|
@@ -801,6 +801,73 @@ interface OrgWalletItem {
|
|
|
801
801
|
interface OrgWalletsResponse {
|
|
802
802
|
wallets: OrgWalletItem[];
|
|
803
803
|
}
|
|
804
|
+
/**
|
|
805
|
+
* `GET /sdk/organization/wallets/me` — wallets assigned to the calling member
|
|
806
|
+
* within their active organization. Structurally identical to
|
|
807
|
+
* `OrgWalletsResponse` but kept distinct so a future divergence on either
|
|
808
|
+
* endpoint doesn't silently change the other.
|
|
809
|
+
*/
|
|
810
|
+
interface OrgMyWalletsResponse {
|
|
811
|
+
wallets: OrgWalletItem[];
|
|
812
|
+
}
|
|
813
|
+
/**
|
|
814
|
+
* Vault row returned by `GET /sdk/organization/vaults/me` and
|
|
815
|
+
* `GET /sdk/organization/vaults`. Flatter shape than the internal
|
|
816
|
+
* `MultisigsItem` — owners are bare addresses, address/name are nullable
|
|
817
|
+
* for undeployed vaults.
|
|
818
|
+
*/
|
|
819
|
+
interface OrgVaultItem {
|
|
820
|
+
id: string;
|
|
821
|
+
/** Chain-native address, or `null` when the vault is not yet deployed. */
|
|
822
|
+
address: string | null;
|
|
823
|
+
/** `null` when the vault is not yet deployed. */
|
|
824
|
+
name: string | null;
|
|
825
|
+
chainType: ChainType;
|
|
826
|
+
/** Numeric for EVM ("1", "137", ...), chain-specific otherwise. */
|
|
827
|
+
chainId: string;
|
|
828
|
+
/** Required signature count, serialized as a string. */
|
|
829
|
+
threshold: string;
|
|
830
|
+
isDeployed: boolean;
|
|
831
|
+
/** Owner wallet addresses. */
|
|
832
|
+
owners: string[];
|
|
833
|
+
}
|
|
834
|
+
/** Response of `GET /sdk/organization/vaults/me`. */
|
|
835
|
+
interface OrgMyVaultsResponse {
|
|
836
|
+
vaults: OrgVaultItem[];
|
|
837
|
+
}
|
|
838
|
+
/** Response of `GET /sdk/organization/vaults` (Master-only). */
|
|
839
|
+
interface OrgVaultsResponse {
|
|
840
|
+
vaults: OrgVaultItem[];
|
|
841
|
+
}
|
|
842
|
+
/** Per-chain wallet/vault quota inside an `OrgLimitGroup`. */
|
|
843
|
+
interface OrgLimitGroupChainLimit {
|
|
844
|
+
wallets: number;
|
|
845
|
+
vaults: number;
|
|
846
|
+
}
|
|
847
|
+
/**
|
|
848
|
+
* Limit-group configuration assigned to an organization. Only chains the org
|
|
849
|
+
* has a quota for appear in `limits`.
|
|
850
|
+
*/
|
|
851
|
+
interface OrgLimitGroup {
|
|
852
|
+
id: string;
|
|
853
|
+
name: string;
|
|
854
|
+
limits: Partial<Record<ChainType, OrgLimitGroupChainLimit>>;
|
|
855
|
+
}
|
|
856
|
+
/**
|
|
857
|
+
* Response of `GET /sdk/organization/limit-group`. `limitGroup` is `null`
|
|
858
|
+
* when no group is configured — this is a legitimate response, not an error.
|
|
859
|
+
*/
|
|
860
|
+
interface OrgLimitGroupEnvelopeResponse {
|
|
861
|
+
limitGroup: OrgLimitGroup | null;
|
|
862
|
+
}
|
|
863
|
+
/**
|
|
864
|
+
* Response of `GET /sdk/organization/wallets/:walletAddress/utxos/:chainType/:chain`.
|
|
865
|
+
* UTXO shape is chain-specific (BTC: `BtcUtxo`-like; ADA: `{ txHash, outputIndex, ... }`).
|
|
866
|
+
* Returned as an untyped array — cast based on `chainType` at the call site.
|
|
867
|
+
*/
|
|
868
|
+
interface OrgWalletUtxosResponse {
|
|
869
|
+
utxos: unknown[];
|
|
870
|
+
}
|
|
804
871
|
/**
|
|
805
872
|
* `GET /sdk/organization/policies` — current org security policy.
|
|
806
873
|
* Returned fields are partially optional/nullable when the corresponding
|
|
@@ -1402,6 +1469,58 @@ interface DeleteOrgAddressBookEntryInput {
|
|
|
1402
1469
|
/** UUID of the org address-book entry to remove. */
|
|
1403
1470
|
addressId: string;
|
|
1404
1471
|
}
|
|
1472
|
+
/**
|
|
1473
|
+
* Body of `POST /sdk/organization/wallets`. Mirrors personal
|
|
1474
|
+
* `/sdk/wallets/create` — pass `key` per entry to import an existing
|
|
1475
|
+
* private key, omit it to generate a new MPC-split key on the backend.
|
|
1476
|
+
*/
|
|
1477
|
+
interface CreateOrgWalletInput {
|
|
1478
|
+
wallets: Array<{
|
|
1479
|
+
chain: EChainType;
|
|
1480
|
+
key?: string;
|
|
1481
|
+
}>;
|
|
1482
|
+
}
|
|
1483
|
+
/** Path params for `GET /sdk/organization/wallets/:walletAddress`. */
|
|
1484
|
+
interface GetOrgWalletInput {
|
|
1485
|
+
walletAddress: string;
|
|
1486
|
+
}
|
|
1487
|
+
/** Body for `POST /sdk/organization/wallets/update/name`. */
|
|
1488
|
+
interface RenameOrgWalletInput {
|
|
1489
|
+
chainType: EChainType;
|
|
1490
|
+
address: string;
|
|
1491
|
+
name: string;
|
|
1492
|
+
}
|
|
1493
|
+
/** Path params for `DELETE /sdk/organization/wallets/:chainType/:address`. */
|
|
1494
|
+
interface DeleteOrgWalletInput {
|
|
1495
|
+
chainType: EChainType;
|
|
1496
|
+
address: string;
|
|
1497
|
+
}
|
|
1498
|
+
/**
|
|
1499
|
+
* Path params for
|
|
1500
|
+
* `GET /sdk/organization/wallets/:walletAddress/portfolio/:chainType/:chain`.
|
|
1501
|
+
* Note the **address-first** order — differs from the personal route shape.
|
|
1502
|
+
*/
|
|
1503
|
+
interface GetOrgWalletPortfolioInput {
|
|
1504
|
+
walletAddress: string;
|
|
1505
|
+
chainType: EChainType;
|
|
1506
|
+
/** Numeric chain id as a string ("1", "137", ...). */
|
|
1507
|
+
chain: string;
|
|
1508
|
+
}
|
|
1509
|
+
/**
|
|
1510
|
+
* Path params for
|
|
1511
|
+
* `GET /sdk/organization/wallets/:walletAddress/utxos/:chainType/:chain`.
|
|
1512
|
+
* UTXO-bearing chains only (BTC, ADA).
|
|
1513
|
+
*/
|
|
1514
|
+
interface GetOrgWalletUtxosInput {
|
|
1515
|
+
walletAddress: string;
|
|
1516
|
+
chainType: EChainType;
|
|
1517
|
+
chain: string;
|
|
1518
|
+
}
|
|
1519
|
+
/** Path params for `GET /sdk/organization/vaults/:id`. */
|
|
1520
|
+
interface GetOrgVaultByIdInput {
|
|
1521
|
+
/** Vault UUID (not address). */
|
|
1522
|
+
id: string;
|
|
1523
|
+
}
|
|
1405
1524
|
declare class AfridaxSDK {
|
|
1406
1525
|
private readonly resolvedConfig;
|
|
1407
1526
|
private readonly rpcConfig;
|
|
@@ -1653,6 +1772,100 @@ declare class AfridaxSDK {
|
|
|
1653
1772
|
* Server route: `GET /sdk/organization/wallets`.
|
|
1654
1773
|
*/
|
|
1655
1774
|
listOrgWallets(): Promise<OrgWalletsResponse>;
|
|
1775
|
+
/**
|
|
1776
|
+
* List wallets assigned to the calling member within their active
|
|
1777
|
+
* organization. Available to Master or Employee accounts.
|
|
1778
|
+
*
|
|
1779
|
+
* Server route: `GET /sdk/organization/wallets/me`.
|
|
1780
|
+
*/
|
|
1781
|
+
listMyOrgWallets(): Promise<OrgMyWalletsResponse>;
|
|
1782
|
+
/**
|
|
1783
|
+
* List active vaults in the caller's organization that include any of the
|
|
1784
|
+
* caller's assigned wallets as owners. Available to Master or Employee
|
|
1785
|
+
* accounts.
|
|
1786
|
+
*
|
|
1787
|
+
* Server route: `GET /sdk/organization/vaults/me`.
|
|
1788
|
+
*/
|
|
1789
|
+
listMyOrgVaults(): Promise<OrgMyVaultsResponse>;
|
|
1790
|
+
/**
|
|
1791
|
+
* List every active vault tagged to the caller's organization, regardless
|
|
1792
|
+
* of personal ownership. **Master-only** — Employees receive
|
|
1793
|
+
* `PermissionDeniedError`.
|
|
1794
|
+
*
|
|
1795
|
+
* Server route: `GET /sdk/organization/vaults`.
|
|
1796
|
+
*/
|
|
1797
|
+
listOrgVaults(): Promise<OrgVaultsResponse>;
|
|
1798
|
+
/**
|
|
1799
|
+
* Get a single org vault by UUID. Master sees any org vault; Employees
|
|
1800
|
+
* only see vaults whose owners include one of their assigned wallets.
|
|
1801
|
+
*
|
|
1802
|
+
* Server route: `GET /sdk/organization/vaults/:id`.
|
|
1803
|
+
*/
|
|
1804
|
+
getOrgVaultById(input: GetOrgVaultByIdInput): Promise<OrgVaultItem>;
|
|
1805
|
+
/**
|
|
1806
|
+
* Create one or more org-owned wallets. Master-only.
|
|
1807
|
+
*
|
|
1808
|
+
* Server route: `POST /sdk/organization/wallets`.
|
|
1809
|
+
*/
|
|
1810
|
+
createOrgWallet(input: CreateOrgWalletInput): Promise<CreateWalletResponse>;
|
|
1811
|
+
/**
|
|
1812
|
+
* Get a single org wallet by address. Employees only see wallets assigned
|
|
1813
|
+
* to them; Master sees any.
|
|
1814
|
+
*
|
|
1815
|
+
* Server route: `GET /sdk/organization/wallets/:walletAddress`.
|
|
1816
|
+
*/
|
|
1817
|
+
getOrgWallet(input: GetOrgWalletInput): Promise<TWallet>;
|
|
1818
|
+
/**
|
|
1819
|
+
* Rename an org wallet. Master-only.
|
|
1820
|
+
*
|
|
1821
|
+
* Server route: `POST /sdk/organization/wallets/update/name`.
|
|
1822
|
+
*/
|
|
1823
|
+
renameOrgWallet(input: RenameOrgWalletInput): Promise<WalletRenameResponse>;
|
|
1824
|
+
/**
|
|
1825
|
+
* Delete an org wallet. Master-only. Triggers MPC share cleanup
|
|
1826
|
+
* server-side.
|
|
1827
|
+
*
|
|
1828
|
+
* Server route: `DELETE /sdk/organization/wallets/:chainType/:address`.
|
|
1829
|
+
*/
|
|
1830
|
+
deleteOrgWallet(input: DeleteOrgWalletInput): Promise<DeleteResponse>;
|
|
1831
|
+
/**
|
|
1832
|
+
* Aggregate USD value across the org's wallets. Master or Employee.
|
|
1833
|
+
*
|
|
1834
|
+
* Server route: `GET /sdk/organization/wallets/total-asset-value`.
|
|
1835
|
+
*/
|
|
1836
|
+
getOrgTotalAssetValue(): Promise<TotalAssetValueResponse>;
|
|
1837
|
+
/**
|
|
1838
|
+
* Batch portfolio for org wallets. Master or Employee. Employees without
|
|
1839
|
+
* `ViewBalances` get each entry with `tokens: []`.
|
|
1840
|
+
*
|
|
1841
|
+
* Server route: `POST /sdk/organization/wallets/portfolio`.
|
|
1842
|
+
*/
|
|
1843
|
+
getOrgWalletsPortfolio(requests: PortfolioRequest[]): Promise<WalletPortfolioResponse[]>;
|
|
1844
|
+
/**
|
|
1845
|
+
* Portfolio for a single org wallet. Master or Employee (assignment-gated).
|
|
1846
|
+
*
|
|
1847
|
+
* Server route:
|
|
1848
|
+
* `GET /sdk/organization/wallets/:walletAddress/portfolio/:chainType/:chain`
|
|
1849
|
+
* — note **address-first** path order, differing from the personal route.
|
|
1850
|
+
*/
|
|
1851
|
+
getOrgWalletPortfolio(input: GetOrgWalletPortfolioInput): Promise<WalletPortfolioResponse>;
|
|
1852
|
+
/**
|
|
1853
|
+
* UTXO list for a BTC/ADA org wallet. Master or Employee
|
|
1854
|
+
* (assignment-gated). Entries are chain-specific — cast based on
|
|
1855
|
+
* `chainType`.
|
|
1856
|
+
*
|
|
1857
|
+
* Server route:
|
|
1858
|
+
* `GET /sdk/organization/wallets/:walletAddress/utxos/:chainType/:chain`.
|
|
1859
|
+
*/
|
|
1860
|
+
getOrgWalletUtxos(input: GetOrgWalletUtxosInput): Promise<OrgWalletUtxosResponse>;
|
|
1861
|
+
/**
|
|
1862
|
+
* Get the wallet/vault limit-group configured for the caller's organization,
|
|
1863
|
+
* or `{ limitGroup: null }` when none is set (legitimate response — do not
|
|
1864
|
+
* treat as an error). Available to Master or Employee accounts.
|
|
1865
|
+
*
|
|
1866
|
+
* Server route: `GET /sdk/organization/limit-group`.
|
|
1867
|
+
*/
|
|
1868
|
+
getOrgLimitGroup(): Promise<OrgLimitGroupEnvelopeResponse>;
|
|
1656
1869
|
/**
|
|
1657
1870
|
* 7.8 Read the org's current security policy. Master-only.
|
|
1658
1871
|
*
|
|
@@ -1952,4 +2165,4 @@ declare class NotFoundError extends AfridaxBaseError {
|
|
|
1952
2165
|
*/
|
|
1953
2166
|
declare function isAfridaxError(error: unknown): error is AfridaxBaseError;
|
|
1954
2167
|
|
|
1955
|
-
export { type ActivateMultisigInput, type ActivateMultisigOutput, type ActivateXrpTrustLineInput, type ActivateXrpTrustLineOutput, type AdaNativeInstruction, type AdaTokenInstruction, type AddOrgAddressResponse, type AddressBookEntry, type AddressBookEntryType, type AddressTypeResponse, AfridaxBaseError, AfridaxSDK, ApiError, type AssignOrgWalletInput, type AssignOrgWalletResponse, type ChainIdValue, ChainNotSupportedError, type ChainType, type CreateAddressBookEntryInput, type CreateMultisigInput, type CreateOrderInput, type CreateOrderOutput, type CreateOrgAddressInput, type CreateWalletInput, type CreateWalletOutput, type CreateWalletResponse, type DeleteAddressBookEntryInput, type DeleteMultisigInput, type DeleteOrderInput, type DeleteOrgAddressBookEntryInput, type DeleteResponse, type DeleteWalletInput, EAdaInstructionType, EAddressBookEntryType, EChainType, EXrpOrderType, type EstimateActivationFeeInput, type EstimateFeeInput, type EstimateOrderExecutionFeeInput, type EstimatedFee, type ExecuteOrderInput, type ExecuteOrderOutput, type ExportWalletInput, type ExportWalletOutput, type GetAddressBookEntriesInput, type GetAddressTypeInput, type GetMultisigByIdInput, type GetMultisigTxHistoryInput, type GetMultisigsInput, type GetOrderByIdInput, type GetOrdersInput, type GetOrgAuditLogsInput, type GetPaginatedMultisigsInput, type GetPortfolioInput, type GetSupportedTokensInput, type GetWalletHistoryInput, type GetWalletInput, type GetWalletsInput, type GetXrpAccountReserveInput, type GetXrpTrustLinesInput, type GroupedMultisigResponseDTO, type HistoryResponse, type ImportWalletInput, InsufficientBalanceError, InvalidInputError, type InviteOrgMemberInput, type InviteOrgMemberResponse, KeyMismatchError, type ListOrgMemberWalletsInput, MEMO_MAX_LENGTH, MEMO_SUPPORTED_CHAINS, type MemoValidationResult, type MultisigBaseDTO, MultisigStatus, type MultisigsItem, NetworkError, NotFoundError, ORG_POLICY_CODES, type Order, type OrderInstruction, type OrderMethodType, type OrderParamsAda, type OrderParamsXrp, type OrderSigner, OrderStatus, type OrgAddressBookEntry, type OrgAddressRecipientType, type OrgAddressWalletType, type OrgAuditEventType, type OrgAuditLogItem, type OrgAuditLogsResponse, type OrgMemberKycStatus, type OrgMemberRole, type OrgMemberStatus, type OrgPolicy, type OrgPolicyCode, OrgPolicyRejectedError, type OrgTeamDirectoryResponse, type OrgTeamMember, type OrgWalletItem, type OrgWalletsResponse, type PaginatedMultisigsWithTokensResponse, type PaginatedOrdersResponse, type PaginatedWalletsResponse, PermissionDeniedError, type RejectOrderInput, type RemoveOrgMemberInput, type SDKConfig, type SendTransactionInput, type SendTransactionOutput, type SignOrderInput, type SignOrderOutput, type SingleWalletDetailsResponse, StatusFilterEnum, type SupportedTokensResponse, type TAdaCommandInstruction, type TWallet, type TXrpCommandInstruction, type TokenInfo, type TotalAssetValueResponse, TransactionEstimatingType, type TransactionHistoryItem, type TxHistoryCombinedResponse, type UnassignOrgWalletInput, UnauthorizedError, type UpdateAddressBookEntryInput, type UpdateMultisigNameInput, type UpdateOrgAddressBookEntryInput, type UpdateOrgAddressInput, type UpdateOrgPolicyInput, type UpdateWalletNameInput, type WalletPortfolioResponse, type WalletRenameResponse, XRP_MAX_DESTINATION_TAG, type XrpAccountReserveInfo, type XrpAssetInstruction, type XrpChangeThresholdInstruction, type XrpNativeInstruction, type XrpRemoveTrustLineInstruction, type XrpSetTrustLineInstruction, type TrustLineInfo as XrpTrustLineInfo, type XrpUpdateOwnerThresholdInstruction, type XrpUpdateOwnersInstruction, AfridaxSDK as default, getBtcChainType, getMemoPlaceholder, isAfridaxError, isMemoSupported, validateMemo };
|
|
2168
|
+
export { type ActivateMultisigInput, type ActivateMultisigOutput, type ActivateXrpTrustLineInput, type ActivateXrpTrustLineOutput, type AdaNativeInstruction, type AdaTokenInstruction, type AddOrgAddressResponse, type AddressBookEntry, type AddressBookEntryType, type AddressTypeResponse, AfridaxBaseError, AfridaxSDK, ApiError, type AssignOrgWalletInput, type AssignOrgWalletResponse, type ChainIdValue, ChainNotSupportedError, type ChainType, type CreateAddressBookEntryInput, type CreateMultisigInput, type CreateOrderInput, type CreateOrderOutput, type CreateOrgAddressInput, type CreateOrgWalletInput, type CreateWalletInput, type CreateWalletOutput, type CreateWalletResponse, type DeleteAddressBookEntryInput, type DeleteMultisigInput, type DeleteOrderInput, type DeleteOrgAddressBookEntryInput, type DeleteOrgWalletInput, type DeleteResponse, type DeleteWalletInput, EAdaInstructionType, EAddressBookEntryType, EChainType, EXrpOrderType, type EstimateActivationFeeInput, type EstimateFeeInput, type EstimateOrderExecutionFeeInput, type EstimatedFee, type ExecuteOrderInput, type ExecuteOrderOutput, type ExportWalletInput, type ExportWalletOutput, type GetAddressBookEntriesInput, type GetAddressTypeInput, type GetMultisigByIdInput, type GetMultisigTxHistoryInput, type GetMultisigsInput, type GetOrderByIdInput, type GetOrdersInput, type GetOrgAuditLogsInput, type GetOrgVaultByIdInput, type GetOrgWalletInput, type GetOrgWalletPortfolioInput, type GetOrgWalletUtxosInput, type GetPaginatedMultisigsInput, type GetPortfolioInput, type GetSupportedTokensInput, type GetWalletHistoryInput, type GetWalletInput, type GetWalletsInput, type GetXrpAccountReserveInput, type GetXrpTrustLinesInput, type GroupedMultisigResponseDTO, type HistoryResponse, type ImportWalletInput, InsufficientBalanceError, InvalidInputError, type InviteOrgMemberInput, type InviteOrgMemberResponse, KeyMismatchError, type ListOrgMemberWalletsInput, MEMO_MAX_LENGTH, MEMO_SUPPORTED_CHAINS, type MemoValidationResult, type MultisigBaseDTO, MultisigStatus, type MultisigsItem, NetworkError, NotFoundError, ORG_POLICY_CODES, type Order, type OrderInstruction, type OrderMethodType, type OrderParamsAda, type OrderParamsXrp, type OrderSigner, OrderStatus, type OrgAddressBookEntry, type OrgAddressRecipientType, type OrgAddressWalletType, type OrgAuditEventType, type OrgAuditLogItem, type OrgAuditLogsResponse, type OrgLimitGroup, type OrgLimitGroupChainLimit, type OrgLimitGroupEnvelopeResponse, type OrgMemberKycStatus, type OrgMemberRole, type OrgMemberStatus, type OrgMyVaultsResponse, type OrgMyWalletsResponse, type OrgPolicy, type OrgPolicyCode, OrgPolicyRejectedError, type OrgTeamDirectoryResponse, type OrgTeamMember, type OrgVaultItem, type OrgVaultsResponse, type OrgWalletItem, type OrgWalletUtxosResponse, type OrgWalletsResponse, type PaginatedMultisigsWithTokensResponse, type PaginatedOrdersResponse, type PaginatedWalletsResponse, PermissionDeniedError, type RejectOrderInput, type RemoveOrgMemberInput, type RenameOrgWalletInput, type SDKConfig, type SendTransactionInput, type SendTransactionOutput, type SignOrderInput, type SignOrderOutput, type SingleWalletDetailsResponse, StatusFilterEnum, type SupportedTokensResponse, type TAdaCommandInstruction, type TWallet, type TXrpCommandInstruction, type TokenInfo, type TotalAssetValueResponse, TransactionEstimatingType, type TransactionHistoryItem, type TxHistoryCombinedResponse, type UnassignOrgWalletInput, UnauthorizedError, type UpdateAddressBookEntryInput, type UpdateMultisigNameInput, type UpdateOrgAddressBookEntryInput, type UpdateOrgAddressInput, type UpdateOrgPolicyInput, type UpdateWalletNameInput, type WalletPortfolioResponse, type WalletRenameResponse, XRP_MAX_DESTINATION_TAG, type XrpAccountReserveInfo, type XrpAssetInstruction, type XrpChangeThresholdInstruction, type XrpNativeInstruction, type XrpRemoveTrustLineInstruction, type XrpSetTrustLineInstruction, type TrustLineInfo as XrpTrustLineInfo, type XrpUpdateOwnerThresholdInstruction, type XrpUpdateOwnersInstruction, AfridaxSDK as default, getBtcChainType, getMemoPlaceholder, isAfridaxError, isMemoSupported, validateMemo };
|