Skip to content

Latest commit

 

History

History
370 lines (238 loc) · 7.6 KB

README.md

File metadata and controls

370 lines (238 loc) · 7.6 KB
Raw

Flow Wallet API Demo (Node.js + express)

⚠️ This demo is a work in progress.

This is a demonstration of a RESTful API that implements a simple custodial wallet service for the Flow blockchain.

Functionality

1. Admin

2. Transaction Execution

  • Send an arbitrary transaction from the admin account
  • Send an arbitrary transaction from a user account

3. Fungible Tokens

4. Non-Fungible Tokens

  • Set up admin account with non-fungible token collections (NFT.Collection)
  • Send non-fungible token withdrawals from admin account
  • Detect non-fungible token deposits to admin account
  • Set up a user account with non-fungible token collections (NFT.Collection)
  • Send non-fungible token withdrawals from a user account
  • Detect non-fungible token deposits to a user account
  • View the non-fungible tokens owned by the admin account
  • View the non-fungible tokens owned by a user account

Getting Started

Install the Flow CLI

First, install the Flow CLI.

Install dependencies and configure environment

npm install

cp env.example .env

Start the database and emulator

Use Docker Compose to launch Postgres and the Flow Emulator:

docker-compose up -d

Start the server

npm run start

API Routes

Accounts

List all accounts

GET /v1/accounts

Example

curl --request GET \
  --url http://localhost:3000/v1/accounts
[
  {
    "address": "0xf8d6e0586b0a20c7"
  },
  {
    "address": "0xe467b9dd11fa00df"
  }
]

Get an account

GET /v1/accounts/{address}

Parameters

  • address: The address of the account (e.g. "0xf8d6e0586b0a20c7")

Example

curl --request GET \
  --url http://localhost:3000/v1/accounts/0xf8d6e0586b0a20c7
{
  "address": "0xf8d6e0586b0a20c7"
}

Create an account

POST /v1/accounts

Example

curl --request POST \
  --url http://localhost:3000/v1/accounts
{
  "address": "0xe467b9dd11fa00df"
}

Transaction Execution

Execute a transaction

⚠️ Not yet implemented

POST /v1/accounts/{address}/transactions

Parameters

  • address: The address of the account (e.g. "0xf8d6e0586b0a20c7")

Body (JSON)

  • code: The Cadence code to execute in the transaction
    • The code must always specify exactly one authorizer (i.e. prepare(auth: AuthAccount))

Example

curl --request POST \
  --url http://localhost:3000/v1/accounts/0xf8d6e0586b0a20c7/transactions \
  --header 'Content-Type: application/json' \
  --data '{ "code": "transaction { prepare(auth: AuthAccount) { log(\"Hello, World!\") } }" }'
{
  "transactionId": "18647b584a03345f3b2d2c4d9ab2c4179ae1b124a7f62ef9f33910e5ca8b353c",
  "error": null,
}

Fungible Tokens

Supported tokens:

  • FLOW
  • FUSD

List all tokens

GET /v1/accounts/{address}/fungible-tokens

Parameters

  • address: The address of the account (e.g. "0xf8d6e0586b0a20c7")

Example

curl --request GET \
  --url http://localhost:3000/v1/accounts/0xf8d6e0586b0a20c7/fungible-tokens
[
  {
    "name": "flow"
  },
  {
    "name": "fusd"
  }
]

Get details of a token type

GET /v1/accounts/{address}/fungible-tokens/{tokenName}

Parameters

  • address: The address of the account (e.g. "0xf8d6e0586b0a20c7")
  • tokenName: The name of the fungible token (e.g. "flow")

Example

curl --request GET \
  --url http://localhost:3000/v1/accounts/0xf8d6e0586b0a20c7/fungible-tokens/flow
{
  "name": "flow", 
  "balance": "42.0"
}

List all withdrawals of a token type

⚠️ Not yet implemented

GET /v1/accounts/{v1/accounts/{address}/fungible-tokens}/fungible-tokens/{tokenName}/withdrawals

Parameters

  • address: The address of the account (e.g. "0xf8d6e0586b0a20c7")
  • tokenName: The name of the fungible token (e.g. "flow")

Get details of a token withdrawal

⚠️ Not yet implemented

GET /v1/accounts/{address}/fungible-tokens/{tokenName}/withdrawals/{transactionId}

Parameters

  • address: The address of the account (e.g. "0xf8d6e0586b0a20c7")
  • tokenName: The name of the fungible token (e.g. "flow")
  • transactionId: The Flow transaction ID for the withdrawal

Create a token withdrawal

POST /v1/accounts/{address}/fungible-tokens/{tokenName}/withdrawals

Parameters

  • address: The address of the account (e.g. "0xf8d6e0586b0a20c7")
  • tokenName: The name of the fungible token (e.g. "flow")

Body (JSON)

  • amount: The number of tokens to transfer (e.g. "123.456")
    • Must be a fixed-point number with a maximum of 8 decimal places
  • recipient: The Flow address of the recipient (e.g. "0xf8d6e0586b0a20c7")

Example

curl --request POST \
  --url http://localhost:3000/v1/accounts/0xf8d6e0586b0a20c7/fungible-tokens/fusd/withdrawls \
  --header 'Content-Type: application/json' \
  --data '{ "recipient": "0xe467b9dd11fa00df", "amount": "123.456" }'
{
  "transactionId": "18647b584a03345f3b2d2c4d9ab2c4179ae1b124a7f62ef9f33910e5ca8b353c",
  "recipient": "0xe467b9dd11fa00df",
  "amount": "123.456"
}

Non-Fungible Tokens

⚠️ Not yet implemented

List all tokens

⚠️ Not yet implemented

GET /v1/accounts/{address}/non-fungible-tokens

Parameters

  • address: The address of the account (e.g. "0xf8d6e0586b0a20c7")

Example

curl --request GET \
  --url http://localhost:3000/v1/accounts/0xf8d6e0586b0a20c7/non-fungible-tokens

Get details of a token

⚠️ Not yet implemented

GET /v1/accounts/{address}/non-fungible-tokens/{tokenName}

Parameters

  • address: The address of the account (e.g. "0xf8d6e0586b0a20c7")
  • tokenName: The name of the non-fungible token (e.g. "nba-top-shot-moment")

List all withdrawals of a token type

⚠️ Not yet implemented

GET /v1/accounts/{address}/non-fungible-tokens/{tokenName}/withdrawals

Parameters

  • address: The address of the account (e.g. "0xf8d6e0586b0a20c7")
  • tokenName: The name of the non-fungible token (e.g. "nba-top-shot-moment")

Get details of a token withdrawal

⚠️ Not yet implemented

GET /v1/accounts/{address}/non-fungible-tokens/{tokenName}/withdrawals/{transactionId}

Parameters

  • address: The address of the account (e.g. "0xf8d6e0586b0a20c7")
  • tokenName: The name of the non-fungible token (e.g. "nba-top-shot-moment")
  • transactionId: The Flow transaction ID for the withdrawal

Create a token withdrawal

⚠️ Not yet implemented

POST /v1/accounts/{address}/non-fungible-tokens/{tokenName}/withdrawals

Parameters

  • address: The address of the account (e.g. "0xf8d6e0586b0a20c7")
  • tokenName: The name of the non-fungible token (e.g. "nba-top-shot-moment")

Body (JSON)

  • recipient: The Flow address of the recipient (e.g. "0xf8d6e0586b0a20c7")