Security News
How Threat Actors are Abusing GitHub’s File Upload Feature to Host Malware
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
@safe-global/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
import SafeApiKit from '@safe-global/api-kit'
const safeService = new SafeApiKit({
chainId: 1n,
// Optional. txServiceUrl must be used to set a custom service. For example on chains where Safe doesn't run services.
txServiceUrl: 'https://safe-transaction-mainnet.safe.global'
})
Returns the information and configuration of the service.
const serviceInfo: SafeServiceInfoResponse = await safeService.getServiceInfo()
Returns the list of Safe singleton copies.
const singletons: SafeSingletonResponse = await safeService.getServiceSingletonsInfo()
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 @safe-global/api-kit receives a total of 10,482 weekly downloads. As such, @safe-global/api-kit popularity was classified as popular.
We found that @safe-global/api-kit demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers 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
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.