Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

API Redesign #1716

Closed
wants to merge 117 commits into from
Closed

API Redesign #1716

wants to merge 117 commits into from

Conversation

ouziel-slama
Copy link
Contributor

@ouziel-slama ouziel-slama commented Apr 19, 2024 •
edited by mattmarcello
Loading

  • Implement API v2
    • ensure that all data is covered
    • ensure that all API v1 endpoints have an equivalent
    • Implement unpack for all message types
  • Deprecate API v1
    • Use X-API-Warn
    • Throw warnings when they're used
    • Put behind a CLI flag
    • Put behind /old/api/
  • Test API v2
  • Document API v2

Ouziel added 30 commits April 10, 2024 10:27
@Ouziel
introduce 'restapi.py'
a690940
@Ouziel
DRY routes
00181f9
@Ouziel
refactor 'get_asset_info()'
110e5c8
@Ouziel
Add API authentification
ba61877
@Ouziel
move old api in v1/; rename restapi.py to api.py
893c86e
@Ouziel
--legacy-api -> --enable-v1-api
c1bf32b
@Ouziel
lint
ad47e52
@Ouziel
Add routes for blocks
3d434cf
@Ouziel
fix tests
a222bb8
@Ouziel
Add tests for new API
a0d07f4
@Ouziel
use app context instead global variables
4e6cc2d
@Ouziel
tweaks
840633e
@Ouziel
More routes for blocks, credits and debits
6e75205
@Ouziel
clean imports
b275944
@Ouziel
More routes
6f4ffeb
@Ouziel
More routes: sends, resolutions, ..
3ed4ba7
@Ouziel
Add 'event' field in mempool table
83bd420
@Ouziel
More routes: dispensers, sweeps, holders, ..
38fb161
@Ouziel
Add routes for events
092b312
@Ouziel
Add routes for mempool and events count
46ebe88
@Ouziel
module in subfolder
f8cc62c
@Ouziel
Add route to compose transactions
313b747
@Ouziel
Add route for healthz and get_tx_info
d699408
@Ouziel
Add backend proxy routes
7d956f6
@Ouziel
Add route for root
d890979
@Ouziel
fix tests
1e3a226
@Ouziel
inject headers
c506c0a
@Ouziel
Progress in unpack support
7cb5a40
@Ouziel
Add route to unpack; supports all type of message
71cfb0c
@Ouziel
update ledger.CURRENT_BLOCK_INDEX on each request
a2878c6
@ouziel-slama ouziel-slama changed the title WIP: API Redesign API Redesign Apr 24, 2024
@ouziel-slama
Copy link
Contributor Author

I think it's finished for the first iteration!
Comes with CounterpartyXCP/Documentation#184

@mattmarcello
Copy link
Contributor

Nice! Will take a closer look in a few hours.

mattmarcello
mattmarcello reviewed Apr 24, 2024
View reviewed changes
counterparty-core/counterpartycore/lib/api/api_server.py Outdated Show resolved Hide resolved
counterparty-core/counterpartycore/lib/api/api_server.py Show resolved Hide resolved
counterparty-core/counterpartycore/lib/api/api_server.py Show resolved Hide resolved
counterparty-core/counterpartycore/lib/api/api_server.py Show resolved Hide resolved
counterparty-core/counterpartycore/lib/api/routes.py Show resolved Hide resolved
counterparty-core/counterpartycore/lib/blocks.py Show resolved Hide resolved
counterparty-core/counterpartycore/lib/ledger.py Outdated Show resolved Hide resolved
counterparty-core/counterpartycore/lib/ledger.py Outdated Show resolved Hide resolved
counterparty-core/counterpartycore/lib/transaction.py Outdated Show resolved Hide resolved
counterparty-core/counterpartycore/lib/transaction.py Outdated Show resolved Hide resolved
Ouziel and others added 20 commits April 25, 2024 10:21
@Ouziel
Remove success from result
f48bc0c
@Ouziel
db is already initialized
e206819
@Ouziel
fix typo
cd0ba21
@Ouziel
_by_event -> _by_name
6f78ef5
@Ouziel
fix fixtures
09a64a8
@Ouziel
Remove success and add root path in doc
99ef600
@Ouziel
Don't indent json result; Fix typo
56ff76a
@Ouziel
tweak indentation
611b263
@Ouziel
order_hash, bet_hash and dispenser_hash instead tx_hash in routes
b71b1fe
@Ouziel
get_balance_object -> get_balance_by_address_and_asset
102b9f1
@Ouziel
handle_healthz_route_v2 -> check_server_status
a5370ea
@Ouziel
generate also apib compatible with apiary
16ae417
@Ouziel
Introduce counterparty-core.apib; Fix blueprint semantic issues
405b2ed
@Ouziel
Fix API root paragraph
06a0309
@Ouziel
fix blueprint links in Apiary
ba4e5f8
@Ouziel
fix typos
af4ff31
@Ouziel
Root path always return 200
87e367f
@Ouziel
Rename blueprint; Include unpacked data in get transaction by hash re…
016b3a9 
…sult
@Ouziel
fix apiary filename
67f0b95
@adamkrellenstein
Add Port to Host
8ff2f07
@ouziel-slama
Copy link
Contributor Author

Moved here #1729

@ouziel-slama ouziel-slama deleted the newapi2 branch April 25, 2024 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adamkrellenstein adamkrellenstein adamkrellenstein left review comments

@mattmarcello mattmarcello mattmarcello left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ouziel-slama @mattmarcello @adamkrellenstein @Ouziel