Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cosmos/snap
Packages That Add Cosmos Support Into Metamask. The Cosmos is Expanding!
https://github.com/cosmos/snap
Last synced: 3 days ago
JSON representation
Packages That Add Cosmos Support Into Metamask. The Cosmos is Expanding!
- Host: GitHub
- URL: https://github.com/cosmos/snap
- Owner: cosmos
- License: mit
- Created: 2023-04-12T09:55:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-28T20:01:15.000Z (2 months ago)
- Last Synced: 2024-11-02T02:04:46.594Z (7 days ago)
- Language: TypeScript
- Homepage: https://metamask.mysticlabs.xyz/
- Size: 18.4 MB
- Stars: 38
- Watchers: 12
- Forks: 15
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - cosmos/snap - Packages That Add Cosmos Support Into Metamask. The Cosmos is Expanding! (TypeScript)
README
# Cosmos MetaMask Snap
Cosmos Metamask Snap aims to add full support of Metamask, a highly popular Ethereum wallet, to all Cosmos SDK blockchains, potentially opening the door to over 30 million Ethereum users and stimulating growth for every project in the Cosmos ecosystem.
## Developer Preview Software
Please note, to develop this Metamask Snap you need to use Metamask Flask, a canary distribution for developers that provides access to upcoming features within Metamask.
## Contribution
Your contributions are always welcome! Please have a look at the [contribution guidelines](CONTRIBUTING.md) first.
## Running Snap
```bash
yarn install
cd packages/snap
yarn start
```
## Running Snap UI
```bash
yarn install
cd packages/ui
yarn run dev
```
## Install & Initialize
```javascript
// Check if the Snap is installed
let result = await window.ethereum.request({ method: 'wallet_getSnaps' });
const installed = Object.keys(result).includes("npm:@cosmsnap/snap");
// Install Snap
if (!installed) {
const result = await window.ethereum.request({
method: 'wallet_requestSnaps',
params: {
'npm:@cosmsnap/snap': {
version: '^0.1.0',
},
},
});
}
// Initialize the Snap with default chains
await ethereum.request({
method: 'wallet_invokeSnap',
params: {
snapId: 'npm:@cosmsnap/snap',
request: {
method: 'initialize',
},
},
});
```
## Check If Initialized
```javascript
// Boolean is returned
const initialized = await ethereum.request({
method: 'wallet_invokeSnap',
params: {
snapId: 'npm:@cosmsnap/snap',
request: {
method: 'initialized',
},
},
});
```
## Suggest Chain
This Snap has default support for coin types `118, 564, 459, 529, 330, 494, 639, 483, 4444, 701, 990, 394, 852, 7777777, 880, 931, 371, 370, 505, 234, 5555`. All the coin types within the chain registry except for coin type 60 (Ethermint, which is already supported in standard MetaMask). If you need any other please add an issue to the repo [here](https://github.com/cosmos/snap/issues) and we will gladly add it.
Chain info is structured like in the chain registry (i.e [Agoric](https://github.com/cosmos/chain-registry/tree/master/agoric))
```javascript
// chainInfo should be structured like this https://github.com/cosmos/chain-registry/tree/master/agoric
await window.ethereum.request({
method: 'wallet_invokeSnap',
params: {
snapId: 'npm:@cosmsnap/snap',
request: {
method: 'addChain',
params: {
chain_info: JSON.stringify(chainInfo),
}
},
},
});
```
## Get Chains
```javascript
const chains = await window.ethereum.request({
method: 'wallet_invokeSnap',
params: {
snapId: 'npm:@cosmsnap/snap',
request: {
method: 'getChains'
},
},
});
```
## Delete Chain
```javascript
const chain = await window.ethereum.request({
method: 'wallet_invokeSnap',
params: {
snapId: 'npm:@cosmsnap/snap',
request: {
method: 'deleteChain',
params: {
chain_id: 'cosmoshub-4',
}
},
},
});
```
## Send Transaction
```javascript
const msgs = [
{
typeUrl: "/cosmos.bank.v1beta1.MsgSend",
value: {
fromAddress: senderAddress,
toAddress: recipientAddress,
amount: [{
denom: "uatom",
amount: "500000"
}],
},
}
];
const fees = {
amount: [{
denom: "uatom",
amount: "500"
}],
gas: "200000"
};
const address = await window.ethereum.request({
method: 'wallet_invokeSnap',
params: {
snapId: 'npm:@cosmsnap/snap',
request: {
method: 'transact',
params: {
chain_id: 'cosmoshub-4',
msgs: JSON.stringify(msgs),
// Optional: Uses default fees for chain if not specified
fees: JSON.stringify(fees)
}
},
},
});
```
## Sign Transaction
This will sign the transaction and return the transaction bytes.
NOTE: This does not broadcast the transaction.
```javascript
const msgs = [
{
typeUrl: "/cosmos.bank.v1beta1.MsgSend",
value: {
fromAddress: senderAddress,
toAddress: recipientAddress,
amount: [{
denom: "uatom",
amount: "500000"
}],
},
}
];
const fees = {
amount: [{
denom: "uatom",
amount: "500"
}],
gas: "200000"
};
const address = await window.ethereum.request({
method: 'wallet_invokeSnap',
params: {
snapId: 'npm:@cosmsnap/snap',
request: {
method: 'signTx',
params: {
chain_id: 'cosmoshub-4',
msgs: JSON.stringify(msgs),
// Optional: Uses default fees for chain if not specified
fees: JSON.stringify(fees)
}
},
},
});
```
## Add Address (Address Book)
```javascript
const address = await window.ethereum.request({
method: 'wallet_invokeSnap',
params: {
snapId: 'npm:@cosmsnap/snap',
request: {
method: 'addAddress',
params: {
chain_id: 'cosmoshub-4',
address: 'cosmos123456789',
name: 'John Cosmos'
}
},
},
});
```
## Get Addresses (Address Book)
```javascript
const address = await window.ethereum.request({
method: 'wallet_invokeSnap',
params: {
snapId: 'npm:@cosmsnap/snap',
request: {
method: 'getAddresses'
},
},
});
```
## Delete Address (Address Book)
```javascript
const address = await window.ethereum.request({
method: 'wallet_invokeSnap',
params: {
snapId: 'npm:@cosmsnap/snap',
request: {
method: 'deleteAddress',
params: {
address: 'cosmos123456789'
}
},
},
});
```
## Get Bech32 Address
```javascript
const address = await window.ethereum.request({
method: 'wallet_invokeSnap',
params: {
snapId: 'npm:@cosmsnap/snap',
request: {
method: 'getChainAddress',
params: {
chain_id: 'cosmoshub-4',
}
},
},
});
```
## Get Bech32 Addresses
```javascript
const address = await window.ethereum.request({
method: 'wallet_invokeSnap',
params: {
snapId: 'npm:@cosmsnap/snap',
request: {
method: 'getChainAddresses'
},
},
});
```