A versão 2.0.0 é a primeira versão estável dos módulos Go, por isso não há nada a migrar. O guia de migração para a 2.0 abrange a mesma divisão de capacidades para Rust e TypeScript.
Instalação
Cada backend é o seu próprio módulo Go, pelo que a sua compilação e o seu grafo de módulos contêm apenas os backends que importa:
go get github.com/solana-foundation/solana-keychain/go/core/v2 # Interfaces, errors, helpersgo get github.com/solana-foundation/solana-keychain/go/signers/memory/v2 # Local keypair signergo get github.com/solana-foundation/solana-keychain/go/signers/vault/v2 # HashiCorp Vaultgo get github.com/solana-foundation/solana-keychain/go/signers/awskms/v2 # AWS KMSgo get github.com/solana-foundation/solana-keychain/go/signers/gcpkms/v2 # GCP KMSgo get github.com/solana-foundation/solana-keychain/go/signers/privy/v2 # Privygo get github.com/solana-foundation/solana-keychain/go/signers/turnkey/v2 # Turnkeygo get github.com/solana-foundation/solana-keychain/go/signers/fireblocks/v2 # Fireblocksgo get github.com/solana-foundation/solana-keychain/go/signers/cdp/v2 # Coinbase Developer Platformgo get github.com/solana-foundation/solana-keychain/go/signers/crossmint/v2 # Crossmintgo get github.com/solana-foundation/solana-keychain/go/signers/dfns/v2 # Dfnsgo get github.com/solana-foundation/solana-keychain/go/signers/openfort/v2 # Openfortgo get github.com/solana-foundation/solana-keychain/go/signers/para/v2 # Parago get github.com/solana-foundation/solana-keychain/go/signers/utila/v2 # Utilago get github.com/solana-foundation/solana-keychain/go/signers/fordefi/v2 # Fordefi
Os módulos são etiquetados como go/<module>/v2.0.0 (por exemplo,
go/signers/memory/v2.0.0). Todos os módulos exigem Go 1.25.0, exceto o gcpkms,
que exige Go 1.25.8 devido ao requisito mínimo definido por google.golang.org/api.
O Ledger é exclusivo de Rust e não tem módulo Go.
Transações solana-go v2 e v1
Os módulos são construídos sobre
github.com/solana-foundation/solana-go/v2
v2.0.0 e recebem a sua *solana.Transaction. São suportadas transações legacy, v0 e v1
(solana.MessageVersionV1), exceto pela Fireblocks
com UseProgramCall: true, que aceita apenas legacy e v0.
Utilização básica
Todos os signers implementam a
interface base core.SolanaSigner
(Pubkey, SignMessage, IsAvailable). Os métodos recebem um context.Context e
são bloqueantes. Cada backend implementa também exatamente uma interface de capacidade:
core.TransactionSigner:SignTransactionassina a sua transação tal como foi fornecida.core.ModifyingSigner:ModifyAndSignTransactionpermite que o fornecedor reescreva a transação e, depois, assina-a.core.SendingSigner:SignAndSendTransactionfaz com que o fornecedor assine e difunda a transação.
Cada pacote de backend expõe uma struct Config e um construtor New:
import ("context""fmt""github.com/solana-foundation/solana-go/v2""github.com/solana-foundation/solana-keychain/go/core/v2""github.com/solana-foundation/solana-keychain/go/signers/memory/v2")func signWithKeychain(ctx context.Context, tx *solana.Transaction) error {signer, err := memory.New(memory.Config{PrivateKeyPath: "/path/to/id.json"})if err != nil {return err}if !signer.IsAvailable(ctx) {return core.NewSignerError(core.CodeNotAvailable, "signer offline")}result, err := signer.SignTransaction(ctx, tx)if err != nil {return err}fmt.Println("signature:", result.Signature)fmt.Println("complete:", result.IsComplete())// result.EncodedTransaction is the base64 wire transactionreturn nil}
SignTransaction e ModifyAndSignTransaction devolvem um
core.SignedTransaction (EncodedTransaction, Signature, Completeness).
Os backends HTTP remotos aceitam HTTPClient e HTTPClientConfig opcionais
(tempos limite). O cliente predefinido impõe HTTPS; ao fornecer o seu próprio, essa imposição é contornada
e passa a ser responsável pela respetiva postura de segurança.
Capacidades dos signers
Um backend que não consegue assinar uma transação não tem qualquer método SignTransaction,
pelo que a capacidade é um facto em tempo de compilação para tipos concretos e uma asserção
de tipo para um core.SolanaSigner:
| Backend | Capacidade | SignMessage |
|---|---|---|
| memory, vault, privy, turnkey, awskms, gcpkms, fireblocks, dfns, para, openfort | TransactionSigner | Sim |
| cdp | TransactionSigner | Apenas payloads UTF-8 |
| utila | TransactionSigner | Falha com CodeSigningFailed |
fordefi black box (fordefi.BlackBoxSigner) | TransactionSigner | Sim |
fordefi native manual (fordefi.NativeManualSigner) | ModifyingSigner | Sim |
fordefi native auto (fordefi.NativeAutoSigner) | SendingSigner | Sim |
| crossmint | SendingSigner | Falha com CodeSigningFailed |
switch s := signer.(type) {case core.SendingSigner:sig, err := s.SignAndSendTransaction(ctx, tx)case core.ModifyingSigner:signed, err := s.ModifyAndSignTransaction(ctx, tx)case core.TransactionSigner:signed, err := s.SignTransaction(ctx, tx)}
Inicialização
Não existe um passo Init separado. Privy, Fireblocks, Dfns, Crossmint, Para,
Openfort e Utila resolvem o endereço da carteira dentro de New, razão pela qual os respetivos
construtores recebem um context.Context. Crie sempre os signers através de New: um
signer Crossmint, Para ou Utila com valor zero falha com CodeNotInitialized
em vez de assinar para o endereço zero.
Assinar e enviar com qualquer signer
core.SignAndSendTransaction coloca uma transação na blockchain, independentemente da
forma do signer. Um SendingSigner difunde através do seu fornecedor e ignora a função
de envio; todas as outras formas assinam e a sua função difunde o resultado em
base64, que, no caso de um ModifyingSigner, é a transação que o respetivo fornecedor reescreveu.
O Core não tem dependência de RPC:
import "github.com/solana-foundation/solana-go/v2/rpc"client := rpc.New("https://api.devnet.solana.com")sig, err := core.SignAndSendTransaction(ctx, signer, tx,func(ctx context.Context, encoded string) (solana.Signature, error) {return client.SendEncodedTransaction(ctx, encoded)})
Assinatura em lote
A assinatura em lote é disponibilizada como funções auxiliares livres, concorrentes, com um desfasamento opcional por pedido para APIs com limitação de taxa:
sigs, err := core.SignMessages(ctx, signer, [][]byte{msg1, msg2}, core.BatchOptions{MaxConcurrency: 4, // 0 = unboundedRequestDelay: 50 * time.Millisecond,})signed, err := core.SignTransactions(ctx, signer, txs, core.BatchOptions{})
core.SignTransactions recebe um core.TransactionSigner, pelo que os
signers com difusão gerida (Crossmint, Fordefi native auto) e o Fordefi native
manual não podem ser processados em lote através dele; chame-os uma transação de cada vez. Um
signer cujas chamadas criam trabalho do lado do fornecedor (Fireblocks com UseProgramCall)
reporta-o através de core.BatchServerSideEffects, e o lote passa então a ser executado
de forma sequencial.
Configuração do backend
Memory
Indique exatamente um de PrivateKey (bytes em bruto), PrivateKeyString (base58 ou um
array de bytes [1,2,...]) ou PrivateKeyPath (ficheiro de keypair da CLI da Solana):
import "github.com/solana-foundation/solana-keychain/go/signers/memory/v2"signer, err := memory.New(memory.Config{PrivateKeyPath: "/path/to/id.json",})
O Go não oferece nenhuma forma fiável de zerar a memória: o coletor de lixo pode copiar e reter os bytes da chave (keypairs em memória e as chaves que Crossmint e Openfort derivam localmente) até à recolha. Trate toda a memória do processo como sensível ao utilizar backends de chaves locais.
HashiCorp Vault
import "github.com/solana-foundation/solana-keychain/go/signers/vault/v2"signer, err := vault.New(vault.Config{VaultAddr: "https://vault.example.com:8200",Token: "hvs.xxxxx",KeyName: "my-solana-key",Pubkey: "base58_public_key",})
AWS KMS
import "github.com/solana-foundation/solana-keychain/go/signers/awskms/v2"signer, err := awskms.New(ctx, awskms.Config{KeyID: "alias/my-solana-key",PublicKey: "base58_public_key",Region: "us-east-1", // optional})
GCP KMS
import "github.com/solana-foundation/solana-keychain/go/signers/gcpkms/v2"signer, err := gcpkms.New(ctx, gcpkms.Config{KeyName: "projects/my-project/locations/us-east1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1",PublicKey: "base58_public_key",})if err != nil {return err}defer signer.Close()
Privy
import "github.com/solana-foundation/solana-keychain/go/signers/privy/v2"signer, err := privy.New(ctx, privy.Config{AppID: "app_id",AppSecret: "app_secret",WalletID: "wallet_id",})
Turnkey
import "github.com/solana-foundation/solana-keychain/go/signers/turnkey/v2"signer, err := turnkey.New(turnkey.Config{APIPublicKey: "api_public_key",APIPrivateKey: "api_private_key",OrganizationID: "org_id",PrivateKeyID: "private_key_id",PublicKey: "base58_public_key",})
Fireblocks
import "github.com/solana-foundation/solana-keychain/go/signers/fireblocks/v2"signer, err := fireblocks.New(ctx, fireblocks.Config{APIKey: "api_key",PrivateKeyPEM: "-----BEGIN RSA PRIVATE KEY-----\n...",VaultAccountID: "0",AssetID: "SOL", // or "SOL_TEST" for devnetUseProgramCall: false, // true signs via sign-only PROGRAM_CALL (legacy/v0, hot wallet)})
CDP (Coinbase Developer Platform)
import "github.com/solana-foundation/solana-keychain/go/signers/cdp/v2"signer, err := cdp.New(cdp.Config{APIKeyID: "api_key_id",APIKeySecret: "api_key_secret", // base64 Ed25519WalletSecret: "wallet_secret", // base64 PKCS#8 DERAddress: "base58_address",Network: cdp.NetworkMainnet, // or cdp.NetworkDevnet; required for address lookup tables})
O SignMessage do CDP aceita apenas payloads UTF-8.
Crossmint
O Crossmint só envia: a sua API executa todas as transações aprovadas
do lado do servidor, pelo que *crossmint.Signer tem SignAndSendTransaction e não tem
SignTransaction. A sua transação nunca é modificada; a assinatura devolvida
identifica a transação que o Crossmint registou, a qual pode diferir da sua se o
Crossmint patrocinar o gas.
import "github.com/solana-foundation/solana-keychain/go/signers/crossmint/v2"signer, err := crossmint.New(ctx, crossmint.Config{APIKey: "api_key",WalletLocator: "wallet_locator",SignerSecret: "", // optional xmsk1_ secret: auto-approves what Crossmint presents})sig, err := signer.SignAndSendTransaction(ctx, tx)
Dfns
import "github.com/solana-foundation/solana-keychain/go/signers/dfns/v2"signer, err := dfns.New(ctx, dfns.Config{AuthToken: "auth_token",CredID: "cred_id",PrivateKeyPEM: "-----BEGIN EC PRIVATE KEY-----\n...",WalletID: "wallet_id",})
Openfort
import "github.com/solana-foundation/solana-keychain/go/signers/openfort/v2"signer, err := openfort.New(ctx, openfort.Config{SecretKey: "sk_live_...",AccountID: "acc_...",WalletSecret: "wallet_secret", // base64 PKCS#8 DER or PEM})
Para
import "github.com/solana-foundation/solana-keychain/go/signers/para/v2"signer, err := para.New(ctx, para.Config{APIKey: "sk_...",WalletID: "wallet_id",})
Utila
O Utila apenas assina transações; SignMessage falha, e é você quem difunde a
transação assinada.
import "github.com/solana-foundation/solana-keychain/go/signers/utila/v2"signer, err := utila.New(ctx, utila.Config{ServiceAccountEmail: "sa@example.com",ServiceAccountPrivateKeyPEM: "-----BEGIN PRIVATE KEY-----\n...",VaultID: "vault_id",WalletID: "wallet_id",Network: "networks/solana-devnet",})
Fordefi
O Fordefi existe em três tipos de signer, definidos na construção por Config.Chain e
Config.PushMode. Os três assinam mensagens:
| Config | Tipo | Ponto de entrada |
|---|---|---|
Chain não definido | *fordefi.BlackBoxSigner | SignTransaction |
Chain definido, PushMode não definido ou PushModeAuto | *fordefi.NativeAutoSigner | SignAndSendTransaction |
Chain definido, PushMode: PushModeManual | *fordefi.NativeManualSigner | ModifyAndSignTransaction |
fordefi.New faz o encaminhamento com base na configuração e devolve um core.SolanaSigner;
fordefi.NewBlackBox, fordefi.NewNativeAuto e fordefi.NewNativeManual
devolvem o tipo concreto e rejeitam as configurações dos outros modos. Os pedidos à API são
autenticados com uma assinatura de pedido ECDSA P-256: indique exatamente um de
PrivateKeyPEM ou um RequestSigner para manter essa chave num KMS/HSM.
Modo native auto: o Fordefi pode substituir o blockhash e as taxas, e depois assina e difunde. Aceita apenas uma transação não assinada cujo único signatário exigido seja o vault.
import "github.com/solana-foundation/solana-keychain/go/signers/fordefi/v2"signer, err := fordefi.NewNativeAuto(ctx, fordefi.Config{AccessToken: os.Getenv("FORDEFI_ACCESS_TOKEN"),VaultID: os.Getenv("FORDEFI_VAULT_ID"),PublicKey: os.Getenv("FORDEFI_PUBLIC_KEY"), // Solana vault address (base58)PrivateKeyPEM: string(pemBytes),Chain: fordefi.ChainSolanaDevnet, // or fordefi.ChainSolanaMainnetFee: &fordefi.Fee{Type: fordefi.FeeTypePriority,PriorityLevel: fordefi.PriorityMedium,},})sig, err := signer.SignAndSendTransaction(ctx, tx)
Modo native manual: defina PushMode: fordefi.PushModeManual. O Fordefi reescreve
a mensagem (blockhash recente, instruções de taxa do Compute Budget) e assina-a
sem a difundir. ModifyAndSignTransaction substitui tx pela
transação que o Fordefi assinou: continue sempre a partir dela. O Fordefi tem de ser o pagador
de taxas e tem de assinar antes de qualquer outro signatário exigido, uma vez que a reescrita invalida
as assinaturas existentes. A reescrita não é comparada com o original, por isso inspecione o resultado antes de
difundir.
signer, err := fordefi.NewNativeManual(ctx, fordefi.Config{AccessToken: os.Getenv("FORDEFI_ACCESS_TOKEN"),VaultID: os.Getenv("FORDEFI_VAULT_ID"),PublicKey: os.Getenv("FORDEFI_PUBLIC_KEY"),PrivateKeyPEM: string(pemBytes),Chain: fordefi.ChainSolanaDevnet,PushMode: fordefi.PushModeManual,})signed, err := signer.ModifyAndSignTransaction(ctx, tx)
Modo black box: deixe Chain não definido. O Fordefi assina exatamente os bytes da sua mensagem
e não difunde. Utilize este modo com um vault black box do Fordefi.
signer, err := fordefi.NewBlackBox(ctx, fordefi.Config{AccessToken: os.Getenv("FORDEFI_ACCESS_TOKEN"),VaultID: os.Getenv("FORDEFI_BB_VAULT_ID"),PublicKey: os.Getenv("FORDEFI_BB_PUBLIC_KEY"),PrivateKeyPEM: string(pemBytes),})
Porque não existe um pacote agregador
O Rust tem um enum Signer e o TypeScript tem createKeychainSigner; o Go
deliberadamente não tem nenhum dos dois. O Go não elimina código morto através de um switch
de despacho em tempo de execução, pelo que um pacote agregador forçaria o SDK de fornecedor de todos os backends (AWS, GCP
e os restantes) para a compilação de todos os consumidores. Importar o pacote de backend de que
precisa é o seletor. Para escolher um backend em tempo de execução, escreva o switch no seu próprio
código apenas sobre os backends que suporta e guarde o resultado como um
core.SolanaSigner.
Tratamento de erros
Todos os erros são um *core.SignerError com um Code estável (CodeConfigError,
CodeHTTPError, CodeRemoteAPIError, CodeSigningFailed,
CodeNotInitialized, CodeBroadcastUnconfirmed e outros). Error() devolve
apenas uma mensagem fixa por código, nunca material de chave nem respostas em bruto do fornecedor.
Faça a correspondência com errors.As, errors.Is(err, &core.SignerError{Code: ...}) ou
core.CodeOf(err).
No Crossmint e no modo native auto do Fordefi, uma falha não significa que nada
foi registado. Quando o fornecedor pode ter aceitado a transação, o código é
core.CodeBroadcastUnconfirmed ("SIGNER_BROADCAST_UNCONFIRMED").
ProviderTxID é definido quando a criação foi aceite, e IdempotencyKey contém
a chave derivada da mensagem. Reenviar a transação idêntica byte a byte é
seguro; uma transação reconstruída (por exemplo, com um novo blockhash) é uma nova transferência.
core.SignAndSendTransaction também reporta este código quando a sua função de envio
falha, com a assinatura do pagador de taxas em TransactionSignature. O PROGRAM_CALL
do Fireblocks apenas assina e não envia nenhuma chave; só reporta este código quando um
poll mostra que o Fireblocks difundiu na mesma.
sig, err := core.SignAndSendTransaction(ctx, signer, tx, send)var se *core.SignerErrorif errors.As(err, &se) && se.Code == core.CodeBroadcastUnconfirmed {// Reconcile se.ProviderTxID, se.IdempotencyKey or se.TransactionSignature// with the provider before retrying.}
Consulte o modelo de segurança para saber o que cada forma de assinatura garante, o README do Go para a lista completa de módulos, e o pkg.go.dev para a referência da API.
Adicionar signers personalizados
Implemente core.SolanaSigner mais exatamente uma interface de capacidade, e não adicione nenhum
método que o seu backend não consiga cumprir: os chamadores detetam a capacidade por asserção de tipo.
Consulte o guia Adding Signers para integrar
serviços de gestão de chaves adicionais.
Is this page helpful?