# Safe API Kit
[](https://badge.fury.io/js/%40safe-global%2Fapi-kit)
[](https://github.com/safe-global/safe-core-sdk/releases)
[](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)
- [Tests](#tests)
- [Initialization](#initialization)
- [API Reference](#api-reference)
- [License](#license)
- [Contributors](#contributors)
## Installation
Install the package with yarn or npm:
```bash
yarn install
npm install
```
## Build
Build the package with yarn or npm:
```bash
yarn build
npm run build
```
## Tests
Create a `.env` file with environment variables. You can use the `.env.example` file as a reference.
Test the package with yarn or npm:
```bash
yarn test
npm run test
```
## Initialization
### 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
})
```
## API Reference
### 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)
```
## License
This library is released under MIT.
## Contributors
- Germán Martínez ([germartinez](https://github.com/germartinez))