Skip to content

Commit

Permalink
feat: External Transaction Broadcast (#372)
Browse files Browse the repository at this point in the history
  • Loading branch information
@John-peterson-coinbase
John-peterson-coinbase authored Feb 1, 2025
1 parent b0a7c5f commit 542b820
Show file tree
Hide file tree
Showing 17 changed files with 584 additions and 265 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Coinbase Node.js SDK Changelog

## [0.17.0] - 2025-02-01

### Added
- Add `broadcastExternalTransaction` method to `ExternalAddress` to broadcast an external transaction.

## [0.16.0] - 2025-01-28

### Added
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"license": "ISC",
"description": "Coinbase Platform SDK",
"repository": "https://github.com/coinbase/coinbase-sdk-nodejs",
"version": "0.16.0",
"version": "0.17.0",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"scripts": {
Expand Down
253 changes: 128 additions & 125 deletions quickstart-template/bridge-usdc.js
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import { Coinbase, Wallet } from "@coinbase/coinbase-sdk";
import { createPublicClient, decodeAbiParameters, http, keccak256, toBytes } from 'viem';
import { base } from 'viem/chains'
import { createPublicClient, decodeAbiParameters, http, keccak256, toBytes } from "viem";
import { base } from "viem/chains";
import os from "os";
import dotenv from "dotenv";

dotenv.config();

// https://developers.circle.com/stablecoins/evm-smart-contracts contains the CCTP contract addresses
// https://developers.circle.com/stablecoins/evm-smart-contracts contains the CCTP contract addresses
const BASE_TOKEN_MESSENGER_ADDRESS = "0x1682Ae6375C4E4A97e4B583BC394c861A46D8962";
const ARBITRUM_MESSAGE_TRANSMITTER_ADDRESS = "0xC30362313FBBA5cf9163F0bb16a0e01f01A896ca";

Expand All @@ -22,9 +22,7 @@ const tokenMessengerAbi = [
{ internalType: "address", name: "burnToken", type: "address" },
],
name: "depositForBurn",
outputs: [
{ internalType: "uint64", name: "_nonce", type: "uint64" },
],
outputs: [{ internalType: "uint64", name: "_nonce", type: "uint64" }],
stateMutability: "nonpayable",
type: "function",
},
Expand All @@ -37,142 +35,147 @@ const messageTransmitterAbi = [
{ internalType: "bytes", name: "attestation", type: "bytes" },
],
name: "receiveMessage",
outputs: [
{ internalType: "bool", name: "success", type: "bool" },
],
outputs: [{ internalType: "bool", name: "success", type: "bool" }],
stateMutability: "nonpayable",
type: "function",
},
];

async function bridgeUSDC(baseWallet, arbitrumWallet, usdcAmount) {
const baseUSDCBalance = await baseWallet.getBalance("usdc");
const arbitrumUSDCBalance = await arbitrumWallet.getBalance("usdc");
console.log("Base USDC initial balance:", baseUSDCBalance, "| Arbitrum USDC initial balance:", arbitrumUSDCBalance);

// pad the recipient address
const arbitrumRecipientAddress = padAddress((await arbitrumWallet.getDefaultAddress()).getId());

// step 1 - approve TokenMessenger as the spender on base
const approveTx = await baseWallet.invokeContract({
contractAddress: USDC_BASE_ADDRESS,
method: "approve",
args: {
spender: BASE_TOKEN_MESSENGER_ADDRESS,
value: usdcAmount.toString()
},
});
await approveTx.wait();
console.log("Approve transaction completed:", approveTx.getTransactionHash());

// step 2 - call depositForBurn
const depositTx = await baseWallet.invokeContract({
contractAddress: BASE_TOKEN_MESSENGER_ADDRESS,
method: "depositForBurn",
args: {
amount: usdcAmount.toString(), // uint256 as string
destinationDomain: "3", // uint32 as string
mintRecipient: arbitrumRecipientAddress, // already padded bytes32 as hex string
burnToken: USDC_BASE_ADDRESS
},
abi: tokenMessengerAbi
});
await depositTx.wait();
console.log("Deposit transaction completed:", depositTx.getTransactionHash());

// step 3 - get the messageHash from the transaction receipt logs
const transactionReceipt = await getTransactionReceipt(depositTx.getTransactionHash());
const eventTopic = keccak256(toBytes('MessageSent(bytes)'));
const log = transactionReceipt.logs.find((l) => l.topics[0] === eventTopic);
if (!log) {
throw new Error('MessageSent event not found in transaction logs');
}
const messageBytes = decodeAbiParameters([{ type: 'bytes' }], log.data)[0];
const messageHash = keccak256(messageBytes)
console.log("Message hash:", messageHash);

// step 4 - wait for attestation on the message
let attestationResponse = { status: 'pending' }
while (attestationResponse.status != 'complete') {
const response = await fetch(
`https://iris-api.circle.com/attestations/${messageHash}`,
)
attestationResponse = await response.json()
await new Promise((r) => setTimeout(r, 2000))
}

const attestationSignature = attestationResponse.attestation;
console.log("Received attestation signature from Circle's Iris service:", attestationSignature);

// step 5 - call receiveMessage on the arbitrum wallet MessageTransmitter
const receiveMessageTx = await arbitrumWallet.invokeContract({
contractAddress: ARBITRUM_MESSAGE_TRANSMITTER_ADDRESS ,
method: "receiveMessage",
args: {
message: messageBytes,
attestation: attestationSignature
},
abi: messageTransmitterAbi
});
await receiveMessageTx.wait();
console.log("Receive message transaction completed:", receiveMessageTx.getTransactionHash());

const finalBaseUSDCBalance = await baseWallet.getBalance("usdc");
const finalArbitrumUSDCBalance = await arbitrumWallet.getBalance("usdc");
console.log("Base USDC final balance:", finalBaseUSDCBalance, "| Arbitrum USDC final balance:", finalArbitrumUSDCBalance);
const baseUSDCBalance = await baseWallet.getBalance("usdc");
const arbitrumUSDCBalance = await arbitrumWallet.getBalance("usdc");
console.log(
"Base USDC initial balance:",
baseUSDCBalance,
"| Arbitrum USDC initial balance:",
arbitrumUSDCBalance,
);

// pad the recipient address
const arbitrumRecipientAddress = padAddress((await arbitrumWallet.getDefaultAddress()).getId());

// step 1 - approve TokenMessenger as the spender on base
const approveTx = await baseWallet.invokeContract({
contractAddress: USDC_BASE_ADDRESS,
method: "approve",
args: {
spender: BASE_TOKEN_MESSENGER_ADDRESS,
value: usdcAmount.toString(),
},
});
await approveTx.wait();
console.log("Approve transaction completed:", approveTx.getTransactionHash());

// step 2 - call depositForBurn
const depositTx = await baseWallet.invokeContract({
contractAddress: BASE_TOKEN_MESSENGER_ADDRESS,
method: "depositForBurn",
args: {
amount: usdcAmount.toString(), // uint256 as string
destinationDomain: "3", // uint32 as string
mintRecipient: arbitrumRecipientAddress, // already padded bytes32 as hex string
burnToken: USDC_BASE_ADDRESS,
},
abi: tokenMessengerAbi,
});
await depositTx.wait();
console.log("Deposit transaction completed:", depositTx.getTransactionHash());

// step 3 - get the messageHash from the transaction receipt logs
const transactionReceipt = await getTransactionReceipt(depositTx.getTransactionHash());
const eventTopic = keccak256(toBytes("MessageSent(bytes)"));
const log = transactionReceipt.logs.find(l => l.topics[0] === eventTopic);
if (!log) {
throw new Error("MessageSent event not found in transaction logs");
}
const messageBytes = decodeAbiParameters([{ type: "bytes" }], log.data)[0];
const messageHash = keccak256(messageBytes);
console.log("Message hash:", messageHash);

// step 4 - wait for attestation on the message
let attestationResponse = { status: "pending" };
while (attestationResponse.status != "complete") {
const response = await fetch(`https://iris-api.circle.com/attestations/${messageHash}`);
attestationResponse = await response.json();
await new Promise(r => setTimeout(r, 2000));
}

const attestationSignature = attestationResponse.attestation;
console.log("Received attestation signature from Circle's Iris service:", attestationSignature);

// step 5 - call receiveMessage on the arbitrum wallet MessageTransmitter
const receiveMessageTx = await arbitrumWallet.invokeContract({
contractAddress: ARBITRUM_MESSAGE_TRANSMITTER_ADDRESS,
method: "receiveMessage",
args: {
message: messageBytes,
attestation: attestationSignature,
},
abi: messageTransmitterAbi,
});
await receiveMessageTx.wait();
console.log("Receive message transaction completed:", receiveMessageTx.getTransactionHash());

const finalBaseUSDCBalance = await baseWallet.getBalance("usdc");
const finalArbitrumUSDCBalance = await arbitrumWallet.getBalance("usdc");
console.log(
"Base USDC final balance:",
finalBaseUSDCBalance,
"| Arbitrum USDC final balance:",
finalArbitrumUSDCBalance,
);
}

function padAddress(address) {
address = address.replace(/^0x/, '');
return '0x' + address.padStart(64, '0');
address = address.replace(/^0x/, "");
return "0x" + address.padStart(64, "0");
}

async function getTransactionReceipt(txHash) {
const publicClient = createPublicClient({
chain: base,
transport: http(),
})
const receipt = await publicClient.getTransactionReceipt({
hash: txHash
})
return receipt;
const publicClient = createPublicClient({
chain: base,
transport: http(),
});
const receipt = await publicClient.getTransactionReceipt({
hash: txHash,
});
return receipt;
}

async function fetchWalletAndLoadSeed(walletId, seedFilePath) {
try {
const wallet = await Wallet.fetch(walletId);
await wallet.loadSeedFromFile(seedFilePath);

console.log(`Successfully loaded funded wallet: `, wallet.getId());
return wallet;
} catch (error) {
console.error(
`Error loading funded wallet ${walletId} from seed file ${seedFilePath}: `,
error,
);
}
try {
const wallet = await Wallet.fetch(walletId);
await wallet.loadSeedFromFile(seedFilePath);

console.log(`Successfully loaded funded wallet: `, wallet.getId());
return wallet;
} catch (error) {
console.error(
`Error loading funded wallet ${walletId} from seed file ${seedFilePath}: `,
error,
);
}
}

async function main() {
try {
const { BASE_WALLET_ID, ARBITRUM_WALLET_ID, SEED_FILE_PATH } = process.env;

// Configure location to CDP API Key.
Coinbase.configureFromJson({
filePath: `${os.homedir()}/Downloads/cdp_api_key.json`,
});
// Fetch funded Wallet.
const baseWallet = await fetchWalletAndLoadSeed(BASE_WALLET_ID, SEED_FILE_PATH);
const arbitrumWallet = await fetchWalletAndLoadSeed(ARBITRUM_WALLET_ID, SEED_FILE_PATH);

// bridge 1 wei of USDC from base to arbitrum (0.000001 USDC)
await bridgeUSDC(baseWallet, arbitrumWallet, 1);
console.log("Bridge USDC completed");
} catch (error) {
console.error(`Error in bridging USDC: `, error);
}
};
try {
const { BASE_WALLET_ID, ARBITRUM_WALLET_ID, SEED_FILE_PATH } = process.env;

// Configure location to CDP API Key.
Coinbase.configureFromJson({
filePath: `${os.homedir()}/Downloads/cdp_api_key.json`,
});

// Fetch funded Wallet.
const baseWallet = await fetchWalletAndLoadSeed(BASE_WALLET_ID, SEED_FILE_PATH);
const arbitrumWallet = await fetchWalletAndLoadSeed(ARBITRUM_WALLET_ID, SEED_FILE_PATH);

// bridge 1 wei of USDC from base to arbitrum (0.000001 USDC)
await bridgeUSDC(baseWallet, arbitrumWallet, 1);
console.log("Bridge USDC completed");
} catch (error) {
console.error(`Error in bridging USDC: `, error);
}
}

main();

33 changes: 18 additions & 15 deletions quickstart-template/discord_tutorial/app.cjs
View file
Original file line number Diff line number Diff line change
@@ -1,39 +1,42 @@
require("dotenv/config");
const express = require("express");
const axios = require("axios");
const bodyParser = require('body-parser')
const bodyParser = require("body-parser");

const app = express();
const jsonParser = bodyParser.json()
const jsonParser = bodyParser.json();

app.get("/", jsonParser, (req, res) => {
res.send("Your https server is working!");
});

app.post("/", jsonParser, (req, res) => {
if (!process.env.DISCORD_URL) {
console.log('DISCORD_URL is missing from env');
console.log("DISCORD_URL is missing from env");
res.sendStatus(400);
return;
}

const data = req.body;

let messageContent = 'A new ' + data.eventType + ' event was received from the webhook: \n```'
messageContent += JSON.stringify(data, null, 2)
messageContent += '```\n'
messageContent += `Data received at ${new Date().toLocaleString("en-US")}`
let messageContent = "A new " + data.eventType + " event was received from the webhook: \n```";
messageContent += JSON.stringify(data, null, 2);
messageContent += "```\n";
messageContent += `Data received at ${new Date().toLocaleString("en-US")}`;

const postData = {
content: messageContent,
}
axios.post(process.env.DISCORD_URL, postData).then(() => {
console.log('Successfully posted message to discord');
res.sendStatus(200);
}).catch((e) => {
console.error(e)
res.sendStatus(400);
})
};
axios
.post(process.env.DISCORD_URL, postData)
.then(() => {
console.log("Successfully posted message to discord");
res.sendStatus(200);
})
.catch(e => {
console.error(e);
res.sendStatus(400);
});
});

app.listen(5000, () => {
Expand Down
Loading

0 comments on commit 542b820

Please sign in to comment.