Flow Account API

This API is an intermediary for non-custodial Flow wallets. It has two responsibilities:

Creating a new account on the behalf of a just-initialized wallet.
Maintaining a registry of publicKey -> accountAddress.

Running locally

This project uses Docker Compose and the Flow Emulator to simulate a blockchain environment on a local machine.

Run this command to start the Docker Compose network:

make run

Run with emulator outside of Docker

Start the emulator using the flow.json file in this directory:

flow emulator start

In a separate process, launch the API:

make run-with-local-emulator

API Routes

Create Account

curl --request POST \
  --url https://localhost:8081/accounts \
  --header 'content-type: application/json' \
  --data '{
	"publicKey": "6b1523db40836078eb6f80f8d4f934f03725a4e66574815b5d2a9f2ba5dcf9c483fc1b543392f6ada01cc13790f996d0969ee6f9c8d9190f54dc31f44be0a53b",
	"signatureAlgorithm": "ECDSA_P256",
	"hashAlgorithm": "SHA3_256"
}
'

Sample response:

{
  "address": "01cf0e2f2f715450",
  "publicKeys": [
    {
      "publicKey": "6b1523db40836078eb6f80f8d4f934f03725a4e66574815b5d2a9f2ba5dcf9c483fc1b543392f6ada01cc13790f996d0969ee6f9c8d9190f54dc31f44be0a53b",
      "signatureAlgorithm": "ECDSA_P256",
      "hashAlgorithm": "SHA3_256"
    }
  ]
}

Get Account By Public Key

curl --request GET \
  --url 'https://localhost:8081/accounts?publicKey=6b1523db40836078eb6f80f8d4f934f03725a4e66574815b5d2a9f2ba5dcf9c483fc1b543392f6ada01cc13790f996d0969ee6f9c8d9190f54dc31f44be0a53b'

Sample response:

{
  "address": "01cf0e2f2f715450",
  "publicKeys": [
    {
      "publicKey": "6b1523db40836078eb6f80f8d4f934f03725a4e66574815b5d2a9f2ba5dcf9c483fc1b543392f6ada01cc13790f996d0969ee6f9c8d9190f54dc31f44be0a53b",
      "signatureAlgorithm": "ECDSA_P256",
      "hashAlgorithm": "SHA3_256"
    }
  ]
}

Name		Name	Last commit message	Last commit date
Latest commit History 3 Commits
cmd/account-api		cmd/account-api
model		model
pkg/pg		pkg/pg
storage		storage
wallet		wallet
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
docker-compose.local-emulator.yml		docker-compose.local-emulator.yml
docker-compose.yml		docker-compose.yml
flow.json		flow.json
go.mod		go.mod
go.sum		go.sum

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

Flow Account API

Running locally

Run with emulator outside of Docker

API Routes

Create Account

Get Account By Public Key

About

Uh oh!

Releases

Packages

Uh oh!

Languages

License

onflow/flow-account-api

Folders and files

Latest commit

History

Repository files navigation

Flow Account API

Running locally

Run with emulator outside of Docker

API Routes

Create Account

Get Account By Public Key

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Languages

Packages