@safe-global/api-kit 1.0.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2021-2023 Safe Ecosystem Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,311 @@
+# Safe API Kit
+
+[![NPM Version](https://badge.fury.io/js/%40safe-global%2Fapi-kit.svg)](https://badge.fury.io/js/%40safe-global%2Fapi-kit)
+[![GitHub Release](https://img.shields.io/github/release/safe-global/safe-core-sdk.svg?style=flat)](https://github.com/safe-global/safe-core-sdk/releases)
+[![GitHub](https://img.shields.io/github/license/safe-global/safe-core-sdk)](https://github.com/safe-global/safe-core-sdk/blob/main/LICENSE.md)
+
+Software development kit that facilitates the interaction with the [Safe Transaction Service API](https://github.com/safe-global/safe-transaction-service).
+
+## Table of contents
+
+- [Installation](#installation)
+- [Build](#build)
+- [Initialization](#initialization)
+- [API Reference](#api-reference)
+- [License](#license)
+- [Contributors](#contributors)
+
+## <a name="installation">Installation</a>
+
+Install the package with yarn or npm:
+
+```bash
+yarn install
+npm install
+```
+
+## <a name="build">Build</a>
+
+Build the package with yarn or npm:
+
+```bash
+yarn build
+npm build
+```
+
+## <a name="initialization">Initialization</a>
+
+### Instantiate an EthAdapter
+
+First of all, we need to create an `EthAdapter`, which contains all the required utilities for the SDKs to interact with the blockchain. It acts as a wrapper for [web3.js](https://web3js.readthedocs.io/) or [ethers.js](https://docs.ethers.io/v5/) Ethereum libraries.
+
+Depending on the library used by the Dapp, there are two options:
+
+- [Create an `EthersAdapter` instance](https://github.com/safe-global/safe-core-sdk/tree/main/packages/protocol-kit/src/adapters/ethers)
+- [Create a `Web3Adapter` instance](https://github.com/safe-global/safe-core-sdk/tree/main/packages/protocol-kit/src/adapters/web3)
+
+Once the instance of `EthersAdapter` or `Web3Adapter` is created, it can be used in the SDK initialization.
+
+### Initialize the SafeApiKit
+
+```js
+import SafeApiKit from '@safe-global/api-kit'
+
+const safeService = new SafeApiKit({
+  txServiceUrl: 'https://safe-transaction-mainnet.safe.global',
+  ethAdapter
+})
+```
+
+## <a name="api-reference">API Reference</a>
+
+### getServiceInfo
+
+Returns the information and configuration of the service.
+
+```js
+const serviceInfo: SafeServiceInfoResponse = await safeService.getServiceInfo()
+```
+
+### getServiceMasterCopiesInfo
+
+Returns the list of Safe master copies.
+
+```js
+const masterCopies: MasterCopyResponse = await safeService.getServiceMasterCopiesInfo()
+```
+
+### decodeData
+
+Decodes the specified Safe transaction data.
+
+```js
+const decodedData = await safeService.decodeData(data)
+```
+
+### getSafesByOwner
+
+Returns the list of Safes where the address provided is an owner.
+
+```js
+const safes: OwnerResponse = await safeService.getSafesByOwner(ownerAddress)
+```
+
+### getSafesByModule
+
+Returns the list of Safes where the module address provided is enabled.
+
+```js
+const safes: ModulesResponse = await getSafesByModule(moduleAddress)
+```
+
+### getTransaction
+
+Returns all the information of a Safe transaction.
+
+```js
+const tx: SafeMultisigTransactionResponse = await safeService.getTransaction(safeTxHash)
+```
+
+### getTransactionConfirmations
+
+Returns the list of confirmations for a given a Safe transaction.
+
+```js
+const confirmations: SafeMultisigConfirmationListResponse =
+  await safeService.getTransactionConfirmations(safeTxHash)
+```
+
+### confirmTransaction
+
+Adds a confirmation for a Safe transaction.
+
+```js
+const signature: SignatureResponse = await safeService.confirmTransaction(safeTxHash, signature)
+```
+
+### getSafeInfo
+
+Returns the information and configuration of the provided Safe address.
+
+```js
+const safeInfo: SafeInfoResponse = await safeService.getSafeInfo(safeAddress)
+```
+
+### getSafeDelegates
+
+Returns the list of delegates for a given Safe address.
+
+```js
+const delegateConfig: GetSafeDelegateProps = {
+  safeAddress, // Optional
+  delegateAddress, // Optional
+  delegatorAddress, // Optional
+  label, // Optional
+  limit, // Optional
+  offset // Optional
+}
+const delegates: SafeDelegateListResponse = await safeService.getSafeDelegates(delegateConfig)
+```
+
+### addSafeDelegate
+
+Adds a new delegate for a given Safe address.
+
+```js
+const delegateConfig: AddSafeDelegateProps = {
+  safeAddress, // Optional
+  delegateAddress,
+  delegatorAddress,
+  label,
+  signer
+}
+await safeService.addSafeDelegate(delegateConfig)
+```
+
+### removeSafeDelegate
+
+Removes a delegate for a given Safe address.
+
+```js
+const delegateConfig: DeleteSafeDelegateProps = {
+  delegateAddress,
+  delegatorAddress,
+  signer
+}
+await safeService.removeSafeDelegate(delegateConfig)
+```
+
+### getSafeCreationInfo
+
+Returns the creation information of a Safe.
+
+```js
+const safeCreationInfo: SafeCreationInfoResponse = await safeService.getSafeCreationInfo(
+  safeAddress
+)
+```
+
+### estimateSafeTransaction
+
+Estimates the safeTxGas for a given Safe multi-signature transaction.
+
+```js
+const estimateTx: SafeMultisigTransactionEstimateResponse =
+  await safeService.estimateSafeTransaction(safeAddress, safeTransaction)
+```
+
+### proposeTransaction
+
+Creates a new multi-signature transaction and stores it in the Safe Transaction Service.
+
+```js
+const transactionConfig: ProposeTransactionProps = {
+  safeAddress,
+  safeTxHash,
+  safeTransactionData,
+  senderAddress,
+  senderSignature,
+  origin
+}
+await safeService.proposeTransaction(transactionConfig)
+```
+
+### getIncomingTransactions
+
+Returns the history of incoming transactions of a Safe account.
+
+```js
+const incomingTxs: TransferListResponse = await safeService.getIncomingTransactions(safeAddress)
+```
+
+### getModuleTransactions
+
+Returns the history of module transactions of a Safe account.
+
+```js
+const moduleTxs: SafeModuleTransactionListResponse = await safeService.getModuleTransactions(
+  safeAddress
+)
+```
+
+### getMultisigTransactions
+
+Returns the history of multi-signature transactions of a Safe account.
+
+```js
+const multisigTxs: SafeMultisigTransactionListResponse = await safeService.getMultisigTransactions(
+  safeAddress
+)
+```
+
+### getPendingTransactions
+
+Returns the list of multi-signature transactions that are waiting for the confirmation of the Safe owners.
+
+```js
+const pendingTxs: SafeMultisigTransactionListResponse = await safeService.getPendingTransactions(
+  safeAddress
+)
+```
+
+```js
+const pendingTxs: SafeMultisigTransactionListResponse = await safeService.getPendingTransactions(
+  safeAddress,
+  currentNonce
+)
+```
+
+### getAllTransactions
+
+Returns a list of transactions for a Safe. The list has different structures depending on the transaction type.
+
+```js
+const allTxs: SafeMultisigTransactionListResponse = await safeService.getAllTransactions(
+  safeAddress
+)
+```
+
+```js
+const allTxsOptions: AllTransactionsOptions = {
+  executed,
+  queued,
+  trusted
+}
+const allTxs: SafeMultisigTransactionListResponse = await safeService.getAllTransactions(
+  safeAddress,
+  allTxsOptions
+)
+```
+
+### getNextNonce
+
+Returns the right nonce to propose a new transaction right after the last pending transaction.
+
+```js
+const nextNonce = await safeService.getNextNonce(safeAddress)
+```
+
+### getTokenList
+
+Returns the list of all the ERC20 tokens handled by the Safe.
+
+```js
+const tokens: TokenInfoListResponse = await safeService.getTokenList()
+```
+
+### getToken
+
+Returns the information of a given ERC20 token.
+
+```js
+const token: TokenInfoResponse = await safeService.getToken(tokenAddress)
+```
+
+## <a name="license">License</a>
+
+This library is released under MIT.
+
+## <a name="contributors">Contributors</a>
+
+- Germán Martínez ([germartinez](https://github.com/germartinez))

package/dist/src/SafeApiKit.d.ts

@@ -0,0 +1,232 @@
+import { AddSafeDelegateProps, AllTransactionsListResponse, AllTransactionsOptions, DeleteSafeDelegateProps, GetSafeDelegateProps, MasterCopyResponse, ModulesResponse, OwnerResponse, ProposeTransactionProps, SafeCreationInfoResponse, SafeDelegateListResponse, SafeDelegateResponse, SafeInfoResponse, SafeModuleTransactionListResponse, SafeMultisigTransactionEstimate, SafeMultisigTransactionEstimateResponse, SafeMultisigTransactionListResponse, SafeServiceInfoResponse, SignatureResponse, TokenInfoListResponse, TokenInfoResponse, TransferListResponse } from '@safe-global/api-kit/types/safeTransactionServiceTypes';
+import { EthAdapter, SafeMultisigConfirmationListResponse, SafeMultisigTransactionResponse } from '@safe-global/safe-core-sdk-types';
+export interface SafeApiKitConfig {
+    /** txServiceUrl - Safe Transaction Service URL */
+    txServiceUrl: string;
+    /** ethAdapter - Ethereum adapter */
+    ethAdapter: EthAdapter;
+}
+declare class SafeApiKit {
+    #private;
+    constructor({ txServiceUrl, ethAdapter }: SafeApiKitConfig);
+    /**
+     * Returns the information and configuration of the service.
+     *
+     * @returns The information and configuration of the service
+     */
+    getServiceInfo(): Promise<SafeServiceInfoResponse>;
+    /**
+     * Returns the list of Safe master copies.
+     *
+     * @returns The list of Safe master copies
+     */
+    getServiceMasterCopiesInfo(): Promise<MasterCopyResponse[]>;
+    /**
+     * Decodes the specified Safe transaction data.
+     *
+     * @param data - The Safe transaction data
+     * @returns The transaction data decoded
+     * @throws "Invalid data"
+     * @throws "Not Found"
+     * @throws "Ensure this field has at least 1 hexadecimal chars (not counting 0x)."
+     */
+    decodeData(data: string): Promise<any>;
+    /**
+     * Returns the list of Safes where the address provided is an owner.
+     *
+     * @param ownerAddress - The owner address
+     * @returns The list of Safes where the address provided is an owner
+     * @throws "Invalid owner address"
+     * @throws "Checksum address validation failed"
+     */
+    getSafesByOwner(ownerAddress: string): Promise<OwnerResponse>;
+    /**
+     * Returns the list of Safes where the module address provided is enabled.
+     *
+     * @param moduleAddress - The Safe module address
+     * @returns The list of Safe addresses where the module provided is enabled
+     * @throws "Invalid module address"
+     * @throws "Module address checksum not valid"
+     */
+    getSafesByModule(moduleAddress: string): Promise<ModulesResponse>;
+    /**
+     * Returns all the information of a Safe transaction.
+     *
+     * @param safeTxHash - Hash of the Safe transaction
+     * @returns The information of a Safe transaction
+     * @throws "Invalid safeTxHash"
+     * @throws "Not found."
+     */
+    getTransaction(safeTxHash: string): Promise<SafeMultisigTransactionResponse>;
+    /**
+     * Returns the list of confirmations for a given a Safe transaction.
+     *
+     * @param safeTxHash - The hash of the Safe transaction
+     * @returns The list of confirmations
+     * @throws "Invalid safeTxHash"
+     */
+    getTransactionConfirmations(safeTxHash: string): Promise<SafeMultisigConfirmationListResponse>;
+    /**
+     * Adds a confirmation for a Safe transaction.
+     *
+     * @param safeTxHash - Hash of the Safe transaction that will be confirmed
+     * @param signature - Signature of the transaction
+     * @returns
+     * @throws "Invalid safeTxHash"
+     * @throws "Invalid signature"
+     * @throws "Malformed data"
+     * @throws "Error processing data"
+     */
+    confirmTransaction(safeTxHash: string, signature: string): Promise<SignatureResponse>;
+    /**
+     * Returns the information and configuration of the provided Safe address.
+     *
+     * @param safeAddress - The Safe address
+     * @returns The information and configuration of the provided Safe address
+     * @throws "Invalid Safe address"
+     * @throws "Checksum address validation failed"
+     */
+    getSafeInfo(safeAddress: string): Promise<SafeInfoResponse>;
+    /**
+     * Returns the list of delegates.
+     *
+     * @param getSafeDelegateProps - Properties to filter the returned list of delegates
+     * @returns The list of delegates
+     * @throws "Checksum address validation failed"
+     */
+    getSafeDelegates({ safeAddress, delegateAddress, delegatorAddress, label, limit, offset }: GetSafeDelegateProps): Promise<SafeDelegateListResponse>;
+    /**
+     * Adds a new delegate for a given Safe address.
+     *
+     * @param addSafeDelegateProps - The configuration of the new delegate
+     * @returns
+     * @throws "Invalid Safe delegate address"
+     * @throws "Invalid Safe delegator address"
+     * @throws "Invalid label"
+     * @throws "Checksum address validation failed"
+     * @throws "Address <delegate_address> is not checksumed"
+     * @throws "Safe=<safe_address> does not exist or it's still not indexed"
+     * @throws "Signing owner is not an owner of the Safe"
+     */
+    addSafeDelegate({ safeAddress, delegateAddress, delegatorAddress, label, signer }: AddSafeDelegateProps): Promise<SafeDelegateResponse>;
+    /**
+     * Removes a delegate for a given Safe address.
+     *
+     * @param deleteSafeDelegateProps - The configuration for the delegate that will be removed
+     * @returns
+     * @throws "Invalid Safe delegate address"
+     * @throws "Invalid Safe delegator address"
+     * @throws "Checksum address validation failed"
+     * @throws "Signing owner is not an owner of the Safe"
+     * @throws "Not found"
+     */
+    removeSafeDelegate({ delegateAddress, delegatorAddress, signer }: DeleteSafeDelegateProps): Promise<void>;
+    /**
+     * Returns the creation information of a Safe.
+     *
+     * @param safeAddress - The Safe address
+     * @returns The creation information of a Safe
+     * @throws "Invalid Safe address"
+     * @throws "Safe creation not found"
+     * @throws "Checksum address validation failed"
+     * @throws "Problem connecting to Ethereum network"
+     */
+    getSafeCreationInfo(safeAddress: string): Promise<SafeCreationInfoResponse>;
+    /**
+     * Estimates the safeTxGas for a given Safe multi-signature transaction.
+     *
+     * @param safeAddress - The Safe address
+     * @param safeTransaction - The Safe transaction to estimate
+     * @returns The safeTxGas for the given Safe transaction
+     * @throws "Invalid Safe address"
+     * @throws "Data not valid"
+     * @throws "Safe not found"
+     * @throws "Tx not valid"
+     */
+    estimateSafeTransaction(safeAddress: string, safeTransaction: SafeMultisigTransactionEstimate): Promise<SafeMultisigTransactionEstimateResponse>;
+    /**
+     * Creates a new multi-signature transaction with its confirmations and stores it in the Safe Transaction Service.
+     *
+     * @param proposeTransactionConfig - The configuration of the proposed transaction
+     * @returns The hash of the Safe transaction proposed
+     * @throws "Invalid Safe address"
+     * @throws "Invalid safeTxHash"
+     * @throws "Invalid data"
+     * @throws "Invalid ethereum address/User is not an owner/Invalid signature/Nonce already executed/Sender is not an owner"
+     */
+    proposeTransaction({ safeAddress, safeTransactionData, safeTxHash, senderAddress, senderSignature, origin }: ProposeTransactionProps): Promise<void>;
+    /**
+     * Returns the history of incoming transactions of a Safe account.
+     *
+     * @param safeAddress - The Safe address
+     * @returns The history of incoming transactions
+     * @throws "Invalid Safe address"
+     * @throws "Checksum address validation failed"
+     */
+    getIncomingTransactions(safeAddress: string): Promise<TransferListResponse>;
+    /**
+     * Returns the history of module transactions of a Safe account.
+     *
+     * @param safeAddress - The Safe address
+     * @returns The history of module transactions
+     * @throws "Invalid Safe address"
+     * @throws "Invalid data"
+     * @throws "Invalid ethereum address"
+     */
+    getModuleTransactions(safeAddress: string): Promise<SafeModuleTransactionListResponse>;
+    /**
+     * Returns the history of multi-signature transactions of a Safe account.
+     *
+     * @param safeAddress - The Safe address
+     * @returns The history of multi-signature transactions
+     * @throws "Invalid Safe address"
+     * @throws "Checksum address validation failed"
+     */
+    getMultisigTransactions(safeAddress: string): Promise<SafeMultisigTransactionListResponse>;
+    /**
+     * Returns the list of multi-signature transactions that are waiting for the confirmation of the Safe owners.
+     *
+     * @param safeAddress - The Safe address
+     * @param currentNonce - Current nonce of the Safe
+     * @returns The list of transactions waiting for the confirmation of the Safe owners
+     * @throws "Invalid Safe address"
+     * @throws "Invalid data"
+     * @throws "Invalid ethereum address"
+     */
+    getPendingTransactions(safeAddress: string, currentNonce?: number): Promise<SafeMultisigTransactionListResponse>;
+    /**
+     * Returns a list of transactions for a Safe. The list has different structures depending on the transaction type
+     *
+     * @param safeAddress - The Safe address
+     * @returns The list of transactions waiting for the confirmation of the Safe owners
+     * @throws "Invalid Safe address"
+     * @throws "Checksum address validation failed"
+     */
+    getAllTransactions(safeAddress: string, options?: AllTransactionsOptions): Promise<AllTransactionsListResponse>;
+    /**
+     * Returns the right nonce to propose a new transaction after the last pending transaction.
+     *
+     * @param safeAddress - The Safe address
+     * @returns The right nonce to propose a new transaction after the last pending transaction
+     * @throws "Invalid Safe address"
+     * @throws "Invalid data"
+     * @throws "Invalid ethereum address"
+     */
+    getNextNonce(safeAddress: string): Promise<number>;
+    /**
+     * Returns the list of all the ERC20 tokens handled by the Safe.
+     *
+     * @returns The list of all the ERC20 tokens
+     */
+    getTokenList(): Promise<TokenInfoListResponse>;
+    /**
+     * Returns the information of a given ERC20 token.
+     *
+     * @param tokenAddress - The token address
+     * @returns The information of the given ERC20 token
+     * @throws "Invalid token address"
+     * @throws "Checksum address validation failed"
+     */
+    getToken(tokenAddress: string): Promise<TokenInfoResponse>;
+}
+export default SafeApiKit;