Skip to content

Commit

Permalink
fix: restructure the API section (#449)
Browse files Browse the repository at this point in the history
* fix: restructure the API section

* fix: minor updates

* fix: tweak Vale rule

* fix: add description and fix link

* fix: add missing word

* Update pages/core-api/overview.mdx

Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>

* fix: updates based on feedback

* fix: updates from new feedback

---------

Co-authored-by: Tanay Pant <tanaypantprotonmail.com>
Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>
  • Loading branch information
tanay1337 and germartinez authored Apr 25, 2024
1 parent 65bb5f3 commit f64047c
Show file tree
Hide file tree
Showing 15 changed files with 50 additions and 14 deletions.
1 change: 1 addition & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,4 @@ mdx = md
[*.{md,mdx}]
BasedOnStyles = Vale, Microsoft, write-good
Microsoft.Contractions = NO
Microsoft.Quotes = NO
4 changes: 4 additions & 0 deletions pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
"title": "SDK",
"type": "page"
},
"core-api": {
"title": "API",
"type": "page"
},
"advanced": {
"title": "Advanced",
"type": "page"
Expand Down
5 changes: 2 additions & 3 deletions pages/advanced/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,13 @@
"smart-account-supported-networks": "Supported Networks",
"smart-account-audits": "Audits",
"smart-account-bug-bounty": "Bug Bounty",
"-- Safe{Core} API": {
"-- Safe{Core} API Infrastructure": {
"type": "separator",
"title": "Safe{Core} API"
"title": "Safe{Core} API Infrastructure"
},
"api-overview": "Overview",
"api-safe-transaction-service": "Safe Transaction Service",
"api-rpc-requirements": "RPC Requirements",
"api-supported-networks": "Supported Networks",
"api-new-networks": "Add New Networks",
"-- Safe CLI": {
"type": "separator",
Expand Down
3 changes: 0 additions & 3 deletions pages/advanced/api-safe-transaction-service/_meta.json

This file was deleted.

13 changes: 13 additions & 0 deletions pages/core-api/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"home": {
"title": "← Go Home",
"href": "/"
},
"-- Safe Transaction Service API": {
"type": "separator",
"title": "Safe Transaction Service API"
},
"transaction-service-overview": "Overview",
"transaction-service-supported-networks": "Supported Networks",
"transaction-service-guides": "Guides"
}
18 changes: 18 additions & 0 deletions pages/core-api/transaction-service-overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { Cards, Card } from 'nextra/components'
import Guides from '../../assets/svg/guides.svg'
import Reference from '../../assets/svg/reference.svg'

# Safe Transaction Service API

The Safe Transaction Service API offers REST endpoints to keep track of transactions sent via Safe contracts. It also offers endpoints to send transactions to allow offchain collecting of signatures or informing the owners about a pending transaction to be sent to the blockchain.

We also offer the [API Kit](../sdk/api-kit), a TypeScript client for the Safe Transaction Service API in the Safe\{Core\} SDK.

<Cards>
<Card icon={<Guides />} title="Guides" href="./transaction-service-guides/transactions" />
<Card icon={<Reference />} title="Reference" href="./transaction-service-reference" />
</Cards>

## Getting started

Are you new to our API and not sure where to get started? We recommend heading over to the guides on the [Safe Transaction Service API](./transaction-service-guides/transactions).
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Supported Networks

## Safe Transaction Service

| Network | Host |
| ---------------------------- | -------------------------------------------------------------------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion pages/home/safe-core.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The Safe\{Core\} stack is categorized into three distinct groups:
<CustomCard
title={'Safe{Core} API'}
description={'The Safe infrastructure needed to power interfaces with all Safe account related information. This includes the Safe Transaction Service, Safe Events Service, etc.'}
url={'../advanced/api-service-architecture'}
url={'../core-api/transaction-service-overview'}
icon={<SafeCoreAPI />}
newTab={false}
/>
Expand Down
4 changes: 2 additions & 2 deletions pages/sdk/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
"title": "← Go Home",
"href": "/"
},
"-- Safe{Core} AA SDK": {
"-- Safe{Core} SDK": {
"type": "separator",
"title": "Safe{Core} AA SDK"
"title": "Safe{Core} SDK"
},
"overview": "Overview",
"auth-kit": "Auth Kit",
Expand Down
6 changes: 3 additions & 3 deletions pages/sdk/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ import SafeCoreSDK from '../../assets/svg/ic-sdk.svg'
import SafeSmartAccount from '../../assets/svg/ic-smart-account.svg'
import SafeCoreAPI from '../../assets/svg/ic-api.svg'

# Safe\{Core\} Account Abstraction SDK
# Safe\{Core\} SDK

The Safe\{Core\} Account Abstraction SDK aims to bring Account Abstraction to life by integrating Safe with different third parties. This SDK helps developers to abstract the complexity of setting up a smart contract account.
The Safe\{Core\} SDK aims to bring Account Abstraction to life by integrating Safe with different third parties. This SDK helps developers to abstract the complexity of setting up a smart contract account.

![diagram safe core sdk](../../assets/diagram-safe-core-sdk.png)

The Safe\{Core\} AA SDK groups its functionality into five different kits:
The Safe\{Core\} SDK groups its functionality into five different kits:

## Protocol Kit

Expand Down
7 changes: 6 additions & 1 deletion redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,12 @@
},
{
"source": "/api-supported-networks",
"destination": "/advanced/api-supported-networks",
"destination": "/core-api/transaction-service-supported-networks",
"permanent": true
},
{
"source": "/advanced/api-supported-networks",
"destination": "/core-api/transaction-service-supported-networks",
"permanent": true
},
{
Expand Down

0 comments on commit f64047c

Please sign in to comment.