Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@term-labs/api-kit
Advanced tools
Readme
Software development kit that facilitates the interaction with the Safe Transaction Service API.
Install the package with yarn or npm:
yarn install
npm install
Build the package with yarn or npm:
yarn build
npm run build
Create a .env
file with environment variables. You can use the .env.example
file as a reference.
Test the package with yarn or npm:
yarn test
npm run test
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 or ethers.js Ethereum libraries.
Depending on the library used by the Dapp, there are two options:
Once the instance of EthersAdapter
or Web3Adapter
is created, it can be used in the SDK initialization.
import SafeApiKit from '@safe-global/api-kit'
const safeService = new SafeApiKit({
txServiceUrl: 'https://safe-transaction-mainnet.safe.global',
ethAdapter
})
Returns the information and configuration of the service.
const serviceInfo: SafeServiceInfoResponse = await safeService.getServiceInfo()
Returns the list of Safe master copies.
const masterCopies: MasterCopyResponse = await safeService.getServiceMasterCopiesInfo()
Decodes the specified Safe transaction data.
const decodedData = await safeService.decodeData(data)
Returns the list of Safes where the address provided is an owner.
const safes: OwnerResponse = await safeService.getSafesByOwner(ownerAddress)
Returns the list of Safes where the module address provided is enabled.
const safes: ModulesResponse = await getSafesByModule(moduleAddress)
Returns all the information of a Safe transaction.
const tx: SafeMultisigTransactionResponse = await safeService.getTransaction(safeTxHash)
Returns the list of confirmations for a given a Safe transaction.
const confirmations: SafeMultisigConfirmationListResponse =
await safeService.getTransactionConfirmations(safeTxHash)
Adds a confirmation for a Safe transaction.
const signature: SignatureResponse = await safeService.confirmTransaction(safeTxHash, signature)
Returns the information and configuration of the provided Safe address.
const safeInfo: SafeInfoResponse = await safeService.getSafeInfo(safeAddress)
Returns the list of delegates for a given Safe address.
const delegateConfig: GetSafeDelegateProps = {
safeAddress, // Optional
delegateAddress, // Optional
delegatorAddress, // Optional
label, // Optional
limit, // Optional
offset // Optional
}
const delegates: SafeDelegateListResponse = await safeService.getSafeDelegates(delegateConfig)
Adds a new delegate for a given Safe address.
const delegateConfig: AddSafeDelegateProps = {
safeAddress, // Optional
delegateAddress,
delegatorAddress,
label,
signer
}
await safeService.addSafeDelegate(delegateConfig)
Removes a delegate for a given Safe address.
const delegateConfig: DeleteSafeDelegateProps = {
delegateAddress,
delegatorAddress,
signer
}
await safeService.removeSafeDelegate(delegateConfig)
Returns the creation information of a Safe.
const safeCreationInfo: SafeCreationInfoResponse = await safeService.getSafeCreationInfo(
safeAddress
)
Estimates the safeTxGas for a given Safe multi-signature transaction.
const estimateTx: SafeMultisigTransactionEstimateResponse =
await safeService.estimateSafeTransaction(safeAddress, safeTransaction)
Creates a new multi-signature transaction and stores it in the Safe Transaction Service.
const transactionConfig: ProposeTransactionProps = {
safeAddress,
safeTxHash,
safeTransactionData,
senderAddress,
senderSignature,
origin
}
await safeService.proposeTransaction(transactionConfig)
Returns the history of incoming transactions of a Safe account.
const incomingTxs: TransferListResponse = await safeService.getIncomingTransactions(safeAddress)
Returns the history of module transactions of a Safe account.
const moduleTxs: SafeModuleTransactionListResponse = await safeService.getModuleTransactions(
safeAddress
)
Returns the history of multi-signature transactions of a Safe account.
const multisigTxs: SafeMultisigTransactionListResponse = await safeService.getMultisigTransactions(
safeAddress
)
Returns the list of multi-signature transactions that are waiting for the confirmation of the Safe owners.
const pendingTxs: SafeMultisigTransactionListResponse = await safeService.getPendingTransactions(
safeAddress
)
const pendingTxs: SafeMultisigTransactionListResponse = await safeService.getPendingTransactions(
safeAddress,
currentNonce
)
Returns a list of transactions for a Safe. The list has different structures depending on the transaction type.
const allTxs: SafeMultisigTransactionListResponse = await safeService.getAllTransactions(
safeAddress
)
const allTxsOptions: AllTransactionsOptions = {
executed,
queued,
trusted
}
const allTxs: SafeMultisigTransactionListResponse = await safeService.getAllTransactions(
safeAddress,
allTxsOptions
)
Returns the right nonce to propose a new transaction right after the last pending transaction.
const nextNonce = await safeService.getNextNonce(safeAddress)
Returns the list of all the ERC20 tokens handled by the Safe.
const tokens: TokenInfoListResponse = await safeService.getTokenList()
Returns the information of a given ERC20 token.
const token: TokenInfoResponse = await safeService.getToken(tokenAddress)
This library is released under MIT.
FAQs
Safe API Kit
The npm package @term-labs/api-kit receives a total of 52 weekly downloads. As such, @term-labs/api-kit popularity was classified as not popular.
We found that @term-labs/api-kit demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.