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.

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

(V1) Implement API endpoints to manage deployments protected by the API key #767

Closed
6 tasks done
baktun14 opened this issue Jan 31, 2025 · 3 comments
Closed
6 tasks done
Assignees

Comments

@baktun14
Copy link
Contributor

baktun14 commented Jan 31, 2025

For each of the following endpoint api-key protected endpoints, we want to abtract away all the blockchain logic of creating the proper transaction payload to sign a transaction. We have example code in both console and akashjs

These should be done individually

  • Create certificate
    • POST /v1/certificates
    • returns base64 encoded certificate (token)
  • Create deployment
    • POST /v1/deployments
      • Parse and validate SDL
      • Create transaction payload example
      • Sign transaction
    • Payload: technically we should only need the SDL
{
  sdl: string
}
  • Get bids
    • GET /v1/bids/{dseq}
    • proxy the request to a rpc using the address of the user account associated with the api key
  • Create lease
    • POST /v1/leases
      • Create lease payload example
      • Sign transaction
      • Send manifest
    • Payload:
{
 sdl: string,
 dseq: string,
 gseq: string,
 oseq: string,
 provider: string,
 token: string // (base64 cert)
}
  • Deployment details
    • GET /v1/deployments/{dseq}
    • Formulate a response with data coming from db indexer or rpc node with the following example return payload
{
  deployment: DeploymentDetails,
  leases: LeaseDetails[],
  escrow: EscrowBalance
}
  • Close Deployment
    • DELETE /v1/deployments/{dseq}
@baktun14 baktun14 changed the title Implement API endpoints to manage deployments protected by the API key (V2) Implement API endpoints to manage deployments protected by the API key Feb 3, 2025
@anilmurty anilmurty added this to the Managed Wallets API milestone Feb 4, 2025
@ygrishajev
Copy link
Contributor

I'd suggest a more unified interface like:

POST /v1/deployments
GET /v1/bids/{dseq}
POST /v1/leases

@baktun14
Copy link
Contributor Author

@ygrishajev makes sense

jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 18, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 18, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 18, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 18, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 18, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 18, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 18, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 19, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 19, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 19, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 19, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 19, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 19, 2025
@github-project-automation github-project-automation bot moved this to Backlog (not prioritized) in Client Product and Engineering Roadmap Feb 19, 2025
@baktun14 baktun14 moved this from Backlog (not prioritized) to In Review in Client Product and Engineering Roadmap Feb 19, 2025
@baktun14 baktun14 moved this from In Review to In Progress (prioritized) in Client Product and Engineering Roadmap Feb 19, 2025
@baktun14 baktun14 self-assigned this Feb 19, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 20, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 20, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 20, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 21, 2025
baktun14 pushed a commit that referenced this issue Feb 21, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 23, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 23, 2025
@baktun14
Copy link
Contributor Author

@jzsfkzm I will work on the /v1/certificates endpoint

jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 25, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 25, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 25, 2025
jzsfkzm added a commit to jzsfkzm/console that referenced this issue Feb 25, 2025
@baktun14 baktun14 changed the title (V2) Implement API endpoints to manage deployments protected by the API key (V1) Implement API endpoints to manage deployments protected by the API key Mar 11, 2025
@baktun14 baktun14 moved this from In Progress (prioritized) to In Review in Client Product and Engineering Roadmap Mar 11, 2025
@baktun14 baktun14 moved this from In Review to Released (in Prod) in Client Product and Engineering Roadmap Mar 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Released (in Prod)
Development

No branches or pull requests

3 participants